1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #define DISPEXTERN_INLINE EXTERN_INLINE
29 /* cm.h must come after dispextern.h on Windows. */
30 #include "dispextern.h"
32 #include "character.h"
36 #include "termhooks.h"
41 #include "intervals.h"
42 #include "blockinput.h"
45 #include "syssignal.h"
47 #ifdef HAVE_WINDOW_SYSTEM
49 #endif /* HAVE_WINDOW_SYSTEM */
55 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
62 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
63 #include <term.h> /* for tgetent */
70 /* Structure to pass dimensions around. Used for character bounding
71 boxes, glyph matrix dimensions and alike. */
80 /* Function prototypes. */
82 static void update_frame_line (struct frame
*, int);
83 static int required_matrix_height (struct window
*);
84 static int required_matrix_width (struct window
*);
85 static void adjust_frame_glyphs (struct frame
*);
86 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool);
87 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
88 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
89 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
91 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
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
*);
113 /* True upon entry to redisplay means do not assume anything about
114 current contents of actual terminal frame; clear and redraw it. */
118 /* True means last display completed. False means it was preempted. */
120 bool display_completed
;
122 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
125 /* The currently selected frame. In a single-frame version, this
126 variable always equals the_only_frame. */
128 Lisp_Object selected_frame
;
130 /* A frame which is not just a mini-buffer, or 0 if there are no such
131 frames. This is usually the most recent such frame that was
132 selected. In a single-frame version, this variable always holds
133 the address of the_only_frame. */
135 struct frame
*last_nonminibuf_frame
;
137 /* True means SIGWINCH happened when not safe. */
139 static bool delayed_size_change
;
141 /* Updated window if != 0. Set by update_window. */
143 struct window
*updated_window
;
145 /* Glyph row updated in update_window_line, and area that is updated. */
147 struct glyph_row
*updated_row
;
150 /* A glyph for a space. */
152 struct glyph space_glyph
;
154 /* Counts of allocated structures. These counts serve to diagnose
155 memory leaks and double frees. */
157 static int glyph_matrix_count
;
158 static int glyph_pool_count
;
160 /* If non-null, the frame whose frame matrices are manipulated. If
161 null, window matrices are worked on. */
163 static struct frame
*frame_matrix_frame
;
165 /* True means that fonts have been loaded since the last glyph
166 matrix adjustments. Redisplay must stop, and glyph matrices must
167 be adjusted when this flag becomes true during display. The
168 reason fonts can be loaded so late is that fonts of fontsets are
169 loaded on demand. Another reason is that a line contains many
170 characters displayed by zero width or very narrow glyphs of
171 variable-width fonts. */
173 bool fonts_changed_p
;
175 /* Convert vpos and hpos from frame to window and vice versa.
176 This may only be used for terminal frames. */
180 static int window_to_frame_vpos (struct window
*, int);
181 static int window_to_frame_hpos (struct window
*, int);
182 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
183 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
185 /* One element of the ring buffer containing redisplay history
188 struct redisplay_history
190 char trace
[512 + 100];
193 /* The size of the history buffer. */
195 #define REDISPLAY_HISTORY_SIZE 30
197 /* The redisplay history buffer. */
199 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
201 /* Next free entry in redisplay_history. */
203 static int history_idx
;
205 /* A tick that's incremented each time something is added to the
208 static uprintmax_t history_tick
;
210 /* Add to the redisplay history how window W has been displayed.
211 MSG is a trace containing the information how W's glyph matrix
212 has been constructed. PAUSED_P means that the update
213 has been interrupted for pending input. */
216 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
221 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
223 buf
= redisplay_history
[history_idx
].trace
;
226 snprintf (buf
, sizeof redisplay_history
[0].trace
,
227 "%"pMu
": window %p (`%s')%s\n%s",
230 ((BUFFERP (w
->contents
)
231 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
232 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
234 paused_p
? " ***paused***" : "",
239 /* Add to the redisplay history that frame F has been displayed.
240 PAUSED_P means that the update has been interrupted for
243 static void add_frame_display_history (struct frame
*f
, int paused_p
)
248 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
250 buf
= redisplay_history
[history_idx
].trace
;
253 sprintf (buf
, "%"pMu
": update frame %p%s",
255 ptr
, paused_p
? " ***paused***" : "");
259 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
260 Sdump_redisplay_history
, 0, 0, "",
261 doc
: /* Dump redisplay history to stderr. */)
266 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
269 i
= REDISPLAY_HISTORY_SIZE
- 1;
270 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
277 #else /* not GLYPH_DEBUG */
279 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
280 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
282 #endif /* GLYPH_DEBUG */
285 #if (defined PROFILING \
286 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
287 && !HAVE___EXECUTABLE_START)
288 /* This function comes first in the Emacs executable and is used only
289 to estimate the text start for profiling. */
291 __executable_start (void)
297 /***********************************************************************
299 ***********************************************************************/
301 /* Allocate and return a glyph_matrix structure. POOL is the glyph
302 pool from which memory for the matrix should be allocated, or null
303 for window-based redisplay where no glyph pools are used. The
304 member `pool' of the glyph matrix structure returned is set to
305 POOL, the structure is otherwise zeroed. */
307 static struct glyph_matrix
*
308 new_glyph_matrix (struct glyph_pool
*pool
)
310 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
312 /* Increment number of allocated matrices. This count is used
313 to detect memory leaks. */
314 ++glyph_matrix_count
;
316 /* Set pool and return. */
322 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
324 The global counter glyph_matrix_count is decremented when a matrix
325 is freed. If the count gets negative, more structures were freed
326 than allocated, i.e. one matrix was freed more than once or a bogus
327 pointer was passed to this function.
329 If MATRIX->pool is null, this means that the matrix manages its own
330 glyph memory---this is done for matrices on X frames. Freeing the
331 matrix also frees the glyph memory in this case. */
334 free_glyph_matrix (struct glyph_matrix
*matrix
)
340 /* Detect the case that more matrices are freed than were
342 if (--glyph_matrix_count
< 0)
345 /* Free glyph memory if MATRIX owns it. */
346 if (matrix
->pool
== NULL
)
347 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
348 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
350 /* Free row structures and the matrix itself. */
351 xfree (matrix
->rows
);
357 /* Return the number of glyphs to reserve for a marginal area of
358 window W. TOTAL_GLYPHS is the number of glyphs in a complete
359 display line of window W. MARGIN gives the width of the marginal
360 area in canonical character units. MARGIN should be an integer
364 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
368 if (NUMBERP (margin
))
370 int width
= w
->total_cols
;
371 double d
= max (0, XFLOATINT (margin
));
372 d
= min (width
/ 2 - 1, d
);
373 n
= (int) ((double) total_glyphs
/ width
* d
);
381 /* Return true if ROW's hash value is correct.
382 Optimized away if ENABLE_CHECKING is not defined. */
385 verify_row_hash (struct glyph_row
*row
)
387 return row
->hash
== row_hash (row
);
390 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
393 W is null if the function is called for a frame glyph matrix.
394 Otherwise it is the window MATRIX is a member of. X and Y are the
395 indices of the first column and row of MATRIX within the frame
396 matrix, if such a matrix exists. They are zero for purely
397 window-based redisplay. DIM is the needed size of the matrix.
399 In window-based redisplay, where no frame matrices exist, glyph
400 matrices manage their own glyph storage. Otherwise, they allocate
401 storage from a common frame glyph pool which can be found in
404 The reason for this memory management strategy is to avoid complete
405 frame redraws if possible. When we allocate from a common pool, a
406 change of the location or size of a sub-matrix within the pool
407 requires a complete redisplay of the frame because we cannot easily
408 make sure that the current matrices of all windows still agree with
409 what is displayed on the screen. While this is usually fast, it
410 leads to screen flickering. */
413 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
417 bool marginal_areas_changed_p
= 0;
418 bool header_line_changed_p
= 0;
419 bool header_line_p
= 0;
420 int left
= -1, right
= -1;
421 int window_width
= -1, window_height
= -1;
423 /* See if W had a header line that has disappeared now, or vice versa.
427 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
429 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
430 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
432 matrix
->header_line_p
= header_line_p
;
434 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
435 Do nothing if MATRIX' size, position, vscroll, and marginal areas
436 haven't changed. This optimization is important because preserving
437 the matrix means preventing redisplay. */
438 if (matrix
->pool
== NULL
)
440 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
441 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
442 eassert (left
>= 0 && right
>= 0);
443 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
444 || right
!= matrix
->right_margin_glyphs
);
446 if (!marginal_areas_changed_p
448 && !header_line_changed_p
449 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
450 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
451 && matrix
->window_height
== window_height
452 && matrix
->window_vscroll
== w
->vscroll
453 && matrix
->window_width
== window_width
)
457 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
458 if (matrix
->rows_allocated
< dim
.height
)
460 int old_alloc
= matrix
->rows_allocated
;
461 new_rows
= dim
.height
- matrix
->rows_allocated
;
462 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
463 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
464 memset (matrix
->rows
+ old_alloc
, 0,
465 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
470 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
471 on a frame not using window-based redisplay. Set up pointers for
472 each row into the glyph pool. */
475 eassert (matrix
->pool
->glyphs
);
479 left
= margin_glyphs_to_reserve (w
, dim
.width
,
480 w
->left_margin_cols
);
481 right
= margin_glyphs_to_reserve (w
, dim
.width
,
482 w
->right_margin_cols
);
487 for (i
= 0; i
< dim
.height
; ++i
)
489 struct glyph_row
*row
= &matrix
->rows
[i
];
491 row
->glyphs
[LEFT_MARGIN_AREA
]
492 = (matrix
->pool
->glyphs
493 + (y
+ i
) * matrix
->pool
->ncolumns
497 || row
== matrix
->rows
+ dim
.height
- 1
498 || (row
== matrix
->rows
&& matrix
->header_line_p
))
500 row
->glyphs
[TEXT_AREA
]
501 = row
->glyphs
[LEFT_MARGIN_AREA
];
502 row
->glyphs
[RIGHT_MARGIN_AREA
]
503 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
504 row
->glyphs
[LAST_AREA
]
505 = row
->glyphs
[RIGHT_MARGIN_AREA
];
509 row
->glyphs
[TEXT_AREA
]
510 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
511 row
->glyphs
[RIGHT_MARGIN_AREA
]
512 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
513 row
->glyphs
[LAST_AREA
]
514 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
518 matrix
->left_margin_glyphs
= left
;
519 matrix
->right_margin_glyphs
= right
;
523 /* If MATRIX->pool is null, MATRIX is responsible for managing
524 its own memory. It is a window matrix for window-based redisplay.
525 Allocate glyph memory from the heap. */
526 if (dim
.width
> matrix
->matrix_w
528 || header_line_changed_p
529 || marginal_areas_changed_p
)
531 struct glyph_row
*row
= matrix
->rows
;
532 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
536 row
->glyphs
[LEFT_MARGIN_AREA
]
537 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
538 dim
.width
, sizeof (struct glyph
));
540 /* The mode line never has marginal areas. */
541 if (row
== matrix
->rows
+ dim
.height
- 1
542 || (row
== matrix
->rows
&& matrix
->header_line_p
))
544 row
->glyphs
[TEXT_AREA
]
545 = row
->glyphs
[LEFT_MARGIN_AREA
];
546 row
->glyphs
[RIGHT_MARGIN_AREA
]
547 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
548 row
->glyphs
[LAST_AREA
]
549 = row
->glyphs
[RIGHT_MARGIN_AREA
];
553 row
->glyphs
[TEXT_AREA
]
554 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
555 row
->glyphs
[RIGHT_MARGIN_AREA
]
556 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
557 row
->glyphs
[LAST_AREA
]
558 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
564 eassert (left
>= 0 && right
>= 0);
565 matrix
->left_margin_glyphs
= left
;
566 matrix
->right_margin_glyphs
= right
;
569 /* Number of rows to be used by MATRIX. */
570 matrix
->nrows
= dim
.height
;
571 eassert (matrix
->nrows
>= 0);
575 if (matrix
== w
->current_matrix
)
577 /* Mark rows in a current matrix of a window as not having
578 valid contents. It's important to not do this for
579 desired matrices. When Emacs starts, it may already be
580 building desired matrices when this function runs. */
581 if (window_width
< 0)
582 window_width
= window_box_width (w
, -1);
584 /* Optimize the case that only the height has changed (C-x 2,
585 upper window). Invalidate all rows that are no longer part
587 if (!marginal_areas_changed_p
588 && !header_line_changed_p
590 && dim
.width
== matrix
->matrix_w
591 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
592 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
593 && matrix
->window_width
== window_width
)
595 /* Find the last row in the window. */
596 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
597 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
603 /* Window end is invalid, if inside of the rows that
604 are invalidated below. */
605 if (INTEGERP (w
->window_end_vpos
)
606 && XFASTINT (w
->window_end_vpos
) >= i
)
607 w
->window_end_valid
= 0;
609 while (i
< matrix
->nrows
)
610 matrix
->rows
[i
++].enabled_p
= 0;
614 for (i
= 0; i
< matrix
->nrows
; ++i
)
615 matrix
->rows
[i
].enabled_p
= 0;
618 else if (matrix
== w
->desired_matrix
)
620 /* Rows in desired matrices always have to be cleared;
621 redisplay expects this is the case when it runs, so it
622 had better be the case when we adjust matrices between
624 for (i
= 0; i
< matrix
->nrows
; ++i
)
625 matrix
->rows
[i
].enabled_p
= 0;
630 /* Remember last values to be able to optimize frame redraws. */
631 matrix
->matrix_x
= x
;
632 matrix
->matrix_y
= y
;
633 matrix
->matrix_w
= dim
.width
;
634 matrix
->matrix_h
= dim
.height
;
636 /* Record the top y location and height of W at the time the matrix
637 was last adjusted. This is used to optimize redisplay above. */
640 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
641 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
642 matrix
->window_height
= window_height
;
643 matrix
->window_width
= window_width
;
644 matrix
->window_vscroll
= w
->vscroll
;
649 /* Reverse the contents of rows in MATRIX between START and END. The
650 contents of the row at END - 1 end up at START, END - 2 at START +
651 1 etc. This is part of the implementation of rotate_matrix (see
655 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
659 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
661 /* Non-ISO HP/UX compiler doesn't like auto struct
663 struct glyph_row temp
;
664 temp
= matrix
->rows
[i
];
665 matrix
->rows
[i
] = matrix
->rows
[j
];
666 matrix
->rows
[j
] = temp
;
671 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
672 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
673 indices. (Note: this does not copy glyphs, only glyph pointers in
674 row structures are moved around).
676 The algorithm used for rotating the vector was, I believe, first
677 described by Kernighan. See the vector R as consisting of two
678 sub-vectors AB, where A has length BY for BY >= 0. The result
679 after rotating is then BA. Reverse both sub-vectors to get ArBr
680 and reverse the result to get (ArBr)r which is BA. Similar for
684 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
688 /* Up (rotate left, i.e. towards lower indices). */
690 reverse_rows (matrix
, first
, first
+ by
);
691 reverse_rows (matrix
, first
+ by
, last
);
692 reverse_rows (matrix
, first
, last
);
696 /* Down (rotate right, i.e. towards higher indices). */
697 reverse_rows (matrix
, last
- by
, last
);
698 reverse_rows (matrix
, first
, last
- by
);
699 reverse_rows (matrix
, first
, last
);
704 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
705 with indices START <= index < END. Increment positions by DELTA/
709 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
710 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
712 /* Check that START and END are reasonable values. */
713 eassert (start
>= 0 && start
<= matrix
->nrows
);
714 eassert (end
>= 0 && end
<= matrix
->nrows
);
715 eassert (start
<= end
);
717 for (; start
< end
; ++start
)
718 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
722 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
723 START and END are the row indices of the first and last + 1 row to clear. */
726 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
728 eassert (start
<= end
);
729 eassert (start
>= 0 && start
< matrix
->nrows
);
730 eassert (end
>= 0 && end
<= matrix
->nrows
);
732 for (; start
< end
; ++start
)
733 matrix
->rows
[start
].enabled_p
= 0;
739 Empty all rows in MATRIX by clearing their enabled_p flags.
740 The function prepare_desired_row will eventually really clear a row
741 when it sees one with a false enabled_p flag.
743 Reset update hints to default values. The only update hint
744 currently present is the flag MATRIX->no_scrolling_p. */
747 clear_glyph_matrix (struct glyph_matrix
*matrix
)
751 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
752 matrix
->no_scrolling_p
= 0;
757 /* Shift part of the glyph matrix MATRIX of window W up or down.
758 Increment y-positions in glyph rows between START and END by DY,
759 and recompute their visible height. */
762 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
766 eassert (start
<= end
);
767 eassert (start
>= 0 && start
< matrix
->nrows
);
768 eassert (end
>= 0 && end
<= matrix
->nrows
);
770 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
771 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
773 for (; start
< end
; ++start
)
775 struct glyph_row
*row
= &matrix
->rows
[start
];
778 row
->visible_height
= row
->height
;
781 row
->visible_height
-= min_y
- row
->y
;
782 if (row
->y
+ row
->height
> max_y
)
783 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
784 if (row
->fringe_bitmap_periodic_p
)
785 row
->redraw_fringe_bitmaps_p
= 1;
790 /* Mark all rows in current matrices of frame F as invalid. Marking
791 invalid is done by setting enabled_p to zero for all rows in a
795 clear_current_matrices (register struct frame
*f
)
797 /* Clear frame current matrix, if we have one. */
798 if (f
->current_matrix
)
799 clear_glyph_matrix (f
->current_matrix
);
801 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
802 /* Clear the matrix of the menu bar window, if such a window exists.
803 The menu bar window is currently used to display menus on X when
804 no toolkit support is compiled in. */
805 if (WINDOWP (f
->menu_bar_window
))
806 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
809 /* Clear the matrix of the tool-bar window, if any. */
810 if (WINDOWP (f
->tool_bar_window
))
811 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
813 /* Clear current window matrices. */
814 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
815 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
819 /* Clear out all display lines of F for a coming redisplay. */
822 clear_desired_matrices (register struct frame
*f
)
824 if (f
->desired_matrix
)
825 clear_glyph_matrix (f
->desired_matrix
);
827 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
828 if (WINDOWP (f
->menu_bar_window
))
829 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 (WINDOWP (w
->contents
))
850 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
854 clear_glyph_matrix (w
->desired_matrix
);
857 clear_glyph_matrix (w
->current_matrix
);
858 w
->window_end_valid
= 0;
862 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
868 /***********************************************************************
871 See dispextern.h for an overall explanation of glyph rows.
872 ***********************************************************************/
874 /* Clear glyph row ROW. Do it in a way that makes it robust against
875 changes in the glyph_row structure, i.e. addition or removal of
876 structure members. */
878 static struct glyph_row null_row
;
881 clear_glyph_row (struct glyph_row
*row
)
883 struct glyph
*p
[1 + LAST_AREA
];
886 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
887 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
888 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
889 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
894 /* Restore pointers. */
895 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
896 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
897 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
898 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
900 #if 0 /* At some point, some bit-fields of struct glyph were not set,
901 which made glyphs unequal when compared with GLYPH_EQUAL_P.
902 Redisplay outputs such glyphs, and flickering effects were
903 the result. This also depended on the contents of memory
904 returned by xmalloc. If flickering happens again, activate
905 the code below. If the flickering is gone with that, chances
906 are that the flickering has the same reason as here. */
907 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
912 /* Make ROW an empty, enabled row of canonical character height,
913 in window W starting at y-position Y. */
916 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
920 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
921 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
923 clear_glyph_row (row
);
925 row
->ascent
= row
->phys_ascent
= 0;
926 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
927 row
->visible_height
= row
->height
;
930 row
->visible_height
-= min_y
- row
->y
;
931 if (row
->y
+ row
->height
> max_y
)
932 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
938 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
939 are the amounts by which to change positions. Note that the first
940 glyph of the text area of a row can have a buffer position even if
941 the used count of the text area is zero. Such rows display line
945 increment_row_positions (struct glyph_row
*row
,
946 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
950 /* Increment start and end positions. */
951 MATRIX_ROW_START_CHARPOS (row
) += delta
;
952 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
953 MATRIX_ROW_END_CHARPOS (row
) += delta
;
954 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
955 CHARPOS (row
->start
.pos
) += delta
;
956 BYTEPOS (row
->start
.pos
) += delta_bytes
;
957 CHARPOS (row
->end
.pos
) += delta
;
958 BYTEPOS (row
->end
.pos
) += delta_bytes
;
963 /* Increment positions in glyphs. */
964 for (area
= 0; area
< LAST_AREA
; ++area
)
965 for (i
= 0; i
< row
->used
[area
]; ++i
)
966 if (BUFFERP (row
->glyphs
[area
][i
].object
)
967 && row
->glyphs
[area
][i
].charpos
> 0)
968 row
->glyphs
[area
][i
].charpos
+= delta
;
970 /* Capture the case of rows displaying a line end. */
971 if (row
->used
[TEXT_AREA
] == 0
972 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
973 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
978 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
979 contents, i.e. glyph structure contents are exchanged between A and
980 B without changing glyph pointers in A and B. */
983 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
987 for (area
= 0; area
< LAST_AREA
; ++area
)
989 /* Number of glyphs to swap. */
990 int max_used
= max (a
->used
[area
], b
->used
[area
]);
992 /* Start of glyphs in area of row A. */
993 struct glyph
*glyph_a
= a
->glyphs
[area
];
995 /* End + 1 of glyphs in area of row A. */
996 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
998 /* Start of glyphs in area of row B. */
999 struct glyph
*glyph_b
= b
->glyphs
[area
];
1001 while (glyph_a
< glyph_a_end
)
1003 /* Non-ISO HP/UX compiler doesn't like auto struct
1007 *glyph_a
= *glyph_b
;
1017 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1018 exchange the used[] array and the hash values of the rows, because
1019 these should all go together for the row's hash value to be
1023 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1026 unsigned hash_tem
= a
->hash
;
1028 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1030 struct glyph
*temp
= a
->glyphs
[i
];
1032 a
->glyphs
[i
] = b
->glyphs
[i
];
1033 b
->glyphs
[i
] = temp
;
1036 short used_tem
= a
->used
[i
];
1038 a
->used
[i
] = b
->used
[i
];
1039 b
->used
[i
] = used_tem
;
1047 /* Copy glyph row structure FROM to glyph row structure TO, except
1048 that glyph pointers, the `used' counts, and the hash values in the
1049 structures are left unchanged. */
1052 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1054 struct glyph
*pointers
[1 + LAST_AREA
];
1055 short used
[LAST_AREA
];
1058 /* Save glyph pointers of TO. */
1059 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1060 memcpy (used
, to
->used
, sizeof to
->used
);
1063 /* Do a structure assignment. */
1066 /* Restore original pointers of TO. */
1067 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1068 memcpy (to
->used
, used
, sizeof to
->used
);
1073 /* Assign glyph row FROM to glyph row TO. This works like a structure
1074 assignment TO = FROM, except that glyph pointers are not copied but
1075 exchanged between TO and FROM. Pointers must be exchanged to avoid
1079 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1081 swap_glyph_pointers (to
, from
);
1082 copy_row_except_pointers (to
, from
);
1086 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1087 a row in a window matrix, is a slice of the glyph memory of the
1088 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1089 is true if the glyph memory of WINDOW_ROW is part of the glyph
1090 memory of FRAME_ROW. */
1095 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1097 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1098 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1099 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1101 return (frame_glyph_start
<= window_glyph_start
1102 && window_glyph_start
< frame_glyph_end
);
1105 #endif /* GLYPH_DEBUG */
1109 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1110 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1111 in WINDOW_MATRIX is found satisfying the condition. */
1113 static struct glyph_row
*
1114 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1115 struct glyph_matrix
*frame_matrix
, int row
)
1119 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1121 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1122 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1123 frame_matrix
->rows
+ row
))
1126 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1131 /* Prepare ROW for display. Desired rows are cleared lazily,
1132 i.e. they are only marked as to be cleared by setting their
1133 enabled_p flag to zero. When a row is to be displayed, a prior
1134 call to this function really clears it. */
1137 prepare_desired_row (struct glyph_row
*row
)
1139 if (!row
->enabled_p
)
1141 bool rp
= row
->reversed_p
;
1143 clear_glyph_row (row
);
1145 row
->reversed_p
= rp
;
1150 /* Return a hash code for glyph row ROW. */
1153 line_hash_code (struct glyph_row
*row
)
1159 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1160 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1164 int c
= glyph
->u
.ch
;
1165 int face_id
= glyph
->face_id
;
1166 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1168 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1169 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1181 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1182 the number of characters in the line. If must_write_spaces is
1183 zero, leading and trailing spaces are ignored. */
1186 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1188 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1189 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1190 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1192 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1193 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1195 /* Ignore trailing and leading spaces if we can. */
1196 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1198 /* Skip from the end over trailing spaces. */
1199 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1202 /* All blank line. */
1206 /* Skip over leading spaces. */
1207 while (CHAR_GLYPH_SPACE_P (*beg
))
1211 /* If we don't have a glyph-table, each glyph is one character,
1212 so return the number of glyphs. */
1213 if (glyph_table_base
== 0)
1217 /* Otherwise, scan the glyphs and accumulate their total length
1224 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1226 if (GLYPH_INVALID_P (g
)
1227 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1230 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1240 /* Return true if the glyph rows A and B have equal contents.
1241 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1244 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1246 eassert (verify_row_hash (a
));
1247 eassert (verify_row_hash (b
));
1251 else if (a
->hash
!= b
->hash
)
1255 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1258 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1261 /* Compare glyphs. */
1262 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1264 if (a
->used
[area
] != b
->used
[area
])
1267 a_glyph
= a
->glyphs
[area
];
1268 a_end
= a_glyph
+ a
->used
[area
];
1269 b_glyph
= b
->glyphs
[area
];
1271 while (a_glyph
< a_end
1272 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1273 ++a_glyph
, ++b_glyph
;
1275 if (a_glyph
!= a_end
)
1279 if (a
->fill_line_p
!= b
->fill_line_p
1280 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1281 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1282 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1283 || a
->left_fringe_offset
!= b
->left_fringe_offset
1284 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1285 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1286 || a
->right_fringe_offset
!= b
->right_fringe_offset
1287 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1288 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1289 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1290 || a
->overlapped_p
!= b
->overlapped_p
1291 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1292 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1293 || a
->reversed_p
!= b
->reversed_p
1294 /* Different partially visible characters on left margin. */
1296 /* Different height. */
1297 || a
->ascent
!= b
->ascent
1298 || a
->phys_ascent
!= b
->phys_ascent
1299 || a
->phys_height
!= b
->phys_height
1300 || a
->visible_height
!= b
->visible_height
)
1309 /***********************************************************************
1312 See dispextern.h for an overall explanation of glyph pools.
1313 ***********************************************************************/
1315 /* Allocate a glyph_pool structure. The structure returned is
1316 initialized with zeros. The global variable glyph_pool_count is
1317 incremented for each pool allocated. */
1319 static struct glyph_pool
*
1320 new_glyph_pool (void)
1322 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1324 /* For memory leak and double deletion checking. */
1331 /* Free a glyph_pool structure POOL. The function may be called with
1332 a null POOL pointer. The global variable glyph_pool_count is
1333 decremented with every pool structure freed. If this count gets
1334 negative, more structures were freed than allocated, i.e. one
1335 structure must have been freed more than once or a bogus pointer
1336 was passed to free_glyph_pool. */
1339 free_glyph_pool (struct glyph_pool
*pool
)
1343 /* More freed than allocated? */
1345 eassert (glyph_pool_count
>= 0);
1347 xfree (pool
->glyphs
);
1353 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1354 columns we need. This function never shrinks a pool. The only
1355 case in which this would make sense, would be when a frame's size
1356 is changed from a large value to a smaller one. But, if someone
1357 does it once, we can expect that he will do it again.
1359 Return true if the pool changed in a way which makes
1360 re-adjusting window glyph matrices necessary. */
1363 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1368 changed_p
= (pool
->glyphs
== 0
1369 || matrix_dim
.height
!= pool
->nrows
1370 || matrix_dim
.width
!= pool
->ncolumns
);
1372 /* Enlarge the glyph pool. */
1373 needed
= matrix_dim
.width
;
1374 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1375 memory_full (SIZE_MAX
);
1376 needed
*= matrix_dim
.height
;
1377 if (needed
> pool
->nglyphs
)
1379 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1380 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1381 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1382 memset (pool
->glyphs
+ old_nglyphs
, 0,
1383 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1386 /* Remember the number of rows and columns because (a) we use them
1387 to do sanity checks, and (b) the number of columns determines
1388 where rows in the frame matrix start---this must be available to
1389 determine pointers to rows of window sub-matrices. */
1390 pool
->nrows
= matrix_dim
.height
;
1391 pool
->ncolumns
= matrix_dim
.width
;
1398 /***********************************************************************
1400 ***********************************************************************/
1405 /* Flush standard output. This is sometimes useful to call from the debugger.
1406 XXX Maybe this should be changed to flush the current terminal instead of
1410 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1419 /* Check that no glyph pointers have been lost in MATRIX. If a
1420 pointer has been lost, e.g. by using a structure assignment between
1421 rows, at least one pointer must occur more than once in the rows of
1425 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1429 for (i
= 0; i
< matrix
->nrows
; ++i
)
1430 for (j
= 0; j
< matrix
->nrows
; ++j
)
1432 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1433 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1437 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1440 matrix_row (struct glyph_matrix
*matrix
, int row
)
1442 eassert (matrix
&& matrix
->rows
);
1443 eassert (row
>= 0 && row
< matrix
->nrows
);
1445 /* That's really too slow for normal testing because this function
1446 is called almost everywhere. Although---it's still astonishingly
1447 fast, so it is valuable to have for debugging purposes. */
1449 check_matrix_pointer_lossage (matrix
);
1452 return matrix
->rows
+ row
;
1456 #if 0 /* This function makes invalid assumptions when text is
1457 partially invisible. But it might come handy for debugging
1460 /* Check invariants that must hold for an up to date current matrix of
1464 check_matrix_invariants (struct window
*w
)
1466 struct glyph_matrix
*matrix
= w
->current_matrix
;
1467 int yb
= window_text_bottom_y (w
);
1468 struct glyph_row
*row
= matrix
->rows
;
1469 struct glyph_row
*last_text_row
= NULL
;
1470 struct buffer
*saved
= current_buffer
;
1471 struct buffer
*buffer
= XBUFFER (w
->contents
);
1474 /* This can sometimes happen for a fresh window. */
1475 if (matrix
->nrows
< 2)
1478 set_buffer_temp (buffer
);
1480 /* Note: last row is always reserved for the mode line. */
1481 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1482 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1484 struct glyph_row
*next
= row
+ 1;
1486 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1487 last_text_row
= row
;
1489 /* Check that character and byte positions are in sync. */
1490 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1491 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1492 eassert (BYTEPOS (row
->start
.pos
)
1493 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1495 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1496 have such a position temporarily in case of a minibuffer
1497 displaying something like `[Sole completion]' at its end. */
1498 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1500 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1501 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1502 eassert (BYTEPOS (row
->end
.pos
)
1503 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1506 /* Check that end position of `row' is equal to start position
1508 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1510 eassert (MATRIX_ROW_END_CHARPOS (row
)
1511 == MATRIX_ROW_START_CHARPOS (next
));
1512 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1513 == MATRIX_ROW_START_BYTEPOS (next
));
1514 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1515 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1520 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1521 eassert (w
->desired_matrix
->rows
!= NULL
);
1522 set_buffer_temp (saved
);
1527 #endif /* GLYPH_DEBUG */
1531 /**********************************************************************
1532 Allocating/ Adjusting Glyph Matrices
1533 **********************************************************************/
1535 /* Allocate glyph matrices over a window tree for a frame-based
1538 X and Y are column/row within the frame glyph matrix where
1539 sub-matrices for the window tree rooted at WINDOW must be
1540 allocated. DIM_ONLY_P means that the caller of this
1541 function is only interested in the result matrix dimension, and
1542 matrix adjustments should not be performed.
1544 The function returns the total width/height of the sub-matrices of
1545 the window tree. If called on a frame root window, the computation
1546 will take the mini-buffer window into account.
1548 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1550 NEW_LEAF_MATRIX set if any window in the tree did not have a
1551 glyph matrices yet, and
1553 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1554 any window in the tree will be changed or have been changed (see
1557 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1560 Windows are arranged into chains of windows on the same level
1561 through the next fields of window structures. Such a level can be
1562 either a sequence of horizontally adjacent windows from left to
1563 right, or a sequence of vertically adjacent windows from top to
1564 bottom. Each window in a horizontal sequence can be either a leaf
1565 window or a vertical sequence; a window in a vertical sequence can
1566 be either a leaf or a horizontal sequence. All windows in a
1567 horizontal sequence have the same height, and all windows in a
1568 vertical sequence have the same width.
1570 This function uses, for historical reasons, a more general
1571 algorithm to determine glyph matrix dimensions that would be
1574 The matrix height of a horizontal sequence is determined by the
1575 maximum height of any matrix in the sequence. The matrix width of
1576 a horizontal sequence is computed by adding up matrix widths of
1577 windows in the sequence.
1579 |<------- result width ------->|
1580 +---------+----------+---------+ ---
1583 +---------+ | | result height
1588 The matrix width of a vertical sequence is the maximum matrix width
1589 of any window in the sequence. Its height is computed by adding up
1590 matrix heights of windows in the sequence.
1592 |<---- result width -->|
1600 +------------+---------+ |
1603 +------------+---------+ --- */
1605 /* Bit indicating that a new matrix will be allocated or has been
1608 #define NEW_LEAF_MATRIX (1 << 0)
1610 /* Bit indicating that a matrix will or has changed its location or
1613 #define CHANGED_LEAF_MATRIX (1 << 1)
1616 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1617 bool dim_only_p
, int *window_change_flags
)
1619 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1621 int wmax
= 0, hmax
= 0;
1625 bool in_horz_combination_p
;
1627 /* What combination is WINDOW part of? Compute this once since the
1628 result is the same for all windows in the `next' chain. The
1629 special case of a root window (parent equal to nil) is treated
1630 like a vertical combination because a root window's `next'
1631 points to the mini-buffer window, if any, which is arranged
1632 vertically below other windows. */
1633 in_horz_combination_p
1634 = (!NILP (XWINDOW (window
)->parent
)
1635 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1637 /* For WINDOW and all windows on the same level. */
1640 w
= XWINDOW (window
);
1642 /* Get the dimension of the window sub-matrix for W, depending
1643 on whether this is a combination or a leaf window. */
1644 if (WINDOWP (w
->contents
))
1645 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1647 window_change_flags
);
1650 /* If not already done, allocate sub-matrix structures. */
1651 if (w
->desired_matrix
== NULL
)
1653 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1654 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1655 *window_change_flags
|= NEW_LEAF_MATRIX
;
1658 /* Width and height MUST be chosen so that there are no
1659 holes in the frame matrix. */
1660 dim
.width
= required_matrix_width (w
);
1661 dim
.height
= required_matrix_height (w
);
1663 /* Will matrix be re-allocated? */
1664 if (x
!= w
->desired_matrix
->matrix_x
1665 || y
!= w
->desired_matrix
->matrix_y
1666 || dim
.width
!= w
->desired_matrix
->matrix_w
1667 || dim
.height
!= w
->desired_matrix
->matrix_h
1668 || (margin_glyphs_to_reserve (w
, dim
.width
,
1669 w
->left_margin_cols
)
1670 != w
->desired_matrix
->left_margin_glyphs
)
1671 || (margin_glyphs_to_reserve (w
, dim
.width
,
1672 w
->right_margin_cols
)
1673 != w
->desired_matrix
->right_margin_glyphs
))
1674 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1676 /* Actually change matrices, if allowed. Do not consider
1677 CHANGED_LEAF_MATRIX computed above here because the pool
1678 may have been changed which we don't now here. We trust
1679 that we only will be called with DIM_ONLY_P when
1683 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1684 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1688 /* If we are part of a horizontal combination, advance x for
1689 windows to the right of W; otherwise advance y for windows
1691 if (in_horz_combination_p
)
1696 /* Remember maximum glyph matrix dimensions. */
1697 wmax
= max (wmax
, dim
.width
);
1698 hmax
= max (hmax
, dim
.height
);
1700 /* Next window on same level. */
1703 while (!NILP (window
));
1705 /* Set `total' to the total glyph matrix dimension of this window
1706 level. In a vertical combination, the width is the width of the
1707 widest window; the height is the y we finally reached, corrected
1708 by the y we started with. In a horizontal combination, the total
1709 height is the height of the tallest window, and the width is the
1710 x we finally reached, corrected by the x we started with. */
1711 if (in_horz_combination_p
)
1713 total
.width
= x
- x0
;
1714 total
.height
= hmax
;
1719 total
.height
= y
- y0
;
1726 /* Return the required height of glyph matrices for window W. */
1729 required_matrix_height (struct window
*w
)
1731 #ifdef HAVE_WINDOW_SYSTEM
1732 struct frame
*f
= XFRAME (w
->frame
);
1734 if (FRAME_WINDOW_P (f
))
1736 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1737 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1738 return (((window_pixel_height
+ ch_height
- 1)
1739 / ch_height
) * w
->nrows_scale_factor
1740 /* One partially visible line at the top and
1741 bottom of the window. */
1743 /* 2 for header and mode line. */
1746 #endif /* HAVE_WINDOW_SYSTEM */
1748 return WINDOW_TOTAL_LINES (w
);
1752 /* Return the required width of glyph matrices for window W. */
1755 required_matrix_width (struct window
*w
)
1757 #ifdef HAVE_WINDOW_SYSTEM
1758 struct frame
*f
= XFRAME (w
->frame
);
1759 if (FRAME_WINDOW_P (f
))
1761 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1762 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1764 /* Compute number of glyphs needed in a glyph row. */
1765 return (((window_pixel_width
+ ch_width
- 1)
1766 / ch_width
) * w
->ncols_scale_factor
1767 /* 2 partially visible columns in the text area. */
1769 /* One partially visible column at the right
1770 edge of each marginal area. */
1773 #endif /* HAVE_WINDOW_SYSTEM */
1775 return w
->total_cols
;
1779 /* Allocate window matrices for window-based redisplay. W is the
1780 window whose matrices must be allocated/reallocated. */
1783 allocate_matrices_for_window_redisplay (struct window
*w
)
1787 if (WINDOWP (w
->contents
))
1788 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1791 /* W is a leaf window. */
1794 /* If matrices are not yet allocated, allocate them now. */
1795 if (w
->desired_matrix
== NULL
)
1797 w
->desired_matrix
= new_glyph_matrix (NULL
);
1798 w
->current_matrix
= new_glyph_matrix (NULL
);
1801 dim
.width
= required_matrix_width (w
);
1802 dim
.height
= required_matrix_height (w
);
1803 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1804 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1807 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1812 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1813 do it for all frames; otherwise do it just for the given frame.
1814 This function must be called when a new frame is created, its size
1815 changes, or its window configuration changes. */
1818 adjust_glyphs (struct frame
*f
)
1820 /* Block input so that expose events and other events that access
1821 glyph matrices are not processed while we are changing them. */
1825 adjust_frame_glyphs (f
);
1828 Lisp_Object tail
, lisp_frame
;
1830 FOR_EACH_FRAME (tail
, lisp_frame
)
1831 adjust_frame_glyphs (XFRAME (lisp_frame
));
1837 /* Allocate/reallocate glyph matrices of a single frame F. */
1840 adjust_frame_glyphs (struct frame
*f
)
1842 if (FRAME_WINDOW_P (f
))
1843 adjust_frame_glyphs_for_window_redisplay (f
);
1845 adjust_frame_glyphs_for_frame_redisplay (f
);
1847 /* Don't forget the buffer for decode_mode_spec. */
1848 adjust_decode_mode_spec_buffer (f
);
1850 f
->glyphs_initialized_p
= 1;
1853 /* Return true if any window in the tree has nonzero window margins. See
1854 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1856 showing_window_margins_p (struct window
*w
)
1860 if (WINDOWP (w
->contents
))
1862 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1865 else if (!NILP (w
->left_margin_cols
) || !NILP (w
->right_margin_cols
))
1868 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1874 /* In the window tree with root W, build current matrices of leaf
1875 windows from the frame's current matrix. */
1878 fake_current_matrices (Lisp_Object window
)
1882 for (; !NILP (window
); window
= w
->next
)
1884 w
= XWINDOW (window
);
1886 if (WINDOWP (w
->contents
))
1887 fake_current_matrices (w
->contents
);
1891 struct frame
*f
= XFRAME (w
->frame
);
1892 struct glyph_matrix
*m
= w
->current_matrix
;
1893 struct glyph_matrix
*fm
= f
->current_matrix
;
1895 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1896 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1898 for (i
= 0; i
< m
->matrix_h
; ++i
)
1900 struct glyph_row
*r
= m
->rows
+ i
;
1901 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1903 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1904 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1906 r
->enabled_p
= fr
->enabled_p
;
1909 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1910 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1911 r
->used
[TEXT_AREA
] = (m
->matrix_w
1912 - r
->used
[LEFT_MARGIN_AREA
]
1913 - r
->used
[RIGHT_MARGIN_AREA
]);
1922 /* Save away the contents of frame F's current frame matrix. Value is
1923 a glyph matrix holding the contents of F's current frame matrix. */
1925 static struct glyph_matrix
*
1926 save_current_matrix (struct frame
*f
)
1929 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1930 saved
->nrows
= f
->current_matrix
->nrows
;
1931 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1933 for (i
= 0; i
< saved
->nrows
; ++i
)
1935 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1936 struct glyph_row
*to
= saved
->rows
+ i
;
1937 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1938 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1939 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1940 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1947 /* Restore the contents of frame F's current frame matrix from SAVED,
1948 and free memory associated with SAVED. */
1951 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1955 for (i
= 0; i
< saved
->nrows
; ++i
)
1957 struct glyph_row
*from
= saved
->rows
+ i
;
1958 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1959 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1960 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1961 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1962 xfree (from
->glyphs
[TEXT_AREA
]);
1965 xfree (saved
->rows
);
1971 /* Allocate/reallocate glyph matrices of a single frame F for
1972 frame-based redisplay. */
1975 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1977 struct dim matrix_dim
;
1978 bool pool_changed_p
;
1979 int window_change_flags
;
1982 if (!FRAME_LIVE_P (f
))
1985 top_window_y
= FRAME_TOP_MARGIN (f
);
1987 /* Allocate glyph pool structures if not already done. */
1988 if (f
->desired_pool
== NULL
)
1990 f
->desired_pool
= new_glyph_pool ();
1991 f
->current_pool
= new_glyph_pool ();
1994 /* Allocate frames matrix structures if needed. */
1995 if (f
->desired_matrix
== NULL
)
1997 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1998 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2001 /* Compute window glyph matrices. (This takes the mini-buffer
2002 window into account). The result is the size of the frame glyph
2003 matrix needed. The variable window_change_flags is set to a bit
2004 mask indicating whether new matrices will be allocated or
2005 existing matrices change their size or location within the frame
2007 window_change_flags
= 0;
2009 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2012 &window_change_flags
);
2014 /* Add in menu bar lines, if any. */
2015 matrix_dim
.height
+= top_window_y
;
2017 /* Enlarge pools as necessary. */
2018 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2019 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2021 /* Set up glyph pointers within window matrices. Do this only if
2022 absolutely necessary since it requires a frame redraw. */
2023 if (pool_changed_p
|| window_change_flags
)
2025 /* Do it for window matrices. */
2026 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2028 &window_change_flags
);
2030 /* Size of frame matrices must equal size of frame. Note
2031 that we are called for X frames with window widths NOT equal
2032 to the frame width (from CHANGE_FRAME_SIZE_1). */
2033 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2034 && matrix_dim
.height
== FRAME_LINES (f
));
2036 /* Pointers to glyph memory in glyph rows are exchanged during
2037 the update phase of redisplay, which means in general that a
2038 frame's current matrix consists of pointers into both the
2039 desired and current glyph pool of the frame. Adjusting a
2040 matrix sets the frame matrix up so that pointers are all into
2041 the same pool. If we want to preserve glyph contents of the
2042 current matrix over a call to adjust_glyph_matrix, we must
2043 make a copy of the current glyphs, and restore the current
2044 matrix' contents from that copy. */
2045 if (display_completed
2046 && !FRAME_GARBAGED_P (f
)
2047 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2048 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2049 /* For some reason, the frame glyph matrix gets corrupted if
2050 any of the windows contain margins. I haven't been able
2051 to hunt down the reason, but for the moment this prevents
2052 the problem from manifesting. -- cyd */
2053 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2055 struct glyph_matrix
*copy
= save_current_matrix (f
);
2056 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2057 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2058 restore_current_matrix (f
, copy
);
2059 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2063 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2064 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2065 SET_FRAME_GARBAGED (f
);
2071 /* Allocate/reallocate glyph matrices of a single frame F for
2072 window-based redisplay. */
2075 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2077 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2079 /* Allocate/reallocate window matrices. */
2080 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2082 #ifdef HAVE_X_WINDOWS
2083 /* Allocate/ reallocate matrices of the dummy window used to display
2084 the menu bar under X when no X toolkit support is available. */
2085 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2087 /* Allocate a dummy window if not already done. */
2089 if (NILP (f
->menu_bar_window
))
2092 fset_menu_bar_window (f
, make_window ());
2093 w
= XWINDOW (f
->menu_bar_window
);
2094 XSETFRAME (frame
, f
);
2095 wset_frame (w
, frame
);
2096 w
->pseudo_window_p
= 1;
2099 w
= XWINDOW (f
->menu_bar_window
);
2101 /* Set window dimensions to frame dimensions and allocate or
2102 adjust glyph matrices of W. */
2105 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2106 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2107 allocate_matrices_for_window_redisplay (w
);
2109 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2110 #endif /* HAVE_X_WINDOWS */
2114 /* Allocate/ reallocate matrices of the tool bar window. If we
2115 don't have a tool bar window yet, make one. */
2117 if (NILP (f
->tool_bar_window
))
2120 fset_tool_bar_window (f
, make_window ());
2121 w
= XWINDOW (f
->tool_bar_window
);
2122 XSETFRAME (frame
, f
);
2123 wset_frame (w
, frame
);
2124 w
->pseudo_window_p
= 1;
2127 w
= XWINDOW (f
->tool_bar_window
);
2129 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2131 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2132 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2133 allocate_matrices_for_window_redisplay (w
);
2139 /* Re-allocate buffer for decode_mode_spec on frame F. */
2142 adjust_decode_mode_spec_buffer (struct frame
*f
)
2144 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2145 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2150 /**********************************************************************
2151 Freeing Glyph Matrices
2152 **********************************************************************/
2154 /* Free glyph memory for a frame F. F may be null. This function can
2155 be called for the same frame more than once. The root window of
2156 F may be nil when this function is called. This is the case when
2157 the function is called when F is destroyed. */
2160 free_glyphs (struct frame
*f
)
2162 if (f
&& f
->glyphs_initialized_p
)
2164 /* Block interrupt input so that we don't get surprised by an X
2165 event while we're in an inconsistent state. */
2167 f
->glyphs_initialized_p
= 0;
2169 /* Release window sub-matrices. */
2170 if (!NILP (f
->root_window
))
2171 free_window_matrices (XWINDOW (f
->root_window
));
2173 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2174 /* Free the dummy window for menu bars without X toolkit and its
2176 if (!NILP (f
->menu_bar_window
))
2178 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2179 free_glyph_matrix (w
->desired_matrix
);
2180 free_glyph_matrix (w
->current_matrix
);
2181 w
->desired_matrix
= w
->current_matrix
= NULL
;
2182 fset_menu_bar_window (f
, Qnil
);
2186 /* Free the tool bar window and its glyph matrices. */
2187 if (!NILP (f
->tool_bar_window
))
2189 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2190 free_glyph_matrix (w
->desired_matrix
);
2191 free_glyph_matrix (w
->current_matrix
);
2192 w
->desired_matrix
= w
->current_matrix
= NULL
;
2193 fset_tool_bar_window (f
, Qnil
);
2196 /* Release frame glyph matrices. Reset fields to zero in
2197 case we are called a second time. */
2198 if (f
->desired_matrix
)
2200 free_glyph_matrix (f
->desired_matrix
);
2201 free_glyph_matrix (f
->current_matrix
);
2202 f
->desired_matrix
= f
->current_matrix
= NULL
;
2205 /* Release glyph pools. */
2206 if (f
->desired_pool
)
2208 free_glyph_pool (f
->desired_pool
);
2209 free_glyph_pool (f
->current_pool
);
2210 f
->desired_pool
= f
->current_pool
= NULL
;
2218 /* Free glyph sub-matrices in the window tree rooted at W. This
2219 function may be called with a null pointer, and it may be called on
2220 the same tree more than once. */
2223 free_window_matrices (struct window
*w
)
2227 if (WINDOWP (w
->contents
))
2228 free_window_matrices (XWINDOW (w
->contents
));
2231 /* This is a leaf window. Free its memory and reset fields
2232 to zero in case this function is called a second time for
2234 free_glyph_matrix (w
->current_matrix
);
2235 free_glyph_matrix (w
->desired_matrix
);
2236 w
->current_matrix
= w
->desired_matrix
= NULL
;
2239 /* Next window on same level. */
2240 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2245 /* Check glyph memory leaks. This function is called from
2246 shut_down_emacs. Note that frames are not destroyed when Emacs
2247 exits. We therefore free all glyph memory for all active frames
2248 explicitly and check that nothing is left allocated. */
2251 check_glyph_memory (void)
2253 Lisp_Object tail
, frame
;
2255 /* Free glyph memory for all frames. */
2256 FOR_EACH_FRAME (tail
, frame
)
2257 free_glyphs (XFRAME (frame
));
2259 /* Check that nothing is left allocated. */
2260 if (glyph_matrix_count
)
2262 if (glyph_pool_count
)
2268 /**********************************************************************
2269 Building a Frame Matrix
2270 **********************************************************************/
2272 /* Most of the redisplay code works on glyph matrices attached to
2273 windows. This is a good solution most of the time, but it is not
2274 suitable for terminal code. Terminal output functions cannot rely
2275 on being able to set an arbitrary terminal window. Instead they
2276 must be provided with a view of the whole frame, i.e. the whole
2277 screen. We build such a view by constructing a frame matrix from
2278 window matrices in this section.
2280 Windows that must be updated have their must_be_update_p flag set.
2281 For all such windows, their desired matrix is made part of the
2282 desired frame matrix. For other windows, their current matrix is
2283 made part of the desired frame matrix.
2285 +-----------------+----------------+
2286 | desired | desired |
2288 +-----------------+----------------+
2291 +----------------------------------+
2293 Desired window matrices can be made part of the frame matrix in a
2294 cheap way: We exploit the fact that the desired frame matrix and
2295 desired window matrices share their glyph memory. This is not
2296 possible for current window matrices. Their glyphs are copied to
2297 the desired frame matrix. The latter is equivalent to
2298 preserve_other_columns in the old redisplay.
2300 Used glyphs counters for frame matrix rows are the result of adding
2301 up glyph lengths of the window matrices. A line in the frame
2302 matrix is enabled, if a corresponding line in a window matrix is
2305 After building the desired frame matrix, it will be passed to
2306 terminal code, which will manipulate both the desired and current
2307 frame matrix. Changes applied to the frame's current matrix have
2308 to be visible in current window matrices afterwards, of course.
2310 This problem is solved like this:
2312 1. Window and frame matrices share glyphs. Window matrices are
2313 constructed in a way that their glyph contents ARE the glyph
2314 contents needed in a frame matrix. Thus, any modification of
2315 glyphs done in terminal code will be reflected in window matrices
2318 2. Exchanges of rows in a frame matrix done by terminal code are
2319 intercepted by hook functions so that corresponding row operations
2320 on window matrices can be performed. This is necessary because we
2321 use pointers to glyphs in glyph row structures. To satisfy the
2322 assumption of point 1 above that glyphs are updated implicitly in
2323 window matrices when they are manipulated via the frame matrix,
2324 window and frame matrix must of course agree where to find the
2325 glyphs for their rows. Possible manipulations that must be
2326 mirrored are assignments of rows of the desired frame matrix to the
2327 current frame matrix and scrolling the current frame matrix. */
2329 /* Build frame F's desired matrix from window matrices. Only windows
2330 which have the flag must_be_updated_p set have to be updated. Menu
2331 bar lines of a frame are not covered by window matrices, so make
2332 sure not to touch them in this function. */
2335 build_frame_matrix (struct frame
*f
)
2339 /* F must have a frame matrix when this function is called. */
2340 eassert (!FRAME_WINDOW_P (f
));
2342 /* Clear all rows in the frame matrix covered by window matrices.
2343 Menu bar lines are not covered by windows. */
2344 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2345 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2347 /* Build the matrix by walking the window tree. */
2348 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2349 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2353 /* Walk a window tree, building a frame matrix MATRIX from window
2354 matrices. W is the root of a window tree. */
2357 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2361 if (WINDOWP (w
->contents
))
2362 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2364 build_frame_matrix_from_leaf_window (matrix
, w
);
2366 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2371 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2372 desired frame matrix built. W is a leaf window whose desired or
2373 current matrix is to be added to FRAME_MATRIX. W's flag
2374 must_be_updated_p determines which matrix it contributes to
2375 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2376 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2377 Adding a desired matrix means setting up used counters and such in
2378 frame rows, while adding a current window matrix to FRAME_MATRIX
2379 means copying glyphs. The latter case corresponds to
2380 preserve_other_columns in the old redisplay. */
2383 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2385 struct glyph_matrix
*window_matrix
;
2386 int window_y
, frame_y
;
2387 /* If non-zero, a glyph to insert at the right border of W. */
2388 GLYPH right_border_glyph
;
2390 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2392 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2393 if (w
->must_be_updated_p
)
2395 window_matrix
= w
->desired_matrix
;
2397 /* Decide whether we want to add a vertical border glyph. */
2398 if (!WINDOW_RIGHTMOST_P (w
))
2400 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2403 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2405 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2407 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2408 spec_glyph_lookup_face (w
, &right_border_glyph
);
2411 if (GLYPH_FACE (right_border_glyph
) <= 0)
2412 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2416 window_matrix
= w
->current_matrix
;
2418 /* For all rows in the window matrix and corresponding rows in the
2421 frame_y
= window_matrix
->matrix_y
;
2422 while (window_y
< window_matrix
->nrows
)
2424 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2425 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2426 bool current_row_p
= window_matrix
== w
->current_matrix
;
2428 /* Fill up the frame row with spaces up to the left margin of the
2430 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2432 /* Fill up areas in the window matrix row with spaces. */
2433 fill_up_glyph_row_with_spaces (window_row
);
2435 /* If only part of W's desired matrix has been built, and
2436 window_row wasn't displayed, use the corresponding current
2438 if (window_matrix
== w
->desired_matrix
2439 && !window_row
->enabled_p
)
2441 window_row
= w
->current_matrix
->rows
+ window_y
;
2447 /* Copy window row to frame row. */
2448 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2449 window_row
->glyphs
[0],
2450 window_matrix
->matrix_w
* sizeof (struct glyph
));
2454 eassert (window_row
->enabled_p
);
2456 /* Only when a desired row has been displayed, we want
2457 the corresponding frame row to be updated. */
2458 frame_row
->enabled_p
= 1;
2460 /* Maybe insert a vertical border between horizontally adjacent
2462 if (GLYPH_CHAR (right_border_glyph
) != 0)
2464 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2465 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2469 /* Window row window_y must be a slice of frame row
2471 eassert (glyph_row_slice_p (window_row
, frame_row
));
2473 /* If rows are in sync, we don't have to copy glyphs because
2474 frame and window share glyphs. */
2476 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2477 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2481 /* Set number of used glyphs in the frame matrix. Since we fill
2482 up with spaces, and visit leaf windows from left to right it
2483 can be done simply. */
2484 frame_row
->used
[TEXT_AREA
]
2485 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2493 /* Given a user-specified glyph, possibly including a Lisp-level face
2494 ID, return a glyph that has a realized face ID.
2495 This is used for glyphs displayed specially and not part of the text;
2496 for instance, vertical separators, truncation markers, etc. */
2499 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2501 int lface_id
= GLYPH_FACE (*glyph
);
2502 /* Convert the glyph's specified face to a realized (cache) face. */
2505 int face_id
= merge_faces (XFRAME (w
->frame
),
2506 Qt
, lface_id
, DEFAULT_FACE_ID
);
2507 SET_GLYPH_FACE (*glyph
, face_id
);
2511 /* Add spaces to a glyph row ROW in a window matrix.
2513 Each row has the form:
2515 +---------+-----------------------------+------------+
2516 | left | text | right |
2517 +---------+-----------------------------+------------+
2519 Left and right marginal areas are optional. This function adds
2520 spaces to areas so that there are no empty holes between areas.
2521 In other words: If the right area is not empty, the text area
2522 is filled up with spaces up to the right area. If the text area
2523 is not empty, the left area is filled up.
2525 To be called for frame-based redisplay, only. */
2528 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2530 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2531 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2532 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2536 /* Fill area AREA of glyph row ROW with spaces. To be called for
2537 frame-based redisplay only. */
2540 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2542 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2544 struct glyph
*end
= row
->glyphs
[area
+ 1];
2545 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2548 *text
++ = space_glyph
;
2549 row
->used
[area
] = text
- row
->glyphs
[area
];
2554 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2555 reached. In frame matrices only one area, TEXT_AREA, is used. */
2558 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2560 int i
= row
->used
[TEXT_AREA
];
2561 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2564 glyph
[i
++] = space_glyph
;
2566 row
->used
[TEXT_AREA
] = i
;
2571 /**********************************************************************
2572 Mirroring operations on frame matrices in window matrices
2573 **********************************************************************/
2575 /* Set frame being updated via frame-based redisplay to F. This
2576 function must be called before updates to make explicit that we are
2577 working on frame matrices or not. */
2580 set_frame_matrix_frame (struct frame
*f
)
2582 frame_matrix_frame
= f
;
2586 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2587 DESIRED_MATRIX is the desired matrix corresponding to
2588 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2589 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2590 frame_matrix_frame is non-null, this indicates that the exchange is
2591 done in frame matrices, and that we have to perform analogous
2592 operations in window matrices of frame_matrix_frame. */
2595 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2597 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2598 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2599 bool mouse_face_p
= current_row
->mouse_face_p
;
2601 /* Do current_row = desired_row. This exchanges glyph pointers
2602 between both rows, and does a structure assignment otherwise. */
2603 assign_row (current_row
, desired_row
);
2605 /* Enable current_row to mark it as valid. */
2606 current_row
->enabled_p
= 1;
2607 current_row
->mouse_face_p
= mouse_face_p
;
2609 /* If we are called on frame matrices, perform analogous operations
2610 for window matrices. */
2611 if (frame_matrix_frame
)
2612 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2616 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2617 W's frame which has been made current (by swapping pointers between
2618 current and desired matrix). Perform analogous operations in the
2619 matrices of leaf windows in the window tree rooted at W. */
2622 mirror_make_current (struct window
*w
, int frame_row
)
2626 if (WINDOWP (w
->contents
))
2627 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2630 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2631 here because the checks performed in debug mode there
2632 will not allow the conversion. */
2633 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2635 /* If FRAME_ROW is within W, assign the desired row to the
2636 current row (exchanging glyph pointers). */
2637 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2639 struct glyph_row
*current_row
2640 = MATRIX_ROW (w
->current_matrix
, row
);
2641 struct glyph_row
*desired_row
2642 = MATRIX_ROW (w
->desired_matrix
, row
);
2644 if (desired_row
->enabled_p
)
2645 assign_row (current_row
, desired_row
);
2647 swap_glyph_pointers (desired_row
, current_row
);
2648 current_row
->enabled_p
= 1;
2650 /* Set the Y coordinate of the mode/header line's row.
2651 It is needed in draw_row_with_mouse_face to find the
2652 screen coordinates. (Window-based redisplay sets
2653 this in update_window, but no one seems to do that
2654 for frame-based redisplay.) */
2655 if (current_row
->mode_line_p
)
2656 current_row
->y
= row
;
2660 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2665 /* Perform row dance after scrolling. We are working on the range of
2666 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2667 including) in MATRIX. COPY_FROM is a vector containing, for each
2668 row I in the range 0 <= I < NLINES, the index of the original line
2669 to move to I. This index is relative to the row range, i.e. 0 <=
2670 index < NLINES. RETAINED_P is a vector containing zero for each
2671 row 0 <= I < NLINES which is empty.
2673 This function is called from do_scrolling and do_direct_scrolling. */
2676 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2677 int *copy_from
, char *retained_p
)
2679 /* A copy of original rows. */
2680 struct glyph_row
*old_rows
;
2682 /* Rows to assign to. */
2683 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2687 /* Make a copy of the original rows. */
2688 old_rows
= alloca (nlines
* sizeof *old_rows
);
2689 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2691 /* Assign new rows, maybe clear lines. */
2692 for (i
= 0; i
< nlines
; ++i
)
2694 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2696 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2697 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2698 new_rows
[i
] = old_rows
[copy_from
[i
]];
2699 new_rows
[i
].enabled_p
= enabled_before_p
;
2701 /* RETAINED_P is zero for empty lines. */
2702 if (!retained_p
[copy_from
[i
]])
2703 new_rows
[i
].enabled_p
= 0;
2706 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2707 if (frame_matrix_frame
)
2708 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2709 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2713 /* Synchronize glyph pointers in the current matrix of window W with
2714 the current frame matrix. */
2717 sync_window_with_frame_matrix_rows (struct window
*w
)
2719 struct frame
*f
= XFRAME (w
->frame
);
2720 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2721 int left
, right
, x
, width
;
2723 /* Preconditions: W must be a live window on a tty frame. */
2724 eassert (BUFFERP (w
->contents
));
2725 eassert (!FRAME_WINDOW_P (f
));
2727 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2728 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2729 x
= w
->current_matrix
->matrix_x
;
2730 width
= w
->current_matrix
->matrix_w
;
2732 window_row
= w
->current_matrix
->rows
;
2733 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2734 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2736 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2738 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2739 = frame_row
->glyphs
[0] + x
;
2740 window_row
->glyphs
[TEXT_AREA
]
2741 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2742 window_row
->glyphs
[LAST_AREA
]
2743 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2744 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2745 = window_row
->glyphs
[LAST_AREA
] - right
;
2750 /* Return the window in the window tree rooted in W containing frame
2751 row ROW. Value is null if none is found. */
2753 static struct window
*
2754 frame_row_to_window (struct window
*w
, int row
)
2756 struct window
*found
= NULL
;
2760 if (WINDOWP (w
->contents
))
2761 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2762 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2763 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2766 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2773 /* Perform a line dance in the window tree rooted at W, after
2774 scrolling a frame matrix in mirrored_line_dance.
2776 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2777 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2778 COPY_FROM is a vector containing, for each row I in the range 0 <=
2779 I < NLINES, the index of the original line to move to I. This
2780 index is relative to the row range, i.e. 0 <= index < NLINES.
2781 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2785 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2789 if (WINDOWP (w
->contents
))
2790 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2791 nlines
, copy_from
, retained_p
);
2794 /* W is a leaf window, and we are working on its current
2796 struct glyph_matrix
*m
= w
->current_matrix
;
2799 struct glyph_row
*old_rows
;
2801 /* Make a copy of the original rows of matrix m. */
2802 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2803 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2805 for (i
= 0; i
< nlines
; ++i
)
2807 /* Frame relative line assigned to. */
2808 int frame_to
= i
+ unchanged_at_top
;
2810 /* Frame relative line assigned. */
2811 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2813 /* Window relative line assigned to. */
2814 int window_to
= frame_to
- m
->matrix_y
;
2816 /* Window relative line assigned. */
2817 int window_from
= frame_from
- m
->matrix_y
;
2819 /* Is assigned line inside window? */
2820 bool from_inside_window_p
2821 = window_from
>= 0 && window_from
< m
->matrix_h
;
2823 /* Is assigned to line inside window? */
2824 bool to_inside_window_p
2825 = window_to
>= 0 && window_to
< m
->matrix_h
;
2827 if (from_inside_window_p
&& to_inside_window_p
)
2829 /* Do the assignment. The enabled_p flag is saved
2830 over the assignment because the old redisplay did
2832 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2833 m
->rows
[window_to
] = old_rows
[window_from
];
2834 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2836 /* If frame line is empty, window line is empty, too. */
2837 if (!retained_p
[copy_from
[i
]])
2838 m
->rows
[window_to
].enabled_p
= 0;
2840 else if (to_inside_window_p
)
2842 /* A copy between windows. This is an infrequent
2843 case not worth optimizing. */
2844 struct frame
*f
= XFRAME (w
->frame
);
2845 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2847 struct glyph_matrix
*m2
;
2850 w2
= frame_row_to_window (root
, frame_from
);
2851 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2852 -nw', FROM_FRAME sometimes has no associated window.
2853 This check avoids a segfault if W2 is null. */
2856 m2
= w2
->current_matrix
;
2857 m2_from
= frame_from
- m2
->matrix_y
;
2858 copy_row_except_pointers (m
->rows
+ window_to
,
2859 m2
->rows
+ m2_from
);
2861 /* If frame line is empty, window line is empty, too. */
2862 if (!retained_p
[copy_from
[i
]])
2863 m
->rows
[window_to
].enabled_p
= 0;
2867 else if (from_inside_window_p
)
2871 /* If there was a copy between windows, make sure glyph
2872 pointers are in sync with the frame matrix. */
2874 sync_window_with_frame_matrix_rows (w
);
2876 /* Check that no pointers are lost. */
2880 /* Next window on same level. */
2881 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2888 /* Check that window and frame matrices agree about their
2889 understanding where glyphs of the rows are to find. For each
2890 window in the window tree rooted at W, check that rows in the
2891 matrices of leaf window agree with their frame matrices about
2895 check_window_matrix_pointers (struct window
*w
)
2899 if (WINDOWP (w
->contents
))
2900 check_window_matrix_pointers (XWINDOW (w
->contents
));
2903 struct frame
*f
= XFRAME (w
->frame
);
2904 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2905 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2908 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2913 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2914 a window and FRAME_MATRIX is the corresponding frame matrix. For
2915 each row in WINDOW_MATRIX check that it's a slice of the
2916 corresponding frame row. If it isn't, abort. */
2919 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2920 struct glyph_matrix
*frame_matrix
)
2922 /* Row number in WINDOW_MATRIX. */
2925 /* Row number corresponding to I in FRAME_MATRIX. */
2926 int j
= window_matrix
->matrix_y
;
2928 /* For all rows check that the row in the window matrix is a
2929 slice of the row in the frame matrix. If it isn't we didn't
2930 mirror an operation on the frame matrix correctly. */
2931 while (i
< window_matrix
->nrows
)
2933 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2934 frame_matrix
->rows
+ j
))
2940 #endif /* GLYPH_DEBUG */
2944 /**********************************************************************
2945 VPOS and HPOS translations
2946 **********************************************************************/
2950 /* Translate vertical position VPOS which is relative to window W to a
2951 vertical position relative to W's frame. */
2954 window_to_frame_vpos (struct window
*w
, int vpos
)
2956 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2957 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2958 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2959 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
2964 /* Translate horizontal position HPOS which is relative to window W to
2965 a horizontal position relative to W's frame. */
2968 window_to_frame_hpos (struct window
*w
, int hpos
)
2970 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2971 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2975 #endif /* GLYPH_DEBUG */
2979 /**********************************************************************
2981 **********************************************************************/
2983 /* Redraw frame F. */
2986 redraw_frame (struct frame
*f
)
2988 /* Error if F has no glyphs. */
2989 eassert (f
->glyphs_initialized_p
);
2992 if (FRAME_MSDOS_P (f
))
2993 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
2996 clear_current_matrices (f
);
2998 if (FRAME_TERMCAP_P (f
))
2999 fflush (FRAME_TTY (f
)->output
);
3000 windows_or_buffers_changed
++;
3001 /* Mark all windows as inaccurate, so that every window will have
3002 its redisplay done. */
3003 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3004 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3008 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3009 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3010 If FRAME is omitted or nil, the selected frame is used. */)
3013 redraw_frame (decode_live_frame (frame
));
3017 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3018 doc
: /* Clear and redisplay all visible frames. */)
3021 Lisp_Object tail
, frame
;
3023 FOR_EACH_FRAME (tail
, frame
)
3024 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3025 redraw_frame (XFRAME (frame
));
3032 /***********************************************************************
3034 ***********************************************************************/
3036 /* Update frame F based on the data in desired matrices.
3038 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3039 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3041 Value is true if redisplay was stopped due to pending input. */
3044 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3046 /* True means display has been paused because of pending input. */
3048 struct window
*root_window
= XWINDOW (f
->root_window
);
3050 if (redisplay_dont_pause
)
3052 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3058 if (FRAME_WINDOW_P (f
))
3060 /* We are working on window matrix basis. All windows whose
3061 flag must_be_updated_p is set have to be updated. */
3063 /* Record that we are not working on frame matrices. */
3064 set_frame_matrix_frame (NULL
);
3066 /* Update all windows in the window tree of F, maybe stopping
3067 when pending input is detected. */
3070 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3071 /* Update the menu bar on X frames that don't have toolkit
3073 if (WINDOWP (f
->menu_bar_window
))
3074 update_window (XWINDOW (f
->menu_bar_window
), 1);
3077 /* Update the tool-bar window, if present. */
3078 if (WINDOWP (f
->tool_bar_window
))
3080 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3082 /* Update tool-bar window. */
3083 if (w
->must_be_updated_p
)
3087 update_window (w
, 1);
3088 w
->must_be_updated_p
= 0;
3090 /* Swap tool-bar strings. We swap because we want to
3092 tem
= f
->current_tool_bar_string
;
3093 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3094 fset_desired_tool_bar_string (f
, tem
);
3099 /* Update windows. */
3100 paused_p
= update_window_tree (root_window
, force_p
);
3103 /* This flush is a performance bottleneck under X,
3104 and it doesn't seem to be necessary anyway (in general).
3105 It is necessary when resizing the window with the mouse, or
3106 at least the fringes are not redrawn in a timely manner. ++kfs */
3107 if (f
->force_flush_display_p
)
3109 FRAME_RIF (f
)->flush_display (f
);
3110 f
->force_flush_display_p
= 0;
3115 /* We are working on frame matrix basis. Set the frame on whose
3116 frame matrix we operate. */
3117 set_frame_matrix_frame (f
);
3119 /* Build F's desired matrix from window matrices. */
3120 build_frame_matrix (f
);
3122 /* Update the display */
3124 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3127 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3129 if (FRAME_TTY (f
)->termscript
)
3130 fflush (FRAME_TTY (f
)->termscript
);
3131 if (FRAME_TERMCAP_P (f
))
3132 fflush (FRAME_TTY (f
)->output
);
3135 /* Check window matrices for lost pointers. */
3137 check_window_matrix_pointers (root_window
);
3138 add_frame_display_history (f
, paused_p
);
3143 /* Reset flags indicating that a window should be updated. */
3144 set_window_update_flags (root_window
, 0);
3146 display_completed
= !paused_p
;
3152 /************************************************************************
3153 Window-based updates
3154 ************************************************************************/
3156 /* Perform updates in window tree rooted at W.
3157 If FORCE_P, don't stop updating if input is pending. */
3160 update_window_tree (struct window
*w
, bool force_p
)
3164 while (w
&& !paused_p
)
3166 if (WINDOWP (w
->contents
))
3167 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3168 else if (w
->must_be_updated_p
)
3169 paused_p
|= update_window (w
, force_p
);
3171 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3178 /* Update window W if its flag must_be_updated_p is set.
3179 If FORCE_P, don't stop updating if input is pending. */
3182 update_single_window (struct window
*w
, bool force_p
)
3184 if (w
->must_be_updated_p
)
3186 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3188 /* Record that this is not a frame-based redisplay. */
3189 set_frame_matrix_frame (NULL
);
3191 if (redisplay_dont_pause
)
3196 update_window (w
, force_p
);
3199 /* Reset flag in W. */
3200 w
->must_be_updated_p
= 0;
3204 #ifdef HAVE_WINDOW_SYSTEM
3206 /* Redraw lines from the current matrix of window W that are
3207 overlapped by other rows. YB is bottom-most y-position in W. */
3210 redraw_overlapped_rows (struct window
*w
, int yb
)
3213 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3215 /* If rows overlapping others have been changed, the rows being
3216 overlapped have to be redrawn. This won't draw lines that have
3217 already been drawn in update_window_line because overlapped_p in
3218 desired rows is 0, so after row assignment overlapped_p in
3219 current rows is 0. */
3220 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3222 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3224 if (!row
->enabled_p
)
3226 else if (row
->mode_line_p
)
3229 if (row
->overlapped_p
)
3231 enum glyph_row_area area
;
3233 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3236 updated_area
= area
;
3237 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3238 area
== TEXT_AREA
? row
->x
: 0);
3239 if (row
->used
[area
])
3240 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3242 FRAME_RIF (f
)->clear_end_of_line (-1);
3245 row
->overlapped_p
= 0;
3248 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3254 /* Redraw lines from the current matrix of window W that overlap
3255 others. YB is bottom-most y-position in W. */
3258 redraw_overlapping_rows (struct window
*w
, int yb
)
3261 struct glyph_row
*row
;
3262 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3264 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3266 row
= w
->current_matrix
->rows
+ i
;
3268 if (!row
->enabled_p
)
3270 else if (row
->mode_line_p
)
3273 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3275 if (row
->overlapping_p
)
3279 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3280 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3281 overlaps
|= OVERLAPS_PRED
;
3282 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3283 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3284 overlaps
|= OVERLAPS_SUCC
;
3288 if (row
->used
[LEFT_MARGIN_AREA
])
3289 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3291 if (row
->used
[TEXT_AREA
])
3292 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3294 if (row
->used
[RIGHT_MARGIN_AREA
])
3295 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3297 /* Record in neighbor rows that ROW overwrites part of
3299 if (overlaps
& OVERLAPS_PRED
)
3300 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3301 if (overlaps
& OVERLAPS_SUCC
)
3302 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3311 #endif /* HAVE_WINDOW_SYSTEM */
3314 #if defined GLYPH_DEBUG && 0
3316 /* Check that no row in the current matrix of window W is enabled
3317 which is below what's displayed in the window. */
3320 check_current_matrix_flags (struct window
*w
)
3322 bool last_seen_p
= 0;
3323 int i
, yb
= window_text_bottom_y (w
);
3325 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3327 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3328 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3330 else if (last_seen_p
&& row
->enabled_p
)
3335 #endif /* GLYPH_DEBUG */
3338 /* Update display of window W.
3339 If FORCE_P, don't stop updating when input is pending. */
3342 update_window (struct window
*w
, bool force_p
)
3344 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3346 int preempt_count
= baud_rate
/ 2400 + 1;
3347 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3349 /* Check that W's frame doesn't have glyph matrices. */
3350 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3353 /* Check pending input the first time so that we can quickly return. */
3355 detect_input_pending_ignore_squeezables ();
3357 /* If forced to complete the update, or if no input is pending, do
3359 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3361 struct glyph_row
*row
, *end
;
3362 struct glyph_row
*mode_line_row
;
3363 struct glyph_row
*header_line_row
;
3365 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3368 rif
->update_window_begin_hook (w
);
3369 yb
= window_text_bottom_y (w
);
3370 row
= MATRIX_ROW (desired_matrix
, 0);
3371 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3373 /* Take note of the header line, if there is one. We will
3374 update it below, after updating all of the window's lines. */
3375 if (row
->mode_line_p
)
3377 header_line_row
= row
;
3381 header_line_row
= NULL
;
3383 /* Update the mode line, if necessary. */
3384 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3385 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3387 mode_line_row
->y
= yb
;
3388 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3390 &mouse_face_overwritten_p
);
3393 /* Find first enabled row. Optimizations in redisplay_internal
3394 may lead to an update with only one row enabled. There may
3395 be also completely empty matrices. */
3396 while (row
< end
&& !row
->enabled_p
)
3399 /* Try reusing part of the display by copying. */
3400 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3402 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3405 /* All rows were found to be equal. */
3411 /* We've scrolled the display. */
3417 /* Update the rest of the lines. */
3418 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3419 /* scrolling_window resets the enabled_p flag of the rows it
3420 reuses from current_matrix. */
3423 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3426 /* We'll have to play a little bit with when to
3427 detect_input_pending. If it's done too often,
3428 scrolling large windows with repeated scroll-up
3429 commands will too quickly pause redisplay. */
3430 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3431 detect_input_pending_ignore_squeezables ();
3432 changed_p
|= update_window_line (w
, vpos
,
3433 &mouse_face_overwritten_p
);
3435 /* Mark all rows below the last visible one in the current
3436 matrix as invalid. This is necessary because of
3437 variable line heights. Consider the case of three
3438 successive redisplays, where the first displays 5
3439 lines, the second 3 lines, and the third 5 lines again.
3440 If the second redisplay wouldn't mark rows in the
3441 current matrix invalid, the third redisplay might be
3442 tempted to optimize redisplay based on lines displayed
3443 in the first redisplay. */
3444 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3445 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3446 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3449 /* Was display preempted? */
3450 paused_p
= row
< end
;
3454 /* Update the header line after scrolling because a new header
3455 line would otherwise overwrite lines at the top of the window
3456 that can be scrolled. */
3457 if (header_line_row
&& header_line_row
->enabled_p
)
3459 header_line_row
->y
= 0;
3460 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3463 /* Fix the appearance of overlapping/overlapped rows. */
3464 if (!paused_p
&& !w
->pseudo_window_p
)
3466 #ifdef HAVE_WINDOW_SYSTEM
3467 if (changed_p
&& rif
->fix_overlapping_area
)
3469 redraw_overlapped_rows (w
, yb
);
3470 redraw_overlapping_rows (w
, yb
);
3474 /* Make cursor visible at cursor position of W. */
3475 set_window_cursor_after_update (w
);
3477 #if 0 /* Check that current matrix invariants are satisfied. This is
3478 for debugging only. See the comment of check_matrix_invariants. */
3479 IF_DEBUG (check_matrix_invariants (w
));
3484 /* Remember the redisplay method used to display the matrix. */
3485 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3488 #ifdef HAVE_WINDOW_SYSTEM
3489 update_window_fringes (w
, 0);
3492 /* End the update of window W. Don't set the cursor if we
3493 paused updating the display because in this case,
3494 set_window_cursor_after_update hasn't been called, and
3495 output_cursor doesn't contain the cursor location. */
3496 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3502 /* check_current_matrix_flags (w); */
3503 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3506 #ifdef HAVE_XWIDGETS
3507 xwidget_end_redisplay(w
, w
->current_matrix
);
3509 clear_glyph_matrix (desired_matrix
);
3515 /* Update the display of area AREA in window W, row number VPOS.
3516 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3519 update_marginal_area (struct window
*w
, int area
, int vpos
)
3521 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3522 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3524 /* Let functions in xterm.c know what area subsequent X positions
3525 will be relative to. */
3526 updated_area
= area
;
3528 /* Set cursor to start of glyphs, write them, and clear to the end
3529 of the area. I don't think that something more sophisticated is
3530 necessary here, since marginal areas will not be the default. */
3531 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3532 if (desired_row
->used
[area
])
3533 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3534 rif
->clear_end_of_line (-1);
3538 /* Update the display of the text area of row VPOS in window W.
3539 Value is true if display has changed. */
3542 update_text_area (struct window
*w
, int vpos
)
3544 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3545 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3546 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3549 /* Let functions in xterm.c know what area subsequent X positions
3550 will be relative to. */
3551 updated_area
= TEXT_AREA
;
3553 /* If rows are at different X or Y, or rows have different height,
3554 or the current row is marked invalid, write the entire line. */
3555 if (!current_row
->enabled_p
3556 || desired_row
->y
!= current_row
->y
3557 || desired_row
->ascent
!= current_row
->ascent
3558 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3559 || desired_row
->phys_height
!= current_row
->phys_height
3560 || desired_row
->visible_height
!= current_row
->visible_height
3561 || current_row
->overlapped_p
3562 /* This next line is necessary for correctly redrawing
3563 mouse-face areas after scrolling and other operations.
3564 However, it causes excessive flickering when mouse is moved
3565 across the mode line. Luckily, turning it off for the mode
3566 line doesn't seem to hurt anything. -- cyd.
3567 But it is still needed for the header line. -- kfs. */
3568 || (current_row
->mouse_face_p
3569 && !(current_row
->mode_line_p
&& vpos
> 0))
3570 || current_row
->x
!= desired_row
->x
)
3572 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3574 if (desired_row
->used
[TEXT_AREA
])
3575 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3576 desired_row
->used
[TEXT_AREA
]);
3578 /* Clear to end of window. */
3579 rif
->clear_end_of_line (-1);
3582 /* This erases the cursor. We do this here because
3583 notice_overwritten_cursor cannot easily check this, which
3584 might indicate that the whole functionality of
3585 notice_overwritten_cursor would better be implemented here.
3586 On the other hand, we need notice_overwritten_cursor as long
3587 as mouse highlighting is done asynchronously outside of
3589 if (vpos
== w
->phys_cursor
.vpos
)
3590 w
->phys_cursor_on_p
= 0;
3595 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3596 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3597 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3598 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3599 bool abort_skipping
= 0;
3601 /* If the desired row extends its face to the text area end, and
3602 unless the current row also does so at the same position,
3603 make sure we write at least one glyph, so that the face
3604 extension actually takes place. */
3605 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3606 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3607 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3608 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3611 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3615 /* Loop over glyphs that current and desired row may have
3619 bool can_skip_p
= !abort_skipping
;
3621 /* Skip over glyphs that both rows have in common. These
3622 don't have to be written. We can't skip if the last
3623 current glyph overlaps the glyph to its right. For
3624 example, consider a current row of `if ' with the `f' in
3625 Courier bold so that it overlaps the ` ' to its right.
3626 If the desired row is ` ', we would skip over the space
3627 after the `if' and there would remain a pixel from the
3628 `f' on the screen. */
3629 if (overlapping_glyphs_p
&& i
> 0)
3631 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3634 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3636 can_skip_p
= (right
== 0 && !abort_skipping
);
3644 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3646 x
+= desired_glyph
->pixel_width
;
3647 ++desired_glyph
, ++current_glyph
, ++i
;
3650 /* Consider the case that the current row contains "xxx
3651 ppp ggg" in italic Courier font, and the desired row
3652 is "xxx ggg". The character `p' has lbearing, `g'
3653 has not. The loop above will stop in front of the
3654 first `p' in the current row. If we would start
3655 writing glyphs there, we wouldn't erase the lbearing
3656 of the `p'. The rest of the lbearing problem is then
3657 taken care of by draw_glyphs. */
3658 if (overlapping_glyphs_p
3660 && i
< current_row
->used
[TEXT_AREA
]
3661 && (current_row
->used
[TEXT_AREA
]
3662 != desired_row
->used
[TEXT_AREA
]))
3666 rif
->get_glyph_overhangs (current_glyph
,
3669 while (left
> 0 && i
> 0)
3671 --i
, --desired_glyph
, --current_glyph
;
3672 x
-= desired_glyph
->pixel_width
;
3673 left
-= desired_glyph
->pixel_width
;
3676 /* Abort the skipping algorithm if we end up before
3677 our starting point, to avoid looping (bug#1070).
3678 This can happen when the lbearing is larger than
3680 abort_skipping
= (i
< start_hpos
);
3684 /* Try to avoid writing the entire rest of the desired row
3685 by looking for a resync point. This mainly prevents
3686 mode line flickering in the case the mode line is in
3687 fixed-pitch font, which it usually will be. */
3688 if (i
< desired_row
->used
[TEXT_AREA
])
3690 int start_x
= x
, start_hpos
= i
;
3691 struct glyph
*start
= desired_glyph
;
3693 bool skip_first_p
= !can_skip_p
;
3695 /* Find the next glyph that's equal again. */
3698 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3701 x
+= desired_glyph
->pixel_width
;
3702 current_x
+= current_glyph
->pixel_width
;
3703 ++desired_glyph
, ++current_glyph
, ++i
;
3707 if (i
== start_hpos
|| x
!= current_x
)
3711 desired_glyph
= start
;
3715 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3716 rif
->write_glyphs (start
, i
- start_hpos
);
3721 /* Write the rest. */
3722 if (i
< desired_row
->used
[TEXT_AREA
])
3724 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3725 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3729 /* Maybe clear to end of line. */
3730 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3732 /* If new row extends to the end of the text area, nothing
3733 has to be cleared, if and only if we did a write_glyphs
3734 above. This is made sure by setting desired_stop_pos
3735 appropriately above. */
3736 eassert (i
< desired_row
->used
[TEXT_AREA
]
3737 || ((desired_row
->used
[TEXT_AREA
]
3738 == current_row
->used
[TEXT_AREA
])
3739 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3741 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3743 /* If old row extends to the end of the text area, clear. */
3744 if (i
>= desired_row
->used
[TEXT_AREA
])
3745 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3746 desired_row
->pixel_width
);
3747 rif
->clear_end_of_line (-1);
3750 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3752 /* Otherwise clear to the end of the old row. Everything
3753 after that position should be clear already. */
3756 if (i
>= desired_row
->used
[TEXT_AREA
])
3757 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3758 desired_row
->pixel_width
);
3760 /* If cursor is displayed at the end of the line, make sure
3761 it's cleared. Nowadays we don't have a phys_cursor_glyph
3762 with which to erase the cursor (because this method
3763 doesn't work with lbearing/rbearing), so we must do it
3765 if (vpos
== w
->phys_cursor
.vpos
3766 && (desired_row
->reversed_p
3767 ? (w
->phys_cursor
.hpos
< 0)
3768 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3770 w
->phys_cursor_on_p
= 0;
3774 xlim
= current_row
->pixel_width
;
3775 rif
->clear_end_of_line (xlim
);
3784 /* Update row VPOS in window W. Value is true if display has been changed. */
3787 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3789 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3790 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3791 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3794 /* Set the row being updated. This is important to let xterm.c
3795 know what line height values are in effect. */
3796 updated_row
= desired_row
;
3798 /* A row can be completely invisible in case a desired matrix was
3799 built with a vscroll and then make_cursor_line_fully_visible shifts
3800 the matrix. Make sure to make such rows current anyway, since
3801 we need the correct y-position, for example, in the current matrix. */
3802 if (desired_row
->mode_line_p
3803 || desired_row
->visible_height
> 0)
3805 eassert (desired_row
->enabled_p
);
3807 /* Update display of the left margin area, if there is one. */
3808 if (!desired_row
->full_width_p
3809 && !NILP (w
->left_margin_cols
))
3812 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
3813 /* Setting this flag will ensure the vertical border, if
3814 any, between this window and the one on its left will be
3815 redrawn. This is necessary because updating the left
3816 margin area can potentially draw over the border. */
3817 current_row
->redraw_fringe_bitmaps_p
= 1;
3820 /* Update the display of the text area. */
3821 if (update_text_area (w
, vpos
))
3824 if (current_row
->mouse_face_p
)
3825 *mouse_face_overwritten_p
= 1;
3828 /* Update display of the right margin area, if there is one. */
3829 if (!desired_row
->full_width_p
3830 && !NILP (w
->right_margin_cols
))
3833 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
3836 /* Draw truncation marks etc. */
3837 if (!current_row
->enabled_p
3838 || desired_row
->y
!= current_row
->y
3839 || desired_row
->visible_height
!= current_row
->visible_height
3840 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3841 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3842 || current_row
->redraw_fringe_bitmaps_p
3843 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3844 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3845 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3846 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3847 rif
->after_update_window_line_hook (desired_row
);
3850 /* Update current_row from desired_row. */
3851 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3857 /* Set the cursor after an update of window W. This function may only
3858 be called from update_window. */
3861 set_window_cursor_after_update (struct window
*w
)
3863 struct frame
*f
= XFRAME (w
->frame
);
3864 struct redisplay_interface
*rif
= FRAME_RIF (f
);
3865 int cx
, cy
, vpos
, hpos
;
3867 /* Not intended for frame matrix updates. */
3868 eassert (FRAME_WINDOW_P (f
));
3870 if (cursor_in_echo_area
3871 && !NILP (echo_area_buffer
[0])
3872 /* If we are showing a message instead of the mini-buffer,
3873 show the cursor for the message instead. */
3874 && XWINDOW (minibuf_window
) == w
3875 && EQ (minibuf_window
, echo_area_window
)
3876 /* These cases apply only to the frame that contains
3877 the active mini-buffer window. */
3878 && FRAME_HAS_MINIBUF_P (f
)
3879 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3881 cx
= cy
= vpos
= hpos
= 0;
3883 if (cursor_in_echo_area
>= 0)
3885 /* If the mini-buffer is several lines high, find the last
3886 line that has any text on it. Note: either all lines
3887 are enabled or none. Otherwise we wouldn't be able to
3889 struct glyph_row
*row
, *last_row
;
3890 struct glyph
*glyph
;
3891 int yb
= window_text_bottom_y (w
);
3894 row
= w
->current_matrix
->rows
;
3895 while (row
->enabled_p
3896 && (last_row
== NULL
3897 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3899 if (row
->used
[TEXT_AREA
]
3900 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3907 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3908 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3910 while (last
> start
&& last
->charpos
< 0)
3913 for (glyph
= start
; glyph
< last
; ++glyph
)
3915 cx
+= glyph
->pixel_width
;
3920 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3928 hpos
= w
->cursor
.hpos
;
3929 vpos
= w
->cursor
.vpos
;
3932 /* Window cursor can be out of sync for horizontally split windows.
3933 Horizontal position is -1 when cursor is on the left fringe. */
3934 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3935 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3936 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
3940 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
3941 tree rooted at W. */
3944 set_window_update_flags (struct window
*w
, bool on_p
)
3948 if (WINDOWP (w
->contents
))
3949 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3951 w
->must_be_updated_p
= on_p
;
3953 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3959 /***********************************************************************
3960 Window-Based Scrolling
3961 ***********************************************************************/
3963 /* Structure describing rows in scrolling_window. */
3967 /* Number of occurrences of this row in desired and current matrix. */
3968 int old_uses
, new_uses
;
3970 /* Vpos of row in new matrix. */
3971 int new_line_number
;
3973 /* Bucket index of this row_entry in the hash table row_table. */
3976 /* The row described by this entry. */
3977 struct glyph_row
*row
;
3979 /* Hash collision chain. */
3980 struct row_entry
*next
;
3983 /* A pool to allocate row_entry structures from, and the size of the
3984 pool. The pool is reallocated in scrolling_window when we find
3985 that we need a larger one. */
3987 static struct row_entry
*row_entry_pool
;
3988 static ptrdiff_t row_entry_pool_size
;
3990 /* Index of next free entry in row_entry_pool. */
3992 static ptrdiff_t row_entry_idx
;
3994 /* The hash table used during scrolling, and the table's size. This
3995 table is used to quickly identify equal rows in the desired and
3998 static struct row_entry
**row_table
;
3999 static ptrdiff_t row_table_size
;
4001 /* Vectors of pointers to row_entry structures belonging to the
4002 current and desired matrix, and the size of the vectors. */
4004 static struct row_entry
**old_lines
, **new_lines
;
4005 static ptrdiff_t old_lines_size
, new_lines_size
;
4007 /* A pool to allocate run structures from, and its size. */
4009 static struct run
*run_pool
;
4010 static ptrdiff_t runs_size
;
4012 /* A vector of runs of lines found during scrolling. */
4014 static struct run
**runs
;
4016 /* Add glyph row ROW to the scrolling hash table. */
4018 static struct row_entry
*
4019 add_row_entry (struct glyph_row
*row
)
4021 struct row_entry
*entry
;
4022 ptrdiff_t i
= row
->hash
% row_table_size
;
4024 entry
= row_table
[i
];
4025 eassert (entry
|| verify_row_hash (row
));
4026 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4027 entry
= entry
->next
;
4031 entry
= row_entry_pool
+ row_entry_idx
++;
4033 entry
->old_uses
= entry
->new_uses
= 0;
4034 entry
->new_line_number
= 0;
4036 entry
->next
= row_table
[i
];
4037 row_table
[i
] = entry
;
4044 /* Try to reuse part of the current display of W by scrolling lines.
4045 HEADER_LINE_P means W has a header line.
4047 The algorithm is taken from Communications of the ACM, Apr78 "A
4048 Technique for Isolating Differences Between Files." It should take
4051 A short outline of the steps of the algorithm
4053 1. Skip lines equal at the start and end of both matrices.
4055 2. Enter rows in the current and desired matrix into a symbol
4056 table, counting how often they appear in both matrices.
4058 3. Rows that appear exactly once in both matrices serve as anchors,
4059 i.e. we assume that such lines are likely to have been moved.
4061 4. Starting from anchor lines, extend regions to be scrolled both
4062 forward and backward.
4066 -1 if all rows were found to be equal.
4067 0 to indicate that we did not scroll the display, or
4068 1 if we did scroll. */
4071 scrolling_window (struct window
*w
, bool header_line_p
)
4073 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4074 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4075 int yb
= window_text_bottom_y (w
);
4077 int j
, first_old
, first_new
, last_old
, last_new
;
4080 struct row_entry
*entry
;
4081 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4083 /* Skip over rows equal at the start. */
4084 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4086 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4087 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4091 && !d
->redraw_fringe_bitmaps_p
4093 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4094 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4095 && row_equal_p (c
, d
, 1))
4104 #ifdef HAVE_XWIDGETS
4105 //currently this is needed to detect xwidget movement reliably. or probably not.
4106 //printf("scrolling_window\n");
4110 /* Give up if some rows in the desired matrix are not enabled. */
4111 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4114 first_old
= first_new
= i
;
4116 /* Set last_new to the index + 1 of the row that reaches the
4117 bottom boundary in the desired matrix. Give up if we find a
4118 disabled row before we reach the bottom boundary. */
4120 while (i
< desired_matrix
->nrows
- 1)
4124 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4126 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4135 /* Set last_old to the index + 1 of the row that reaches the bottom
4136 boundary in the current matrix. We don't look at the enabled
4137 flag here because we plan to reuse part of the display even if
4138 other parts are disabled. */
4140 while (i
< current_matrix
->nrows
- 1)
4142 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4151 /* Skip over rows equal at the bottom. */
4154 while (i
- 1 > first_new
4155 && j
- 1 > first_old
4156 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4157 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4158 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4159 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4160 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4161 MATRIX_ROW (current_matrix
, j
- 1), 1))
4166 /* Nothing to do if all rows are equal. */
4167 if (last_new
== first_new
)
4170 /* Check for integer overflow in size calculation.
4172 If next_almost_prime checks (N) for divisibility by 2..10, then
4173 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4174 So, set next_almost_prime_increment_max to 10.
4176 It's just a coincidence that next_almost_prime_increment_max ==
4177 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4178 13, then next_almost_prime_increment_max would be 14, e.g.,
4179 because next_almost_prime (113) would be 127. */
4181 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4182 enum { next_almost_prime_increment_max
= 10 };
4183 ptrdiff_t row_table_max
=
4184 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4185 - next_almost_prime_increment_max
);
4186 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4187 if (current_nrows_max
< current_matrix
->nrows
)
4188 memory_full (SIZE_MAX
);
4191 /* Reallocate vectors, tables etc. if necessary. */
4193 if (current_matrix
->nrows
> old_lines_size
)
4194 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4195 current_matrix
->nrows
- old_lines_size
,
4196 INT_MAX
, sizeof *old_lines
);
4198 if (desired_matrix
->nrows
> new_lines_size
)
4199 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4200 desired_matrix
->nrows
- new_lines_size
,
4201 INT_MAX
, sizeof *new_lines
);
4203 n
= desired_matrix
->nrows
;
4204 n
+= current_matrix
->nrows
;
4205 if (row_table_size
< 3 * n
)
4207 ptrdiff_t size
= next_almost_prime (3 * n
);
4208 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4209 row_table_size
= size
;
4210 memset (row_table
, 0, size
* sizeof *row_table
);
4213 if (n
> row_entry_pool_size
)
4214 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4215 n
- row_entry_pool_size
,
4216 -1, sizeof *row_entry_pool
);
4218 if (desired_matrix
->nrows
> runs_size
)
4220 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4221 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4222 runs_size
= desired_matrix
->nrows
;
4225 nruns
= run_idx
= 0;
4228 /* Add rows from the current and desired matrix to the hash table
4229 row_hash_table to be able to find equal ones quickly. */
4231 for (i
= first_old
; i
< last_old
; ++i
)
4233 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4235 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4236 old_lines
[i
] = entry
;
4240 old_lines
[i
] = NULL
;
4243 for (i
= first_new
; i
< last_new
; ++i
)
4245 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4246 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4248 entry
->new_line_number
= i
;
4249 new_lines
[i
] = entry
;
4252 /* Identify moves based on lines that are unique and equal
4253 in both matrices. */
4254 for (i
= first_old
; i
< last_old
;)
4256 && old_lines
[i
]->old_uses
== 1
4257 && old_lines
[i
]->new_uses
== 1)
4260 int new_line
= old_lines
[i
]->new_line_number
;
4261 struct run
*run
= run_pool
+ run_idx
++;
4264 run
->current_vpos
= i
;
4265 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4266 run
->desired_vpos
= new_line
;
4267 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4269 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4271 /* Extend backward. */
4274 while (p
> first_old
4276 && old_lines
[p
] == new_lines
[q
])
4278 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4279 --run
->current_vpos
;
4280 --run
->desired_vpos
;
4283 run
->desired_y
-= h
;
4284 run
->current_y
-= h
;
4288 /* Extend forward. */
4293 && old_lines
[p
] == new_lines
[q
])
4295 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4301 /* Insert run into list of all runs. Order runs by copied
4302 pixel lines. Note that we record runs that don't have to
4303 be copied because they are already in place. This is done
4304 because we can avoid calling update_window_line in this
4306 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4308 for (q
= nruns
; q
> p
; --q
)
4309 runs
[q
] = runs
[q
- 1];
4318 /* Do the moves. Do it in a way that we don't overwrite something
4319 we want to copy later on. This is not solvable in general
4320 because there is only one display and we don't have a way to
4321 exchange areas on this display. Example:
4323 +-----------+ +-----------+
4325 +-----------+ --> +-----------+
4327 +-----------+ +-----------+
4329 Instead, prefer bigger moves, and invalidate moves that would
4330 copy from where we copied to. */
4332 for (i
= 0; i
< nruns
; ++i
)
4333 if (runs
[i
]->nrows
> 0)
4335 struct run
*r
= runs
[i
];
4337 /* Copy on the display. */
4338 if (r
->current_y
!= r
->desired_y
)
4340 rif
->clear_window_mouse_face (w
);
4341 rif
->scroll_run_hook (w
, r
);
4344 /* Truncate runs that copy to where we copied to, and
4345 invalidate runs that copy from where we copied to. */
4346 for (j
= nruns
- 1; j
> i
; --j
)
4348 struct run
*p
= runs
[j
];
4349 bool truncated_p
= 0;
4352 && p
->desired_y
< r
->desired_y
+ r
->height
4353 && p
->desired_y
+ p
->height
> r
->desired_y
)
4355 if (p
->desired_y
< r
->desired_y
)
4357 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4358 p
->height
= r
->desired_y
- p
->desired_y
;
4363 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4366 if (p
->nrows
<= nrows_copied
)
4370 int height_copied
= (r
->desired_y
+ r
->height
4373 p
->current_vpos
+= nrows_copied
;
4374 p
->desired_vpos
+= nrows_copied
;
4375 p
->nrows
-= nrows_copied
;
4376 p
->current_y
+= height_copied
;
4377 p
->desired_y
+= height_copied
;
4378 p
->height
-= height_copied
;
4384 if (r
->current_y
!= r
->desired_y
4385 /* The condition below is equivalent to
4386 ((p->current_y >= r->desired_y
4387 && p->current_y < r->desired_y + r->height)
4388 || (p->current_y + p->height > r->desired_y
4389 && (p->current_y + p->height
4390 <= r->desired_y + r->height)))
4391 because we have 0 < p->height <= r->height. */
4392 && p
->current_y
< r
->desired_y
+ r
->height
4393 && p
->current_y
+ p
->height
> r
->desired_y
)
4396 /* Reorder runs by copied pixel lines if truncated. */
4397 if (truncated_p
&& p
->nrows
> 0)
4401 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4403 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4408 /* Assign matrix rows. */
4409 for (j
= 0; j
< r
->nrows
; ++j
)
4411 struct glyph_row
*from
, *to
;
4412 bool to_overlapped_p
;
4414 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4415 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4416 to_overlapped_p
= to
->overlapped_p
;
4417 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4418 assign_row (to
, from
);
4419 /* The above `assign_row' actually does swap, so if we had
4420 an overlap in the copy destination of two runs, then
4421 the second run would assign a previously disabled bogus
4422 row. But thanks to the truncation code in the
4423 preceding for-loop, we no longer have such an overlap,
4424 and thus the assigned row should always be enabled. */
4425 eassert (to
->enabled_p
);
4426 from
->enabled_p
= 0;
4427 to
->overlapped_p
= to_overlapped_p
;
4431 /* Clear the hash table, for the next time. */
4432 for (i
= 0; i
< row_entry_idx
; ++i
)
4433 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4435 /* Value is 1 to indicate that we scrolled the display. */
4441 /************************************************************************
4443 ************************************************************************/
4445 /* Update the desired frame matrix of frame F.
4447 FORCE_P means that the update should not be stopped by pending input.
4448 INHIBIT_HAIRY_ID_P means that scrolling should not be tried.
4450 Value is true if update was stopped due to pending input. */
4453 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
)
4455 /* Frame matrices to work on. */
4456 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4457 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4460 int preempt_count
= baud_rate
/ 2400 + 1;
4462 eassert (current_matrix
&& desired_matrix
);
4464 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4465 calculate_costs (f
);
4467 if (preempt_count
<= 0)
4470 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4476 /* If we cannot insert/delete lines, it's no use trying it. */
4477 if (!FRAME_LINE_INS_DEL_OK (f
))
4480 /* See if any of the desired lines are enabled; don't compute for
4481 i/d line if just want cursor motion. */
4482 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4483 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4486 /* Try doing i/d line, if not yet inhibited. */
4487 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4488 force_p
|= scrolling (f
);
4490 /* Update the individual lines as needed. Do bottom line first. */
4491 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4492 update_frame_line (f
, desired_matrix
->nrows
- 1);
4494 /* Now update the rest of the lines. */
4495 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4497 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4499 if (FRAME_TERMCAP_P (f
))
4501 /* Flush out every so many lines.
4502 Also flush out if likely to have more than 1k buffered
4503 otherwise. I'm told that some telnet connections get
4504 really screwed by more than 1k output at once. */
4505 FILE *display_output
= FRAME_TTY (f
)->output
;
4508 ptrdiff_t outq
= __fpending (display_output
);
4510 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4511 fflush (display_output
);
4515 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4516 detect_input_pending_ignore_squeezables ();
4518 update_frame_line (f
, i
);
4522 lint_assume (0 <= FRAME_LINES (f
));
4523 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4525 /* Now just clean up termcap drivers and set cursor, etc. */
4528 if ((cursor_in_echo_area
4529 /* If we are showing a message instead of the mini-buffer,
4530 show the cursor for the message instead of for the
4531 (now hidden) mini-buffer contents. */
4532 || (EQ (minibuf_window
, selected_window
)
4533 && EQ (minibuf_window
, echo_area_window
)
4534 && !NILP (echo_area_buffer
[0])))
4535 /* These cases apply only to the frame that contains
4536 the active mini-buffer window. */
4537 && FRAME_HAS_MINIBUF_P (f
)
4538 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4540 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4543 if (cursor_in_echo_area
< 0)
4545 /* Negative value of cursor_in_echo_area means put
4546 cursor at beginning of line. */
4552 /* Positive value of cursor_in_echo_area means put
4553 cursor at the end of the prompt. If the mini-buffer
4554 is several lines high, find the last line that has
4556 row
= FRAME_LINES (f
);
4562 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4564 /* Frame rows are filled up with spaces that
4565 must be ignored here. */
4566 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4568 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4569 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4572 && (last
- 1)->charpos
< 0)
4578 while (row
> top
&& col
== 0);
4580 /* Make sure COL is not out of range. */
4581 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4583 /* If we have another row, advance cursor into it. */
4584 if (row
< FRAME_LINES (f
) - 1)
4586 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4589 /* Otherwise move it back in range. */
4591 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4595 cursor_to (f
, row
, col
);
4599 /* We have only one cursor on terminal frames. Use it to
4600 display the cursor of the selected window. */
4601 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4602 if (w
->cursor
.vpos
>= 0
4603 /* The cursor vpos may be temporarily out of bounds
4604 in the following situation: There is one window,
4605 with the cursor in the lower half of it. The window
4606 is split, and a message causes a redisplay before
4607 a new cursor position has been computed. */
4608 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4610 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4611 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4613 if (INTEGERP (w
->left_margin_cols
))
4614 x
+= XFASTINT (w
->left_margin_cols
);
4616 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4617 cursor_to (f
, y
, x
);
4624 clear_desired_matrices (f
);
4629 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4632 scrolling (struct frame
*frame
)
4634 int unchanged_at_top
, unchanged_at_bottom
;
4637 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4638 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4639 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4640 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4642 int free_at_end_vpos
= FRAME_LINES (frame
);
4643 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4644 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4646 if (!current_matrix
)
4649 /* Compute hash codes of all the lines. Also calculate number of
4650 changed lines, number of unchanged lines at the beginning, and
4651 number of unchanged lines at the end. */
4653 unchanged_at_top
= 0;
4654 unchanged_at_bottom
= FRAME_LINES (frame
);
4655 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4657 /* Give up on this scrolling if some old lines are not enabled. */
4658 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4660 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4661 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4663 /* This line cannot be redrawn, so don't let scrolling mess it. */
4664 new_hash
[i
] = old_hash
[i
];
4665 #define INFINITY 1000000 /* Taken from scroll.c */
4666 draw_cost
[i
] = INFINITY
;
4670 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4671 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4674 if (old_hash
[i
] != new_hash
[i
])
4677 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4679 else if (i
== unchanged_at_top
)
4681 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4684 /* If changed lines are few, don't allow preemption, don't scroll. */
4685 if ((!FRAME_SCROLL_REGION_OK (frame
)
4686 && changed_lines
< baud_rate
/ 2400)
4687 || unchanged_at_bottom
== FRAME_LINES (frame
))
4690 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4691 - unchanged_at_bottom
);
4693 if (FRAME_SCROLL_REGION_OK (frame
))
4694 free_at_end_vpos
-= unchanged_at_bottom
;
4695 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4696 free_at_end_vpos
= -1;
4698 /* If large window, fast terminal and few lines in common between
4699 current frame and desired frame, don't bother with i/d calc. */
4700 if (!FRAME_SCROLL_REGION_OK (frame
)
4701 && window_size
>= 18 && baud_rate
> 2400
4703 10 * scrolling_max_lines_saved (unchanged_at_top
,
4704 FRAME_LINES (frame
) - unchanged_at_bottom
,
4705 old_hash
, new_hash
, draw_cost
)))
4708 if (window_size
< 2)
4711 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4712 draw_cost
+ unchanged_at_top
- 1,
4713 old_draw_cost
+ unchanged_at_top
- 1,
4714 old_hash
+ unchanged_at_top
- 1,
4715 new_hash
+ unchanged_at_top
- 1,
4716 free_at_end_vpos
- unchanged_at_top
);
4722 /* Count the number of blanks at the start of the vector of glyphs R
4723 which is LEN glyphs long. */
4726 count_blanks (struct glyph
*r
, int len
)
4730 for (i
= 0; i
< len
; ++i
)
4731 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4738 /* Count the number of glyphs in common at the start of the glyph
4739 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4740 of STR2. Value is the number of equal glyphs equal at the start. */
4743 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4745 struct glyph
*p1
= str1
;
4746 struct glyph
*p2
= str2
;
4750 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4757 /* Char insertion/deletion cost vector, from term.c */
4759 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4762 /* Perform a frame-based update on line VPOS in frame FRAME. */
4765 update_frame_line (struct frame
*f
, int vpos
)
4767 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4769 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4770 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4771 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4772 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4773 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4774 bool must_write_whole_line_p
;
4775 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4776 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4777 != FACE_TTY_DEFAULT_BG_COLOR
);
4779 if (colored_spaces_p
)
4782 /* Current row not enabled means it has unknown contents. We must
4783 write the whole desired line in that case. */
4784 must_write_whole_line_p
= !current_row
->enabled_p
;
4785 if (must_write_whole_line_p
)
4792 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4793 olen
= current_row
->used
[TEXT_AREA
];
4795 /* Ignore trailing spaces, if we can. */
4796 if (!write_spaces_p
)
4797 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4801 current_row
->enabled_p
= 1;
4802 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4804 /* If desired line is empty, just clear the line. */
4805 if (!desired_row
->enabled_p
)
4811 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4812 nlen
= desired_row
->used
[TEXT_AREA
];
4813 nend
= nbody
+ nlen
;
4815 /* If display line has unknown contents, write the whole line. */
4816 if (must_write_whole_line_p
)
4818 /* Ignore spaces at the end, if we can. */
4819 if (!write_spaces_p
)
4820 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4823 /* Write the contents of the desired line. */
4826 cursor_to (f
, vpos
, 0);
4827 write_glyphs (f
, nbody
, nlen
);
4830 /* Don't call clear_end_of_line if we already wrote the whole
4831 line. The cursor will not be at the right margin in that
4832 case but in the line below. */
4833 if (nlen
< FRAME_TOTAL_COLS (f
))
4835 cursor_to (f
, vpos
, nlen
);
4836 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4839 /* Make sure we are in the right row, otherwise cursor movement
4840 with cmgoto might use `ch' in the wrong row. */
4841 cursor_to (f
, vpos
, 0);
4843 make_current (desired_matrix
, current_matrix
, vpos
);
4847 /* Pretend trailing spaces are not there at all,
4848 unless for one reason or another we must write all spaces. */
4849 if (!write_spaces_p
)
4850 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4853 /* If there's no i/d char, quickly do the best we can without it. */
4854 if (!FRAME_CHAR_INS_DEL_OK (f
))
4858 /* Find the first glyph in desired row that doesn't agree with
4859 a glyph in the current row, and write the rest from there on. */
4860 for (i
= 0; i
< nlen
; i
++)
4862 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4864 /* Find the end of the run of different glyphs. */
4868 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4869 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4872 /* Output this run of non-matching chars. */
4873 cursor_to (f
, vpos
, i
);
4874 write_glyphs (f
, nbody
+ i
, j
- i
);
4877 /* Now find the next non-match. */
4881 /* Clear the rest of the line, or the non-clear part of it. */
4884 cursor_to (f
, vpos
, nlen
);
4885 clear_end_of_line (f
, olen
);
4888 /* Make current row = desired row. */
4889 make_current (desired_matrix
, current_matrix
, vpos
);
4893 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4894 characters in a row. */
4898 /* If current line is blank, skip over initial spaces, if
4899 possible, and write the rest. */
4903 nsp
= count_blanks (nbody
, nlen
);
4907 cursor_to (f
, vpos
, nsp
);
4908 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4911 /* Exchange contents between current_frame and new_frame. */
4912 make_current (desired_matrix
, current_matrix
, vpos
);
4916 /* Compute number of leading blanks in old and new contents. */
4917 osp
= count_blanks (obody
, olen
);
4918 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4920 /* Compute number of matching chars starting with first non-blank. */
4921 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4922 nbody
+ nsp
, nbody
+ nlen
);
4924 /* Spaces in new match implicit space past the end of old. */
4925 /* A bug causing this to be a no-op was fixed in 18.29. */
4926 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4929 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4933 /* Avoid doing insert/delete char
4934 just cause number of leading spaces differs
4935 when the following text does not match. */
4936 if (begmatch
== 0 && osp
!= nsp
)
4937 osp
= nsp
= min (osp
, nsp
);
4939 /* Find matching characters at end of line */
4942 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4944 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4949 endmatch
= obody
+ olen
- op1
;
4951 /* tem gets the distance to insert or delete.
4952 endmatch is how many characters we save by doing so.
4955 tem
= (nlen
- nsp
) - (olen
- osp
);
4957 && (!FRAME_CHAR_INS_DEL_OK (f
)
4958 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4961 /* nsp - osp is the distance to insert or delete.
4962 If that is nonzero, begmatch is known to be nonzero also.
4963 begmatch + endmatch is how much we save by doing the ins/del.
4967 && (!FRAME_CHAR_INS_DEL_OK (f
)
4968 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4972 osp
= nsp
= min (osp
, nsp
);
4975 /* Now go through the line, inserting, writing and
4976 deleting as appropriate. */
4980 cursor_to (f
, vpos
, nsp
);
4981 delete_glyphs (f
, osp
- nsp
);
4985 /* If going to delete chars later in line
4986 and insert earlier in the line,
4987 must delete first to avoid losing data in the insert */
4988 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
4990 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
4991 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
4992 olen
= nlen
- (nsp
- osp
);
4994 cursor_to (f
, vpos
, osp
);
4995 insert_glyphs (f
, 0, nsp
- osp
);
4999 tem
= nsp
+ begmatch
+ endmatch
;
5000 if (nlen
!= tem
|| olen
!= tem
)
5002 if (!endmatch
|| nlen
== olen
)
5004 /* If new text being written reaches right margin, there is
5005 no need to do clear-to-eol at the end of this function
5006 (and it would not be safe, since cursor is not going to
5007 be "at the margin" after the text is done). */
5008 if (nlen
== FRAME_TOTAL_COLS (f
))
5011 /* Function write_glyphs is prepared to do nothing
5012 if passed a length <= 0. Check it here to avoid
5013 unnecessary cursor movement. */
5016 cursor_to (f
, vpos
, nsp
+ begmatch
);
5017 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5020 else if (nlen
> olen
)
5022 /* Here, we used to have the following simple code:
5023 ----------------------------------------
5024 write_glyphs (nbody + nsp + begmatch, olen - tem);
5025 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5026 ----------------------------------------
5027 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5028 is a padding glyph. */
5029 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5032 cursor_to (f
, vpos
, nsp
+ begmatch
);
5034 /* Calculate columns we can actually overwrite. */
5035 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5037 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5039 /* If we left columns to be overwritten, we must delete them. */
5040 del
= olen
- tem
- out
;
5042 delete_glyphs (f
, del
);
5044 /* At last, we insert columns not yet written out. */
5045 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5048 else if (olen
> nlen
)
5050 cursor_to (f
, vpos
, nsp
+ begmatch
);
5051 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5052 delete_glyphs (f
, olen
- nlen
);
5058 /* If any unerased characters remain after the new line, erase them. */
5061 cursor_to (f
, vpos
, nlen
);
5062 clear_end_of_line (f
, olen
);
5065 /* Exchange contents between current_frame and new_frame. */
5066 make_current (desired_matrix
, current_matrix
, vpos
);
5071 /***********************************************************************
5072 X/Y Position -> Buffer Position
5073 ***********************************************************************/
5075 /* Determine what's under window-relative pixel position (*X, *Y).
5076 Return the OBJECT (string or buffer) that's there.
5077 Return in *POS the position in that object.
5078 Adjust *X and *Y to character positions.
5079 Return in *DX and *DY the pixel coordinates of the click,
5080 relative to the top left corner of OBJECT, or relative to
5081 the top left corner of the character glyph at (*X, *Y)
5083 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5084 if the coordinates point to an empty area of the display. */
5087 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
)
5090 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5091 struct text_pos startp
;
5093 struct glyph_row
*row
;
5094 #ifdef HAVE_WINDOW_SYSTEM
5095 struct image
*img
= 0;
5098 void *itdata
= NULL
;
5100 /* We used to set current_buffer directly here, but that does the
5101 wrong thing with `face-remapping-alist' (bug#2044). */
5102 Fset_buffer (w
->contents
);
5103 itdata
= bidi_shelve_cache ();
5104 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5105 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5106 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5107 start_display (&it
, w
, startp
);
5108 /* start_display takes into account the header-line row, but IT's
5109 vpos still counts from the glyph row that includes the window's
5110 start position. Adjust for a possible header-line row. */
5111 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5115 /* First, move to the beginning of the row corresponding to *Y. We
5116 need to be in that row to get the correct value of base paragraph
5117 direction for the text at (*X, *Y). */
5118 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5120 /* TO_X is the pixel position that the iterator will compute for the
5121 glyph at *X. We add it.first_visible_x because iterator
5122 positions include the hscroll. */
5123 to_x
= x0
+ it
.first_visible_x
;
5124 if (it
.bidi_it
.paragraph_dir
== R2L
)
5125 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5126 text area. This is because the iterator, even in R2L
5127 paragraphs, delivers glyphs as if they started at the left
5128 margin of the window. (When we actually produce glyphs for
5129 display, we reverse their order in PRODUCE_GLYPHS, but the
5130 iterator doesn't know about that.) The following line adjusts
5131 the pixel position to the iterator geometry, which is what
5132 move_it_* routines use. (The -1 is because in a window whose
5133 text-area width is W, the rightmost pixel position is W-1, and
5134 it should be mirrored into zero pixel position.) */
5135 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5137 /* Now move horizontally in the row to the glyph under *X. Second
5138 argument is ZV to prevent move_it_in_display_line from matching
5139 based on buffer positions. */
5140 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5141 bidi_unshelve_cache (itdata
, 0);
5143 Fset_buffer (old_current_buffer
);
5145 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5146 *dy
= *y
- it
.current_y
;
5148 string
= w
->contents
;
5149 if (STRINGP (it
.string
))
5152 if (it
.what
== IT_COMPOSITION
5153 && it
.cmp_it
.nchars
> 1
5154 && it
.cmp_it
.reversed_p
)
5156 /* The current display element is a grapheme cluster in a
5157 composition. In that case, we need the position of the first
5158 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5159 it.current points to the last character of the cluster, thus
5160 we must move back to the first character of the same
5162 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5163 if (STRINGP (it
.string
))
5164 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5166 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5167 CHARPOS (pos
->pos
));
5170 #ifdef HAVE_WINDOW_SYSTEM
5171 if (it
.what
== IT_IMAGE
)
5173 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5174 && !NILP (img
->spec
))
5175 *object
= img
->spec
;
5179 if (it
.vpos
< w
->current_matrix
->nrows
5180 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5183 if (it
.hpos
< row
->used
[TEXT_AREA
])
5185 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5186 #ifdef HAVE_WINDOW_SYSTEM
5189 *dy
-= row
->ascent
- glyph
->ascent
;
5190 *dx
+= glyph
->slice
.img
.x
;
5191 *dy
+= glyph
->slice
.img
.y
;
5192 /* Image slices positions are still relative to the entire image */
5193 *width
= img
->width
;
5194 *height
= img
->height
;
5199 *width
= glyph
->pixel_width
;
5200 *height
= glyph
->ascent
+ glyph
->descent
;
5206 *height
= row
->height
;
5211 *width
= *height
= 0;
5214 /* Add extra (default width) columns if clicked after EOL. */
5215 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5217 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5226 /* Value is the string under window-relative coordinates X/Y in the
5227 mode line or header line (PART says which) of window W, or nil if none.
5228 *CHARPOS is set to the position in the string returned. */
5231 mode_line_string (struct window
*w
, enum window_part part
,
5232 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5233 int *dx
, int *dy
, int *width
, int *height
)
5235 struct glyph_row
*row
;
5236 struct glyph
*glyph
, *end
;
5238 Lisp_Object string
= Qnil
;
5240 if (part
== ON_MODE_LINE
)
5241 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5243 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5245 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5247 if (row
->mode_line_p
&& row
->enabled_p
)
5249 /* Find the glyph under X. If we find one with a string object,
5250 it's the one we were looking for. */
5251 glyph
= row
->glyphs
[TEXT_AREA
];
5252 end
= glyph
+ row
->used
[TEXT_AREA
];
5253 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5254 x0
-= glyph
->pixel_width
;
5255 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5258 string
= glyph
->object
;
5259 *charpos
= glyph
->charpos
;
5260 *width
= glyph
->pixel_width
;
5261 *height
= glyph
->ascent
+ glyph
->descent
;
5262 #ifdef HAVE_WINDOW_SYSTEM
5263 if (glyph
->type
== IMAGE_GLYPH
)
5266 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5268 *object
= img
->spec
;
5269 y0
-= row
->ascent
- glyph
->ascent
;
5275 /* Add extra (default width) columns if clicked after EOL. */
5276 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5278 *height
= row
->height
;
5285 *width
= *height
= 0;
5295 /* Value is the string under window-relative coordinates X/Y in either
5296 marginal area, or nil if none. *CHARPOS is set to the position in
5297 the string returned. */
5300 marginal_area_string (struct window
*w
, enum window_part part
,
5301 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5302 int *dx
, int *dy
, int *width
, int *height
)
5304 struct glyph_row
*row
= w
->current_matrix
->rows
;
5305 struct glyph
*glyph
, *end
;
5306 int x0
, y0
, i
, wy
= *y
;
5308 Lisp_Object string
= Qnil
;
5310 if (part
== ON_LEFT_MARGIN
)
5311 area
= LEFT_MARGIN_AREA
;
5312 else if (part
== ON_RIGHT_MARGIN
)
5313 area
= RIGHT_MARGIN_AREA
;
5317 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5318 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5321 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5325 /* Find the glyph under X. If we find one with a string object,
5326 it's the one we were looking for. */
5327 if (area
== RIGHT_MARGIN_AREA
)
5328 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5329 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5330 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5331 + window_box_width (w
, LEFT_MARGIN_AREA
)
5332 + window_box_width (w
, TEXT_AREA
));
5334 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5335 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5338 glyph
= row
->glyphs
[area
];
5339 end
= glyph
+ row
->used
[area
];
5340 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5341 x0
-= glyph
->pixel_width
;
5342 *x
= glyph
- row
->glyphs
[area
];
5345 string
= glyph
->object
;
5346 *charpos
= glyph
->charpos
;
5347 *width
= glyph
->pixel_width
;
5348 *height
= glyph
->ascent
+ glyph
->descent
;
5349 #ifdef HAVE_WINDOW_SYSTEM
5350 if (glyph
->type
== IMAGE_GLYPH
)
5353 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5355 *object
= img
->spec
;
5356 y0
-= row
->ascent
- glyph
->ascent
;
5357 x0
+= glyph
->slice
.img
.x
;
5358 y0
+= glyph
->slice
.img
.y
;
5364 /* Add extra (default width) columns if clicked after EOL. */
5365 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5367 *height
= row
->height
;
5374 *width
= *height
= 0;
5384 /***********************************************************************
5385 Changing Frame Sizes
5386 ***********************************************************************/
5390 static void deliver_window_change_signal (int);
5393 handle_window_change_signal (int sig
)
5396 struct tty_display_info
*tty
;
5398 /* The frame size change obviously applies to a single
5399 termcap-controlled terminal, but we can't decide which.
5400 Therefore, we resize the frames corresponding to each tty.
5402 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5404 if (! tty
->term_initted
)
5407 /* Suspended tty frames have tty->input == NULL avoid trying to
5412 get_tty_size (fileno (tty
->input
), &width
, &height
);
5414 if (width
> 5 && height
> 2) {
5415 Lisp_Object tail
, frame
;
5417 FOR_EACH_FRAME (tail
, frame
)
5418 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5419 /* Record the new sizes, but don't reallocate the data
5420 structures now. Let that be done later outside of the
5422 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5428 deliver_window_change_signal (int sig
)
5430 deliver_process_signal (sig
, handle_window_change_signal
);
5432 #endif /* SIGWINCH */
5435 /* Do any change in frame size that was requested by a signal.
5436 SAFE means this function is called from a place where it is
5437 safe to change frame sizes while a redisplay is in progress. */
5440 do_pending_window_change (bool safe
)
5442 /* If window change signal handler should have run before, run it now. */
5443 if (redisplaying_p
&& !safe
)
5446 while (delayed_size_change
)
5448 Lisp_Object tail
, frame
;
5450 delayed_size_change
= 0;
5452 FOR_EACH_FRAME (tail
, frame
)
5454 struct frame
*f
= XFRAME (frame
);
5456 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5457 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5464 /* Change the frame height and/or width. Values may be given as zero to
5465 indicate no change is to take place.
5467 If DELAY, assume we're being called from a signal handler, and
5468 queue the change for later - perhaps the next redisplay.
5469 Since this tries to resize windows, we can't call it
5470 from a signal handler.
5472 SAFE means this function is called from a place where it's
5473 safe to change frame sizes while a redisplay is in progress. */
5476 change_frame_size (struct frame
*f
, int newheight
, int newwidth
,
5477 bool pretend
, bool delay
, bool safe
)
5479 Lisp_Object tail
, frame
;
5481 if (FRAME_MSDOS_P (f
))
5483 /* On MS-DOS, all frames use the same screen, so a change in
5484 size affects all frames. Termcap now supports multiple
5486 FOR_EACH_FRAME (tail
, frame
)
5487 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5488 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5489 pretend
, delay
, safe
);
5492 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5496 change_frame_size_1 (struct frame
*f
, int newheight
, int newwidth
,
5497 bool pretend
, bool delay
, bool safe
)
5499 int new_frame_total_cols
;
5500 ptrdiff_t count
= SPECPDL_INDEX ();
5502 /* If we can't deal with the change now, queue it for later. */
5503 if (delay
|| (redisplaying_p
&& !safe
))
5505 f
->new_text_lines
= newheight
;
5506 f
->new_text_cols
= newwidth
;
5507 delayed_size_change
= 1;
5511 /* This size-change overrides any pending one for this frame. */
5512 f
->new_text_lines
= 0;
5513 f
->new_text_cols
= 0;
5515 /* If an argument is zero, set it to the current value. */
5517 newheight
= FRAME_LINES (f
);
5519 newwidth
= FRAME_COLS (f
);
5521 /* Compute width of windows in F. */
5522 /* Round up to the smallest acceptable size. */
5523 check_frame_size (f
, &newheight
, &newwidth
);
5525 /* This is the width of the frame with vertical scroll bars and fringe
5526 columns. Do this after rounding - see discussion of bug#9723. */
5527 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5529 /* If we're not changing the frame size, quit now. */
5530 /* Frame width may be unchanged but the text portion may change, for
5531 example, fullscreen and remove/add scroll bar. */
5532 if (newheight
== FRAME_LINES (f
)
5533 /* Text portion unchanged? */
5534 && newwidth
== FRAME_COLS (f
)
5535 /* Frame width unchanged? */
5536 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5542 /* We only can set screen dimensions to certain values supported
5543 by our video hardware. Try to find the smallest size greater
5544 or equal to the requested dimensions. */
5545 dos_set_window_size (&newheight
, &newwidth
);
5548 if (newheight
!= FRAME_LINES (f
))
5550 resize_frame_windows (f
, newheight
, 0);
5552 /* MSDOS frames cannot PRETEND, as they change frame size by
5553 manipulating video hardware. */
5554 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5555 FrameRows (FRAME_TTY (f
)) = newheight
;
5558 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5560 resize_frame_windows (f
, new_frame_total_cols
, 1);
5562 /* MSDOS frames cannot PRETEND, as they change frame size by
5563 manipulating video hardware. */
5564 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5565 FrameCols (FRAME_TTY (f
)) = newwidth
;
5567 if (WINDOWP (f
->tool_bar_window
))
5568 XWINDOW (f
->tool_bar_window
)->total_cols
= newwidth
;
5571 FRAME_LINES (f
) = newheight
;
5572 SET_FRAME_COLS (f
, newwidth
);
5575 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5576 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5578 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5580 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5581 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5582 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5583 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5587 calculate_costs (f
);
5588 SET_FRAME_GARBAGED (f
);
5593 record_unwind_current_buffer ();
5595 run_window_configuration_change_hook (f
);
5597 unbind_to (count
, Qnil
);
5602 /***********************************************************************
5603 Terminal Related Lisp Functions
5604 ***********************************************************************/
5606 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5607 1, 1, "FOpen termscript file: ",
5608 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5609 FILE = nil means just close any termscript file currently open. */)
5612 struct tty_display_info
*tty
;
5614 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5615 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5616 error ("Current frame is not on a tty device");
5620 if (tty
->termscript
!= 0)
5623 fclose (tty
->termscript
);
5624 tty
->termscript
= 0;
5630 file
= Fexpand_file_name (file
, Qnil
);
5631 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5632 if (tty
->termscript
== 0)
5633 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5639 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5640 Ssend_string_to_terminal
, 1, 2, 0,
5641 doc
: /* Send STRING to the terminal without alteration.
5642 Control characters in STRING will have terminal-dependent effects.
5644 Optional parameter TERMINAL specifies the tty terminal device to use.
5645 It may be a terminal object, a frame, or nil for the terminal used by
5646 the currently selected frame. In batch mode, STRING is sent to stdout
5647 when TERMINAL is nil. */)
5648 (Lisp_Object string
, Lisp_Object terminal
)
5650 struct terminal
*t
= get_terminal (terminal
, 1);
5653 /* ??? Perhaps we should do something special for multibyte strings here. */
5654 CHECK_STRING (string
);
5658 error ("Unknown terminal device");
5660 if (t
->type
== output_initial
)
5662 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5663 error ("Device %d is not a termcap terminal device", t
->id
);
5666 struct tty_display_info
*tty
= t
->display_info
.tty
;
5669 error ("Terminal is currently suspended");
5671 if (tty
->termscript
)
5673 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5674 fflush (tty
->termscript
);
5678 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5685 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5686 doc
: /* Beep, or flash the screen.
5687 Also, unless an argument is given,
5688 terminate any keyboard macro currently executing. */)
5696 ring_bell (XFRAME (selected_frame
));
5705 bitch_at_user (void)
5709 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5712 = "Keyboard macro terminated by a command ringing the bell";
5713 Fsignal (Quser_error
, Fcons (build_string (msg
), Qnil
));
5716 ring_bell (XFRAME (selected_frame
));
5721 /***********************************************************************
5723 ***********************************************************************/
5725 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5726 doc
: /* Pause, without updating display, for SECONDS seconds.
5727 SECONDS may be a floating-point value, meaning that you can wait for a
5728 fraction of a second. Optional second arg MILLISECONDS specifies an
5729 additional wait period, in milliseconds; this is for backwards compatibility.
5730 \(Not all operating systems support waiting for a fraction of a second.) */)
5731 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5733 double duration
= extract_float (seconds
);
5735 if (!NILP (milliseconds
))
5737 CHECK_NUMBER (milliseconds
);
5738 duration
+= XINT (milliseconds
) / 1000.0;
5743 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5744 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5745 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5752 /* This is just like wait_reading_process_output, except that
5755 TIMEOUT is number of seconds to wait (float or integer),
5756 or t to wait forever.
5757 READING is true if reading input.
5758 If DISPLAY_OPTION is >0 display process output while waiting.
5759 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5763 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5767 bool do_display
= display_option
> 0;
5769 swallow_events (do_display
);
5771 if ((detect_input_pending_run_timers (do_display
))
5772 || !NILP (Vexecuting_kbd_macro
))
5775 if (display_option
> 1)
5776 redisplay_preserve_echo_area (2);
5778 if (INTEGERP (timeout
))
5780 sec
= XINT (timeout
);
5785 else if (FLOATP (timeout
))
5787 double seconds
= XFLOAT_DATA (timeout
);
5788 if (! (0 < seconds
))
5792 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5793 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5794 nsec
= EMACS_NSECS (t
);
5797 else if (EQ (timeout
, Qt
))
5803 wrong_type_argument (Qnumberp
, timeout
);
5810 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5813 return detect_input_pending () ? Qnil
: Qt
;
5817 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5818 doc
: /* Perform redisplay.
5819 Optional arg FORCE, if non-nil, prevents redisplay from being
5820 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5821 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5822 preempted by arriving input, so FORCE does nothing.
5824 Return t if redisplay was performed, nil if redisplay was preempted
5825 immediately by pending input. */)
5831 if ((detect_input_pending_run_timers (1)
5832 && NILP (force
) && !redisplay_dont_pause
)
5833 || !NILP (Vexecuting_kbd_macro
))
5836 count
= SPECPDL_INDEX ();
5837 if (!NILP (force
) && !redisplay_dont_pause
)
5838 specbind (Qredisplay_dont_pause
, Qt
);
5839 redisplay_preserve_echo_area (2);
5840 unbind_to (count
, Qnil
);
5846 /***********************************************************************
5847 Other Lisp Functions
5848 ***********************************************************************/
5850 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5851 session's frames, frame names, buffers, buffer-read-only flags, and
5852 buffer-modified-flags. */
5854 static Lisp_Object frame_and_buffer_state
;
5857 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5858 Sframe_or_buffer_changed_p
, 0, 1, 0,
5859 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5860 VARIABLE is a variable name whose value is either nil or a state vector
5861 that will be updated to contain all frames and buffers,
5862 aside from buffers whose names start with space,
5863 along with the buffers' read-only and modified flags. This allows a fast
5864 check to see whether buffer menus might need to be recomputed.
5865 If this function returns non-nil, it updates the internal vector to reflect
5868 If VARIABLE is nil, an internal variable is used. Users should not
5869 pass nil for VARIABLE. */)
5870 (Lisp_Object variable
)
5872 Lisp_Object state
, tail
, frame
, buf
;
5875 if (! NILP (variable
))
5877 CHECK_SYMBOL (variable
);
5878 state
= Fsymbol_value (variable
);
5879 if (! VECTORP (state
))
5883 state
= frame_and_buffer_state
;
5886 FOR_EACH_FRAME (tail
, frame
)
5888 if (idx
== ASIZE (state
))
5890 if (!EQ (AREF (state
, idx
++), frame
))
5892 if (idx
== ASIZE (state
))
5894 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5897 /* Check that the buffer info matches. */
5898 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5900 buf
= XCDR (XCAR (tail
));
5901 /* Ignore buffers that aren't included in buffer lists. */
5902 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5904 if (idx
== ASIZE (state
))
5906 if (!EQ (AREF (state
, idx
++), buf
))
5908 if (idx
== ASIZE (state
))
5910 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5912 if (idx
== ASIZE (state
))
5914 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5917 if (idx
== ASIZE (state
))
5919 /* Detect deletion of a buffer at the end of the list. */
5920 if (EQ (AREF (state
, idx
), Qlambda
))
5923 /* Come here if we decide the data has changed. */
5925 /* Count the size we will need.
5926 Start with 1 so there is room for at least one lambda at the end. */
5928 FOR_EACH_FRAME (tail
, frame
)
5930 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5932 /* Reallocate the vector if data has grown to need it,
5933 or if it has shrunk a lot. */
5934 if (! VECTORP (state
)
5935 || n
> ASIZE (state
)
5936 || n
+ 20 < ASIZE (state
) / 2)
5937 /* Add 20 extra so we grow it less often. */
5939 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5940 if (! NILP (variable
))
5941 Fset (variable
, state
);
5943 frame_and_buffer_state
= state
;
5946 /* Record the new data in the (possibly reallocated) vector. */
5948 FOR_EACH_FRAME (tail
, frame
)
5950 ASET (state
, idx
, frame
);
5952 ASET (state
, idx
, XFRAME (frame
)->name
);
5955 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5957 buf
= XCDR (XCAR (tail
));
5958 /* Ignore buffers that aren't included in buffer lists. */
5959 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5961 ASET (state
, idx
, buf
);
5963 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5965 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5968 /* Fill up the vector with lambdas (always at least one). */
5969 ASET (state
, idx
, Qlambda
);
5971 while (idx
< ASIZE (state
))
5973 ASET (state
, idx
, Qlambda
);
5976 /* Make sure we didn't overflow the vector. */
5977 eassert (idx
<= ASIZE (state
));
5983 /***********************************************************************
5985 ***********************************************************************/
5987 /* Initialization done when Emacs fork is started, before doing stty.
5988 Determine terminal type and set terminal_driver. Then invoke its
5989 decoding routine to set up variables in the terminal package. */
5994 char *terminal_type
;
5996 /* Construct the space glyph. */
5997 space_glyph
.type
= CHAR_GLYPH
;
5998 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5999 space_glyph
.charpos
= -1;
6002 cursor_in_echo_area
= 0;
6004 /* Now is the time to initialize this; it's used by init_sys_modes
6006 Vinitial_window_system
= Qnil
;
6008 /* SIGWINCH needs to be handled no matter what display we start
6009 with. Otherwise newly opened tty frames will not resize
6014 #endif /* CANNOT_DUMP */
6016 struct sigaction action
;
6017 emacs_sigaction_init (&action
, deliver_window_change_signal
);
6018 sigaction (SIGWINCH
, &action
, 0);
6020 #endif /* SIGWINCH */
6022 /* If running as a daemon, no need to initialize any frames/terminal. */
6026 /* If the user wants to use a window system, we shouldn't bother
6027 initializing the terminal. This is especially important when the
6028 terminal is so dumb that emacs gives up before and doesn't bother
6029 using the window system.
6031 If the DISPLAY environment variable is set and nonempty,
6032 try to use X, and die with an error message if that doesn't work. */
6034 #ifdef HAVE_X_WINDOWS
6035 if (! inhibit_window_system
&& ! display_arg
)
6038 display
= getenv ("DISPLAY");
6039 display_arg
= (display
!= 0 && *display
!= 0);
6041 if (display_arg
&& !x_display_ok (display
))
6043 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6045 inhibit_window_system
= 1;
6049 if (!inhibit_window_system
&& display_arg
)
6051 Vinitial_window_system
= Qx
;
6053 Vwindow_system_version
= make_number (11);
6056 /* In some versions of ncurses,
6057 tputs crashes if we have not called tgetent.
6059 { char b
[2044]; tgetent (b
, "xterm");}
6063 #endif /* HAVE_X_WINDOWS */
6066 if (!inhibit_window_system
)
6068 Vinitial_window_system
= Qw32
;
6069 Vwindow_system_version
= make_number (1);
6072 #endif /* HAVE_NTGUI */
6075 if (!inhibit_window_system
6081 Vinitial_window_system
= Qns
;
6082 Vwindow_system_version
= make_number (10);
6087 /* If no window system has been specified, try to use the terminal. */
6089 fatal ("standard input is not a tty");
6092 terminal_type
= "w32console";
6094 terminal_type
= getenv ("TERM");
6098 #ifdef HAVE_WINDOW_SYSTEM
6099 if (! inhibit_window_system
)
6100 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6102 #endif /* HAVE_WINDOW_SYSTEM */
6103 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6109 struct frame
*f
= XFRAME (selected_frame
);
6111 init_foreground_group ();
6113 /* Open a display on the controlling tty. */
6114 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6116 /* Convert the initial frame to use the new display. */
6117 if (f
->output_method
!= output_initial
)
6119 f
->output_method
= t
->type
;
6122 t
->reference_count
++;
6124 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6126 if (f
->output_method
== output_termcap
)
6127 create_tty_output (f
);
6129 t
->display_info
.tty
->top_frame
= selected_frame
;
6130 change_frame_size (XFRAME (selected_frame
),
6131 FrameRows (t
->display_info
.tty
),
6132 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6134 /* Delete the initial terminal. */
6135 if (--initial_terminal
->reference_count
== 0
6136 && initial_terminal
->delete_terminal_hook
)
6137 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6139 /* Update frame parameters to reflect the new type. */
6140 Fmodify_frame_parameters
6141 (selected_frame
, Fcons (Fcons (Qtty_type
,
6142 Ftty_type (selected_frame
)), Qnil
));
6143 if (t
->display_info
.tty
->name
)
6144 Fmodify_frame_parameters (selected_frame
,
6145 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6148 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6153 struct frame
*sf
= SELECTED_FRAME ();
6154 int width
= FRAME_TOTAL_COLS (sf
);
6155 int height
= FRAME_LINES (sf
);
6157 /* If these sizes are so big they cause overflow, just ignore the
6158 change. It's not clear what better we could do. The rest of
6159 the code assumes that (width + 2) * height * sizeof (struct glyph)
6160 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6161 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6162 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6163 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6164 < (width
+ 2) * height
))
6165 fatal ("screen size %dx%d too big", width
, height
);
6168 calculate_costs (XFRAME (selected_frame
));
6170 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6173 && NILP (Vinitial_window_system
))
6175 /* For the initial frame, we don't have any way of knowing what
6176 are the foreground and background colors of the terminal. */
6177 struct frame
*sf
= SELECTED_FRAME ();
6179 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6180 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6181 call0 (intern ("tty-set-up-initial-frame-faces"));
6187 /***********************************************************************
6189 ***********************************************************************/
6191 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6192 Sinternal_show_cursor
, 2, 2, 0,
6193 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6194 WINDOW nil means use the selected window. SHOW non-nil means
6195 show a cursor in WINDOW in the next redisplay. SHOW nil means
6196 don't show a cursor. */)
6197 (Lisp_Object window
, Lisp_Object show
)
6199 /* Don't change cursor state while redisplaying. This could confuse
6201 if (!redisplaying_p
)
6202 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6207 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6208 Sinternal_show_cursor_p
, 0, 1, 0,
6209 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6210 WINDOW nil or omitted means report on the selected window. */)
6211 (Lisp_Object window
)
6213 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6216 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6217 Slast_nonminibuf_frame
, 0, 0, 0,
6218 doc
: /* Value is last nonminibuffer frame. */)
6221 Lisp_Object frame
= Qnil
;
6223 if (last_nonminibuf_frame
)
6224 XSETFRAME (frame
, last_nonminibuf_frame
);
6229 /***********************************************************************
6231 ***********************************************************************/
6234 syms_of_display (void)
6236 defsubr (&Sredraw_frame
);
6237 defsubr (&Sredraw_display
);
6238 defsubr (&Sframe_or_buffer_changed_p
);
6239 defsubr (&Sopen_termscript
);
6241 defsubr (&Sredisplay
);
6242 defsubr (&Ssleep_for
);
6243 defsubr (&Ssend_string_to_terminal
);
6244 defsubr (&Sinternal_show_cursor
);
6245 defsubr (&Sinternal_show_cursor_p
);
6246 defsubr (&Slast_nonminibuf_frame
);
6249 defsubr (&Sdump_redisplay_history
);
6252 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6253 staticpro (&frame_and_buffer_state
);
6255 DEFSYM (Qdisplay_table
, "display-table");
6256 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6258 DEFVAR_INT ("baud-rate", baud_rate
,
6259 doc
: /* The output baud rate of the terminal.
6260 On most systems, changing this value will affect the amount of padding
6261 and the other strategic decisions made during redisplay. */);
6263 DEFVAR_BOOL ("inverse-video", inverse_video
,
6264 doc
: /* Non-nil means invert the entire frame display.
6265 This means everything is in inverse video which otherwise would not be. */);
6267 DEFVAR_BOOL ("visible-bell", visible_bell
,
6268 doc
: /* Non-nil means try to flash the frame to represent a bell.
6270 See also `ring-bell-function'. */);
6272 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6273 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6274 A non-nil value is useful if the terminal can automatically preserve
6275 Emacs's frame display when you reenter Emacs.
6276 It is up to you to set this variable if your terminal can do that. */);
6278 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6279 doc
: /* Name of the window system that Emacs uses for the first frame.
6280 The value is a symbol:
6281 nil for a termcap frame (a character-only terminal),
6282 'x' for an Emacs frame that is really an X window,
6283 'w32' for an Emacs frame that is a window on MS-Windows display,
6284 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6285 'pc' for a direct-write MS-DOS frame.
6287 Use of this variable as a boolean is deprecated. Instead,
6288 use `display-graphic-p' or any of the other `display-*-p'
6289 predicates which report frame's specific UI-related capabilities. */);
6291 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6292 doc
: /* Name of window system through which the selected frame is displayed.
6293 The value is a symbol:
6294 nil for a termcap frame (a character-only terminal),
6295 'x' for an Emacs frame that is really an X window,
6296 'w32' for an Emacs frame that is a window on MS-Windows display,
6297 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6298 'pc' for a direct-write MS-DOS frame.
6300 Use of this variable as a boolean is deprecated. Instead,
6301 use `display-graphic-p' or any of the other `display-*-p'
6302 predicates which report frame's specific UI-related capabilities. */);
6304 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6305 doc
: /* The version number of the window system in use.
6306 For X windows, this is 11. */);
6308 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6309 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6311 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6312 doc
: /* Table defining how to output a glyph code to the frame.
6313 If not nil, this is a vector indexed by glyph code to define the glyph.
6314 Each element can be:
6315 integer: a glyph code which this glyph is an alias for.
6316 string: output this glyph using that string (not impl. in X windows).
6317 nil: this glyph mod 524288 is the code of a character to output,
6318 and this glyph / 524288 is the face number (see `face-id') to use
6319 while outputting it. */);
6320 Vglyph_table
= Qnil
;
6322 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6323 doc
: /* Display table to use for buffers that specify none.
6324 See `buffer-display-table' for more information. */);
6325 Vstandard_display_table
= Qnil
;
6327 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6328 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6329 redisplay_dont_pause
= 1;
6335 Vinitial_window_system
= Qnil
;
6336 Vwindow_system_version
= Qnil
;