1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 /* cm.h must come after dispextern.h on Windows. */
30 #include "dispextern.h"
33 #include "character.h"
36 #include "termhooks.h"
41 #include "intervals.h"
42 #include "blockinput.h"
45 #include "syssignal.h"
49 #endif /* HAVE_X_WINDOWS */
53 #endif /* HAVE_NTGUI */
59 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
64 /* Get number of chars of output now in the buffer of a stdio stream.
65 This ought to be built in in stdio, but it isn't. Some s- files
66 override this because their stdio internals differ. */
68 #ifdef __GNU_LIBRARY__
70 /* The s- file might have overridden the definition with one that
71 works for the system's C library. But we are using the GNU C
72 library, so this is the right definition for every system. */
74 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
75 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
77 #undef PENDING_OUTPUT_COUNT
78 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
80 #else /* not __GNU_LIBRARY__ */
81 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
82 #include <stdio_ext.h>
83 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
85 #ifndef PENDING_OUTPUT_COUNT
86 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
88 #endif /* not __GNU_LIBRARY__ */
90 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
91 #include <term.h> /* for tgetent */
94 /* Structure to pass dimensions around. Used for character bounding
95 boxes, glyph matrix dimensions and alike. */
104 /* Function prototypes. */
106 static struct glyph_matrix
*save_current_matrix (struct frame
*);
107 static void restore_current_matrix (struct frame
*, struct glyph_matrix
*);
108 static int showing_window_margins_p (struct window
*);
109 static void fake_current_matrices (Lisp_Object
);
110 static void redraw_overlapping_rows (struct window
*, int);
111 static void redraw_overlapped_rows (struct window
*, int);
112 static int count_blanks (struct glyph
*, int);
113 static int count_match (struct glyph
*, struct glyph
*,
114 struct glyph
*, struct glyph
*);
115 static unsigned line_draw_cost (struct glyph_matrix
*, int);
116 static void update_frame_line (struct frame
*, int);
117 static struct dim allocate_matrices_for_frame_redisplay
118 (Lisp_Object
, int, int, int, int *);
119 static int required_matrix_height (struct window
*);
120 static int required_matrix_width (struct window
*);
121 static void allocate_matrices_for_window_redisplay (struct window
*);
122 static int realloc_glyph_pool (struct glyph_pool
*, struct dim
);
123 static void adjust_frame_glyphs (struct frame
*);
124 static struct glyph_matrix
*new_glyph_matrix (struct glyph_pool
*);
125 static void free_glyph_matrix (struct glyph_matrix
*);
126 static void adjust_glyph_matrix (struct window
*, struct glyph_matrix
*,
127 int, int, struct dim
);
128 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
129 static void increment_row_positions (struct glyph_row
*, EMACS_INT
, EMACS_INT
);
130 static void swap_glyph_pointers (struct glyph_row
*, struct glyph_row
*);
132 static int glyph_row_slice_p (struct glyph_row
*, struct glyph_row
*);
134 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
135 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
137 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
139 static struct glyph_pool
*new_glyph_pool (void);
140 static void free_glyph_pool (struct glyph_pool
*);
141 static void adjust_frame_glyphs_initially (void);
142 static void adjust_frame_message_buffer (struct frame
*);
143 static void adjust_decode_mode_spec_buffer (struct frame
*);
144 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
145 static void build_frame_matrix (struct frame
*);
146 void clear_current_matrices (struct frame
*);
147 void scroll_glyph_matrix_range (struct glyph_matrix
*, int, int,
149 static void clear_window_matrices (struct window
*, int);
150 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
151 static int scrolling_window (struct window
*, int);
152 static int update_window_line (struct window
*, int, int *);
153 static void update_marginal_area (struct window
*, int, int);
154 static int update_text_area (struct window
*, int);
155 static void make_current (struct glyph_matrix
*, struct glyph_matrix
*,
157 static void mirror_make_current (struct window
*, int);
158 void check_window_matrix_pointers (struct window
*);
160 static void check_matrix_pointers (struct glyph_matrix
*,
161 struct glyph_matrix
*);
163 static void mirror_line_dance (struct window
*, int, int, int *, char *);
164 static int update_window_tree (struct window
*, int);
165 static int update_window (struct window
*, int);
166 static int update_frame_1 (struct frame
*, int, int);
167 static int scrolling (struct frame
*);
168 static void set_window_cursor_after_update (struct window
*);
169 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
170 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
173 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
174 are supported, so we can check for input during redisplay at
175 regular intervals. */
176 #ifdef EMACS_HAS_USECS
177 #define PERIODIC_PREEMPTION_CHECKING 1
179 #define PERIODIC_PREEMPTION_CHECKING 0
182 #if PERIODIC_PREEMPTION_CHECKING
184 /* Redisplay preemption timers. */
186 static EMACS_TIME preemption_period
;
187 static EMACS_TIME preemption_next_check
;
191 /* Nonzero upon entry to redisplay means do not assume anything about
192 current contents of actual terminal frame; clear and redraw it. */
196 /* Nonzero means last display completed. Zero means it was preempted. */
198 int display_completed
;
200 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
203 /* The currently selected frame. In a single-frame version, this
204 variable always equals the_only_frame. */
206 Lisp_Object selected_frame
;
208 /* A frame which is not just a mini-buffer, or 0 if there are no such
209 frames. This is usually the most recent such frame that was
210 selected. In a single-frame version, this variable always holds
211 the address of the_only_frame. */
213 struct frame
*last_nonminibuf_frame
;
215 /* 1 means SIGWINCH happened when not safe. */
217 static int delayed_size_change
;
219 /* 1 means glyph initialization has been completed at startup. */
221 static int glyphs_initialized_initially_p
;
223 /* Updated window if != 0. Set by update_window. */
225 struct window
*updated_window
;
227 /* Glyph row updated in update_window_line, and area that is updated. */
229 struct glyph_row
*updated_row
;
232 /* A glyph for a space. */
234 struct glyph space_glyph
;
236 /* Counts of allocated structures. These counts serve to diagnose
237 memory leaks and double frees. */
239 static int glyph_matrix_count
;
240 static int glyph_pool_count
;
242 /* If non-null, the frame whose frame matrices are manipulated. If
243 null, window matrices are worked on. */
245 static struct frame
*frame_matrix_frame
;
247 /* Non-zero means that fonts have been loaded since the last glyph
248 matrix adjustments. Redisplay must stop, and glyph matrices must
249 be adjusted when this flag becomes non-zero during display. The
250 reason fonts can be loaded so late is that fonts of fontsets are
251 loaded on demand. Another reason is that a line contains many
252 characters displayed by zero width or very narrow glyphs of
253 variable-width fonts. */
257 /* Convert vpos and hpos from frame to window and vice versa.
258 This may only be used for terminal frames. */
262 static int window_to_frame_vpos (struct window
*, int);
263 static int window_to_frame_hpos (struct window
*, int);
264 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
265 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
267 /* One element of the ring buffer containing redisplay history
270 struct redisplay_history
272 char trace
[512 + 100];
275 /* The size of the history buffer. */
277 #define REDISPLAY_HISTORY_SIZE 30
279 /* The redisplay history buffer. */
281 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
283 /* Next free entry in redisplay_history. */
285 static int history_idx
;
287 /* A tick that's incremented each time something is added to the
290 static unsigned history_tick
;
292 static void add_frame_display_history (struct frame
*, int);
293 static void add_window_display_history (struct window
*, char *, int);
295 /* Add to the redisplay history how window W has been displayed.
296 MSG is a trace containing the information how W's glyph matrix
297 has been constructed. PAUSED_P non-zero means that the update
298 has been interrupted for pending input. */
301 add_window_display_history (struct window
*w
, char *msg
, int paused_p
)
305 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
307 buf
= redisplay_history
[history_idx
].trace
;
310 sprintf (buf
, "%d: window %p (`%s')%s\n",
313 ((BUFFERP (w
->buffer
)
314 && STRINGP (XBUFFER (w
->buffer
)->name
))
315 ? SSDATA (XBUFFER (w
->buffer
)->name
)
317 paused_p
? " ***paused***" : "");
322 /* Add to the redisplay history that frame F has been displayed.
323 PAUSED_P non-zero means that the update has been interrupted for
327 add_frame_display_history (struct frame
*f
, int paused_p
)
331 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
333 buf
= redisplay_history
[history_idx
].trace
;
336 sprintf (buf
, "%d: update frame %p%s",
338 f
, paused_p
? " ***paused***" : "");
342 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
343 Sdump_redisplay_history
, 0, 0, "",
344 doc
: /* Dump redisplay history to stderr. */)
349 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
352 i
= REDISPLAY_HISTORY_SIZE
- 1;
353 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
360 #else /* GLYPH_DEBUG == 0 */
362 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
363 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
365 #endif /* GLYPH_DEBUG == 0 */
368 #if defined PROFILING && !HAVE___EXECUTABLE_START
369 /* FIXME: only used to find text start for profiling. */
372 safe_bcopy (const char *from
, char *to
, int size
)
378 /***********************************************************************
380 ***********************************************************************/
382 /* Allocate and return a glyph_matrix structure. POOL is the glyph
383 pool from which memory for the matrix should be allocated, or null
384 for window-based redisplay where no glyph pools are used. The
385 member `pool' of the glyph matrix structure returned is set to
386 POOL, the structure is otherwise zeroed. */
388 static struct glyph_matrix
*
389 new_glyph_matrix (struct glyph_pool
*pool
)
391 struct glyph_matrix
*result
;
393 /* Allocate and clear. */
394 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
395 memset (result
, 0, sizeof *result
);
397 /* Increment number of allocated matrices. This count is used
398 to detect memory leaks. */
399 ++glyph_matrix_count
;
401 /* Set pool and return. */
407 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
409 The global counter glyph_matrix_count is decremented when a matrix
410 is freed. If the count gets negative, more structures were freed
411 than allocated, i.e. one matrix was freed more than once or a bogus
412 pointer was passed to this function.
414 If MATRIX->pool is null, this means that the matrix manages its own
415 glyph memory---this is done for matrices on X frames. Freeing the
416 matrix also frees the glyph memory in this case. */
419 free_glyph_matrix (struct glyph_matrix
*matrix
)
425 /* Detect the case that more matrices are freed than were
427 if (--glyph_matrix_count
< 0)
430 /* Free glyph memory if MATRIX owns it. */
431 if (matrix
->pool
== NULL
)
432 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
433 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
435 /* Free row structures and the matrix itself. */
436 xfree (matrix
->rows
);
442 /* Return the number of glyphs to reserve for a marginal area of
443 window W. TOTAL_GLYPHS is the number of glyphs in a complete
444 display line of window W. MARGIN gives the width of the marginal
445 area in canonical character units. MARGIN should be an integer
449 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
453 if (NUMBERP (margin
))
455 int width
= XFASTINT (w
->total_cols
);
456 double d
= max (0, XFLOATINT (margin
));
457 d
= min (width
/ 2 - 1, d
);
458 n
= (int) ((double) total_glyphs
/ width
* d
);
467 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
470 W is null if the function is called for a frame glyph matrix.
471 Otherwise it is the window MATRIX is a member of. X and Y are the
472 indices of the first column and row of MATRIX within the frame
473 matrix, if such a matrix exists. They are zero for purely
474 window-based redisplay. DIM is the needed size of the matrix.
476 In window-based redisplay, where no frame matrices exist, glyph
477 matrices manage their own glyph storage. Otherwise, they allocate
478 storage from a common frame glyph pool which can be found in
481 The reason for this memory management strategy is to avoid complete
482 frame redraws if possible. When we allocate from a common pool, a
483 change of the location or size of a sub-matrix within the pool
484 requires a complete redisplay of the frame because we cannot easily
485 make sure that the current matrices of all windows still agree with
486 what is displayed on the screen. While this is usually fast, it
487 leads to screen flickering. */
490 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
494 int marginal_areas_changed_p
= 0;
495 int header_line_changed_p
= 0;
496 int header_line_p
= 0;
497 int left
= -1, right
= -1;
498 int window_width
= -1, window_height
= -1;
500 /* See if W had a header line that has disappeared now, or vice versa.
504 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
506 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
507 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
509 matrix
->header_line_p
= header_line_p
;
511 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
512 Do nothing if MATRIX' size, position, vscroll, and marginal areas
513 haven't changed. This optimization is important because preserving
514 the matrix means preventing redisplay. */
515 if (matrix
->pool
== NULL
)
517 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
518 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
519 xassert (left
>= 0 && right
>= 0);
520 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
521 || right
!= matrix
->right_margin_glyphs
);
523 if (!marginal_areas_changed_p
525 && !header_line_changed_p
526 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
527 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
528 && matrix
->window_height
== window_height
529 && matrix
->window_vscroll
== w
->vscroll
530 && matrix
->window_width
== window_width
)
534 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
535 if (matrix
->rows_allocated
< dim
.height
)
537 int size
= dim
.height
* sizeof (struct glyph_row
);
538 new_rows
= dim
.height
- matrix
->rows_allocated
;
539 matrix
->rows
= (struct glyph_row
*) xrealloc (matrix
->rows
, size
);
540 memset (matrix
->rows
+ matrix
->rows_allocated
, 0,
541 new_rows
* sizeof *matrix
->rows
);
542 matrix
->rows_allocated
= dim
.height
;
547 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
548 on a frame not using window-based redisplay. Set up pointers for
549 each row into the glyph pool. */
552 xassert (matrix
->pool
->glyphs
);
556 left
= margin_glyphs_to_reserve (w
, dim
.width
,
557 w
->left_margin_cols
);
558 right
= margin_glyphs_to_reserve (w
, dim
.width
,
559 w
->right_margin_cols
);
564 for (i
= 0; i
< dim
.height
; ++i
)
566 struct glyph_row
*row
= &matrix
->rows
[i
];
568 row
->glyphs
[LEFT_MARGIN_AREA
]
569 = (matrix
->pool
->glyphs
570 + (y
+ i
) * matrix
->pool
->ncolumns
574 || row
== matrix
->rows
+ dim
.height
- 1
575 || (row
== matrix
->rows
&& matrix
->header_line_p
))
577 row
->glyphs
[TEXT_AREA
]
578 = row
->glyphs
[LEFT_MARGIN_AREA
];
579 row
->glyphs
[RIGHT_MARGIN_AREA
]
580 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
581 row
->glyphs
[LAST_AREA
]
582 = row
->glyphs
[RIGHT_MARGIN_AREA
];
586 row
->glyphs
[TEXT_AREA
]
587 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
588 row
->glyphs
[RIGHT_MARGIN_AREA
]
589 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
590 row
->glyphs
[LAST_AREA
]
591 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
595 matrix
->left_margin_glyphs
= left
;
596 matrix
->right_margin_glyphs
= right
;
600 /* If MATRIX->pool is null, MATRIX is responsible for managing
601 its own memory. It is a window matrix for window-based redisplay.
602 Allocate glyph memory from the heap. */
603 if (dim
.width
> matrix
->matrix_w
605 || header_line_changed_p
606 || marginal_areas_changed_p
)
608 struct glyph_row
*row
= matrix
->rows
;
609 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
613 row
->glyphs
[LEFT_MARGIN_AREA
]
614 = (struct glyph
*) xrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
616 * sizeof (struct glyph
)));
618 /* The mode line never has marginal areas. */
619 if (row
== matrix
->rows
+ dim
.height
- 1
620 || (row
== matrix
->rows
&& matrix
->header_line_p
))
622 row
->glyphs
[TEXT_AREA
]
623 = row
->glyphs
[LEFT_MARGIN_AREA
];
624 row
->glyphs
[RIGHT_MARGIN_AREA
]
625 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
626 row
->glyphs
[LAST_AREA
]
627 = row
->glyphs
[RIGHT_MARGIN_AREA
];
631 row
->glyphs
[TEXT_AREA
]
632 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
633 row
->glyphs
[RIGHT_MARGIN_AREA
]
634 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
635 row
->glyphs
[LAST_AREA
]
636 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
642 xassert (left
>= 0 && right
>= 0);
643 matrix
->left_margin_glyphs
= left
;
644 matrix
->right_margin_glyphs
= right
;
647 /* Number of rows to be used by MATRIX. */
648 matrix
->nrows
= dim
.height
;
649 xassert (matrix
->nrows
>= 0);
653 if (matrix
== w
->current_matrix
)
655 /* Mark rows in a current matrix of a window as not having
656 valid contents. It's important to not do this for
657 desired matrices. When Emacs starts, it may already be
658 building desired matrices when this function runs. */
659 if (window_width
< 0)
660 window_width
= window_box_width (w
, -1);
662 /* Optimize the case that only the height has changed (C-x 2,
663 upper window). Invalidate all rows that are no longer part
665 if (!marginal_areas_changed_p
666 && !header_line_changed_p
668 && dim
.width
== matrix
->matrix_w
669 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
670 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
671 && matrix
->window_width
== window_width
)
673 /* Find the last row in the window. */
674 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
675 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
681 /* Window end is invalid, if inside of the rows that
682 are invalidated below. */
683 if (INTEGERP (w
->window_end_vpos
)
684 && XFASTINT (w
->window_end_vpos
) >= i
)
685 w
->window_end_valid
= Qnil
;
687 while (i
< matrix
->nrows
)
688 matrix
->rows
[i
++].enabled_p
= 0;
692 for (i
= 0; i
< matrix
->nrows
; ++i
)
693 matrix
->rows
[i
].enabled_p
= 0;
696 else if (matrix
== w
->desired_matrix
)
698 /* Rows in desired matrices always have to be cleared;
699 redisplay expects this is the case when it runs, so it
700 had better be the case when we adjust matrices between
702 for (i
= 0; i
< matrix
->nrows
; ++i
)
703 matrix
->rows
[i
].enabled_p
= 0;
708 /* Remember last values to be able to optimize frame redraws. */
709 matrix
->matrix_x
= x
;
710 matrix
->matrix_y
= y
;
711 matrix
->matrix_w
= dim
.width
;
712 matrix
->matrix_h
= dim
.height
;
714 /* Record the top y location and height of W at the time the matrix
715 was last adjusted. This is used to optimize redisplay above. */
718 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
719 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
720 matrix
->window_height
= window_height
;
721 matrix
->window_width
= window_width
;
722 matrix
->window_vscroll
= w
->vscroll
;
727 /* Reverse the contents of rows in MATRIX between START and END. The
728 contents of the row at END - 1 end up at START, END - 2 at START +
729 1 etc. This is part of the implementation of rotate_matrix (see
733 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
737 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
739 /* Non-ISO HP/UX compiler doesn't like auto struct
741 struct glyph_row temp
;
742 temp
= matrix
->rows
[i
];
743 matrix
->rows
[i
] = matrix
->rows
[j
];
744 matrix
->rows
[j
] = temp
;
749 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
750 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
751 indices. (Note: this does not copy glyphs, only glyph pointers in
752 row structures are moved around).
754 The algorithm used for rotating the vector was, I believe, first
755 described by Kernighan. See the vector R as consisting of two
756 sub-vectors AB, where A has length BY for BY >= 0. The result
757 after rotating is then BA. Reverse both sub-vectors to get ArBr
758 and reverse the result to get (ArBr)r which is BA. Similar for
762 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
766 /* Up (rotate left, i.e. towards lower indices). */
768 reverse_rows (matrix
, first
, first
+ by
);
769 reverse_rows (matrix
, first
+ by
, last
);
770 reverse_rows (matrix
, first
, last
);
774 /* Down (rotate right, i.e. towards higher indices). */
775 reverse_rows (matrix
, last
- by
, last
);
776 reverse_rows (matrix
, first
, last
- by
);
777 reverse_rows (matrix
, first
, last
);
782 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
783 with indices START <= index < END. Increment positions by DELTA/
787 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
788 EMACS_INT delta
, EMACS_INT delta_bytes
)
790 /* Check that START and END are reasonable values. */
791 xassert (start
>= 0 && start
<= matrix
->nrows
);
792 xassert (end
>= 0 && end
<= matrix
->nrows
);
793 xassert (start
<= end
);
795 for (; start
< end
; ++start
)
796 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
800 /* Enable a range of rows in glyph matrix MATRIX. START and END are
801 the row indices of the first and last + 1 row to enable. If
802 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
805 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
807 xassert (start
<= end
);
808 xassert (start
>= 0 && start
< matrix
->nrows
);
809 xassert (end
>= 0 && end
<= matrix
->nrows
);
811 for (; start
< end
; ++start
)
812 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
818 This empties all rows in MATRIX by setting the enabled_p flag for
819 all rows of the matrix to zero. The function prepare_desired_row
820 will eventually really clear a row when it sees one with a zero
823 Resets update hints to defaults value. The only update hint
824 currently present is the flag MATRIX->no_scrolling_p. */
827 clear_glyph_matrix (struct glyph_matrix
*matrix
)
831 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
832 matrix
->no_scrolling_p
= 0;
837 /* Shift part of the glyph matrix MATRIX of window W up or down.
838 Increment y-positions in glyph rows between START and END by DY,
839 and recompute their visible height. */
842 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
846 xassert (start
<= end
);
847 xassert (start
>= 0 && start
< matrix
->nrows
);
848 xassert (end
>= 0 && end
<= matrix
->nrows
);
850 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
851 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
853 for (; start
< end
; ++start
)
855 struct glyph_row
*row
= &matrix
->rows
[start
];
858 row
->visible_height
= row
->height
;
861 row
->visible_height
-= min_y
- row
->y
;
862 if (row
->y
+ row
->height
> max_y
)
863 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
868 /* Mark all rows in current matrices of frame F as invalid. Marking
869 invalid is done by setting enabled_p to zero for all rows in a
873 clear_current_matrices (register struct frame
*f
)
875 /* Clear frame current matrix, if we have one. */
876 if (f
->current_matrix
)
877 clear_glyph_matrix (f
->current_matrix
);
879 /* Clear the matrix of the menu bar window, if such a window exists.
880 The menu bar window is currently used to display menus on X when
881 no toolkit support is compiled in. */
882 if (WINDOWP (f
->menu_bar_window
))
883 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
885 /* Clear the matrix of the tool-bar window, if any. */
886 if (WINDOWP (f
->tool_bar_window
))
887 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
889 /* Clear current window matrices. */
890 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
891 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
895 /* Clear out all display lines of F for a coming redisplay. */
898 clear_desired_matrices (register struct frame
*f
)
900 if (f
->desired_matrix
)
901 clear_glyph_matrix (f
->desired_matrix
);
903 if (WINDOWP (f
->menu_bar_window
))
904 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
906 if (WINDOWP (f
->tool_bar_window
))
907 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
909 /* Do it for window matrices. */
910 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
911 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
915 /* Clear matrices in window tree rooted in W. If DESIRED_P is
916 non-zero clear desired matrices, otherwise clear current matrices. */
919 clear_window_matrices (struct window
*w
, int desired_p
)
923 if (!NILP (w
->hchild
))
925 xassert (WINDOWP (w
->hchild
));
926 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
928 else if (!NILP (w
->vchild
))
930 xassert (WINDOWP (w
->vchild
));
931 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
936 clear_glyph_matrix (w
->desired_matrix
);
939 clear_glyph_matrix (w
->current_matrix
);
940 w
->window_end_valid
= Qnil
;
944 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
950 /***********************************************************************
953 See dispextern.h for an overall explanation of glyph rows.
954 ***********************************************************************/
956 /* Clear glyph row ROW. Do it in a way that makes it robust against
957 changes in the glyph_row structure, i.e. addition or removal of
958 structure members. */
960 static struct glyph_row null_row
;
963 clear_glyph_row (struct glyph_row
*row
)
965 struct glyph
*p
[1 + LAST_AREA
];
968 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
969 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
970 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
971 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
976 /* Restore pointers. */
977 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
978 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
979 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
980 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
982 #if 0 /* At some point, some bit-fields of struct glyph were not set,
983 which made glyphs unequal when compared with GLYPH_EQUAL_P.
984 Redisplay outputs such glyphs, and flickering effects were
985 the result. This also depended on the contents of memory
986 returned by xmalloc. If flickering happens again, activate
987 the code below. If the flickering is gone with that, chances
988 are that the flickering has the same reason as here. */
989 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
994 /* Make ROW an empty, enabled row of canonical character height,
995 in window W starting at y-position Y. */
998 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
1002 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1003 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
1005 clear_glyph_row (row
);
1007 row
->ascent
= row
->phys_ascent
= 0;
1008 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
1009 row
->visible_height
= row
->height
;
1012 row
->visible_height
-= min_y
- row
->y
;
1013 if (row
->y
+ row
->height
> max_y
)
1014 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
1020 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1021 are the amounts by which to change positions. Note that the first
1022 glyph of the text area of a row can have a buffer position even if
1023 the used count of the text area is zero. Such rows display line
1027 increment_row_positions (struct glyph_row
*row
,
1028 EMACS_INT delta
, EMACS_INT delta_bytes
)
1032 /* Increment start and end positions. */
1033 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1034 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1035 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1036 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1037 CHARPOS (row
->start
.pos
) += delta
;
1038 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1039 CHARPOS (row
->end
.pos
) += delta
;
1040 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1042 if (!row
->enabled_p
)
1045 /* Increment positions in glyphs. */
1046 for (area
= 0; area
< LAST_AREA
; ++area
)
1047 for (i
= 0; i
< row
->used
[area
]; ++i
)
1048 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1049 && row
->glyphs
[area
][i
].charpos
> 0)
1050 row
->glyphs
[area
][i
].charpos
+= delta
;
1052 /* Capture the case of rows displaying a line end. */
1053 if (row
->used
[TEXT_AREA
] == 0
1054 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1055 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1060 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1061 contents, i.e. glyph structure contents are exchanged between A and
1062 B without changing glyph pointers in A and B. */
1065 swap_glyphs_in_rows (a
, b
)
1066 struct glyph_row
*a
, *b
;
1070 for (area
= 0; area
< LAST_AREA
; ++area
)
1072 /* Number of glyphs to swap. */
1073 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1075 /* Start of glyphs in area of row A. */
1076 struct glyph
*glyph_a
= a
->glyphs
[area
];
1078 /* End + 1 of glyphs in area of row A. */
1079 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1081 /* Start of glyphs in area of row B. */
1082 struct glyph
*glyph_b
= b
->glyphs
[area
];
1084 while (glyph_a
< glyph_a_end
)
1086 /* Non-ISO HP/UX compiler doesn't like auto struct
1090 *glyph_a
= *glyph_b
;
1100 /* Exchange pointers to glyph memory between glyph rows A and B. */
1103 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1106 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1108 struct glyph
*temp
= a
->glyphs
[i
];
1109 a
->glyphs
[i
] = b
->glyphs
[i
];
1110 b
->glyphs
[i
] = temp
;
1115 /* Copy glyph row structure FROM to glyph row structure TO, except
1116 that glyph pointers in the structures are left unchanged. */
1119 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1121 struct glyph
*pointers
[1 + LAST_AREA
];
1123 /* Save glyph pointers of TO. */
1124 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1126 /* Do a structure assignment. */
1129 /* Restore original pointers of TO. */
1130 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1134 /* Assign glyph row FROM to glyph row TO. This works like a structure
1135 assignment TO = FROM, except that glyph pointers are not copied but
1136 exchanged between TO and FROM. Pointers must be exchanged to avoid
1140 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1142 swap_glyph_pointers (to
, from
);
1143 copy_row_except_pointers (to
, from
);
1147 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1148 a row in a window matrix, is a slice of the glyph memory of the
1149 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1150 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1151 memory of FRAME_ROW. */
1156 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1158 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1159 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1160 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1162 return (frame_glyph_start
<= window_glyph_start
1163 && window_glyph_start
< frame_glyph_end
);
1166 #endif /* GLYPH_DEBUG */
1170 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1171 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1172 in WINDOW_MATRIX is found satisfying the condition. */
1174 static struct glyph_row
*
1175 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1176 struct glyph_matrix
*frame_matrix
, int row
)
1180 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1182 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1183 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1184 frame_matrix
->rows
+ row
))
1187 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1192 /* Prepare ROW for display. Desired rows are cleared lazily,
1193 i.e. they are only marked as to be cleared by setting their
1194 enabled_p flag to zero. When a row is to be displayed, a prior
1195 call to this function really clears it. */
1198 prepare_desired_row (struct glyph_row
*row
)
1200 if (!row
->enabled_p
)
1202 unsigned rp
= row
->reversed_p
;
1204 clear_glyph_row (row
);
1206 row
->reversed_p
= rp
;
1211 /* Return a hash code for glyph row ROW. */
1214 line_hash_code (struct glyph_row
*row
)
1220 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1221 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1225 int c
= glyph
->u
.ch
;
1226 int face_id
= glyph
->face_id
;
1227 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1229 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1230 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1242 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1243 the number of characters in the line. If must_write_spaces is
1244 zero, leading and trailing spaces are ignored. */
1247 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1249 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1250 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1251 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1253 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1254 int glyph_table_len
= GLYPH_TABLE_LENGTH
;
1256 /* Ignore trailing and leading spaces if we can. */
1257 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1259 /* Skip from the end over trailing spaces. */
1260 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1263 /* All blank line. */
1267 /* Skip over leading spaces. */
1268 while (CHAR_GLYPH_SPACE_P (*beg
))
1272 /* If we don't have a glyph-table, each glyph is one character,
1273 so return the number of glyphs. */
1274 if (glyph_table_base
== 0)
1278 /* Otherwise, scan the glyphs and accumulate their total length
1285 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1287 if (GLYPH_INVALID_P (g
)
1288 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1291 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1301 /* Test two glyph rows A and B for equality. Value is non-zero if A
1302 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1303 mouse_face_p flags of A and B, too. */
1306 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1310 else if (a
->hash
!= b
->hash
)
1314 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1317 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1320 /* Compare glyphs. */
1321 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1323 if (a
->used
[area
] != b
->used
[area
])
1326 a_glyph
= a
->glyphs
[area
];
1327 a_end
= a_glyph
+ a
->used
[area
];
1328 b_glyph
= b
->glyphs
[area
];
1330 while (a_glyph
< a_end
1331 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1332 ++a_glyph
, ++b_glyph
;
1334 if (a_glyph
!= a_end
)
1338 if (a
->fill_line_p
!= b
->fill_line_p
1339 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1340 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1341 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1342 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1343 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1344 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1345 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1346 || a
->overlapped_p
!= b
->overlapped_p
1347 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1348 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1349 || a
->reversed_p
!= b
->reversed_p
1350 /* Different partially visible characters on left margin. */
1352 /* Different height. */
1353 || a
->ascent
!= b
->ascent
1354 || a
->phys_ascent
!= b
->phys_ascent
1355 || a
->phys_height
!= b
->phys_height
1356 || a
->visible_height
!= b
->visible_height
)
1365 /***********************************************************************
1368 See dispextern.h for an overall explanation of glyph pools.
1369 ***********************************************************************/
1371 /* Allocate a glyph_pool structure. The structure returned is
1372 initialized with zeros. The global variable glyph_pool_count is
1373 incremented for each pool allocated. */
1375 static struct glyph_pool
*
1376 new_glyph_pool (void)
1378 struct glyph_pool
*result
;
1380 /* Allocate a new glyph_pool and clear it. */
1381 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1382 memset (result
, 0, sizeof *result
);
1384 /* For memory leak and double deletion checking. */
1391 /* Free a glyph_pool structure POOL. The function may be called with
1392 a null POOL pointer. The global variable glyph_pool_count is
1393 decremented with every pool structure freed. If this count gets
1394 negative, more structures were freed than allocated, i.e. one
1395 structure must have been freed more than once or a bogus pointer
1396 was passed to free_glyph_pool. */
1399 free_glyph_pool (struct glyph_pool
*pool
)
1403 /* More freed than allocated? */
1405 xassert (glyph_pool_count
>= 0);
1407 xfree (pool
->glyphs
);
1413 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1414 columns we need. This function never shrinks a pool. The only
1415 case in which this would make sense, would be when a frame's size
1416 is changed from a large value to a smaller one. But, if someone
1417 does it once, we can expect that he will do it again.
1419 Value is non-zero if the pool changed in a way which makes
1420 re-adjusting window glyph matrices necessary. */
1423 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1428 changed_p
= (pool
->glyphs
== 0
1429 || matrix_dim
.height
!= pool
->nrows
1430 || matrix_dim
.width
!= pool
->ncolumns
);
1432 /* Enlarge the glyph pool. */
1433 needed
= matrix_dim
.width
* matrix_dim
.height
;
1434 if (needed
> pool
->nglyphs
)
1436 int size
= needed
* sizeof (struct glyph
);
1440 pool
->glyphs
= (struct glyph
*) xrealloc (pool
->glyphs
, size
);
1441 memset (pool
->glyphs
+ pool
->nglyphs
, 0,
1442 size
- pool
->nglyphs
* sizeof (struct glyph
));
1446 pool
->glyphs
= (struct glyph
*) xmalloc (size
);
1447 memset (pool
->glyphs
, 0, size
);
1450 pool
->nglyphs
= needed
;
1453 /* Remember the number of rows and columns because (a) we use them
1454 to do sanity checks, and (b) the number of columns determines
1455 where rows in the frame matrix start---this must be available to
1456 determine pointers to rows of window sub-matrices. */
1457 pool
->nrows
= matrix_dim
.height
;
1458 pool
->ncolumns
= matrix_dim
.width
;
1465 /***********************************************************************
1467 ***********************************************************************/
1472 /* Flush standard output. This is sometimes useful to call from the debugger.
1473 XXX Maybe this should be changed to flush the current terminal instead of
1484 /* Check that no glyph pointers have been lost in MATRIX. If a
1485 pointer has been lost, e.g. by using a structure assignment between
1486 rows, at least one pointer must occur more than once in the rows of
1490 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1494 for (i
= 0; i
< matrix
->nrows
; ++i
)
1495 for (j
= 0; j
< matrix
->nrows
; ++j
)
1497 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1498 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1502 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1505 matrix_row (struct glyph_matrix
*matrix
, int row
)
1507 xassert (matrix
&& matrix
->rows
);
1508 xassert (row
>= 0 && row
< matrix
->nrows
);
1510 /* That's really too slow for normal testing because this function
1511 is called almost everywhere. Although---it's still astonishingly
1512 fast, so it is valuable to have for debugging purposes. */
1514 check_matrix_pointer_lossage (matrix
);
1517 return matrix
->rows
+ row
;
1521 #if 0 /* This function makes invalid assumptions when text is
1522 partially invisible. But it might come handy for debugging
1525 /* Check invariants that must hold for an up to date current matrix of
1529 check_matrix_invariants (struct window
*w
)
1531 struct glyph_matrix
*matrix
= w
->current_matrix
;
1532 int yb
= window_text_bottom_y (w
);
1533 struct glyph_row
*row
= matrix
->rows
;
1534 struct glyph_row
*last_text_row
= NULL
;
1535 struct buffer
*saved
= current_buffer
;
1536 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1539 /* This can sometimes happen for a fresh window. */
1540 if (matrix
->nrows
< 2)
1543 set_buffer_temp (buffer
);
1545 /* Note: last row is always reserved for the mode line. */
1546 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1547 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1549 struct glyph_row
*next
= row
+ 1;
1551 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1552 last_text_row
= row
;
1554 /* Check that character and byte positions are in sync. */
1555 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1556 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1557 xassert (BYTEPOS (row
->start
.pos
)
1558 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1560 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1561 have such a position temporarily in case of a minibuffer
1562 displaying something like `[Sole completion]' at its end. */
1563 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1565 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1566 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1567 xassert (BYTEPOS (row
->end
.pos
)
1568 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1571 /* Check that end position of `row' is equal to start position
1573 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1575 xassert (MATRIX_ROW_END_CHARPOS (row
)
1576 == MATRIX_ROW_START_CHARPOS (next
));
1577 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1578 == MATRIX_ROW_START_BYTEPOS (next
));
1579 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1580 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1585 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1586 xassert (w
->desired_matrix
->rows
!= NULL
);
1587 set_buffer_temp (saved
);
1592 #endif /* GLYPH_DEBUG != 0 */
1596 /**********************************************************************
1597 Allocating/ Adjusting Glyph Matrices
1598 **********************************************************************/
1600 /* Allocate glyph matrices over a window tree for a frame-based
1603 X and Y are column/row within the frame glyph matrix where
1604 sub-matrices for the window tree rooted at WINDOW must be
1605 allocated. DIM_ONLY_P non-zero means that the caller of this
1606 function is only interested in the result matrix dimension, and
1607 matrix adjustments should not be performed.
1609 The function returns the total width/height of the sub-matrices of
1610 the window tree. If called on a frame root window, the computation
1611 will take the mini-buffer window into account.
1613 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1615 NEW_LEAF_MATRIX set if any window in the tree did not have a
1616 glyph matrices yet, and
1618 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1619 any window in the tree will be changed or have been changed (see
1622 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1625 Windows are arranged into chains of windows on the same level
1626 through the next fields of window structures. Such a level can be
1627 either a sequence of horizontally adjacent windows from left to
1628 right, or a sequence of vertically adjacent windows from top to
1629 bottom. Each window in a horizontal sequence can be either a leaf
1630 window or a vertical sequence; a window in a vertical sequence can
1631 be either a leaf or a horizontal sequence. All windows in a
1632 horizontal sequence have the same height, and all windows in a
1633 vertical sequence have the same width.
1635 This function uses, for historical reasons, a more general
1636 algorithm to determine glyph matrix dimensions that would be
1639 The matrix height of a horizontal sequence is determined by the
1640 maximum height of any matrix in the sequence. The matrix width of
1641 a horizontal sequence is computed by adding up matrix widths of
1642 windows in the sequence.
1644 |<------- result width ------->|
1645 +---------+----------+---------+ ---
1648 +---------+ | | result height
1653 The matrix width of a vertical sequence is the maximum matrix width
1654 of any window in the sequence. Its height is computed by adding up
1655 matrix heights of windows in the sequence.
1657 |<---- result width -->|
1665 +------------+---------+ |
1668 +------------+---------+ --- */
1670 /* Bit indicating that a new matrix will be allocated or has been
1673 #define NEW_LEAF_MATRIX (1 << 0)
1675 /* Bit indicating that a matrix will or has changed its location or
1678 #define CHANGED_LEAF_MATRIX (1 << 1)
1681 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1682 int dim_only_p
, int *window_change_flags
)
1684 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1686 int wmax
= 0, hmax
= 0;
1690 int in_horz_combination_p
;
1692 /* What combination is WINDOW part of? Compute this once since the
1693 result is the same for all windows in the `next' chain. The
1694 special case of a root window (parent equal to nil) is treated
1695 like a vertical combination because a root window's `next'
1696 points to the mini-buffer window, if any, which is arranged
1697 vertically below other windows. */
1698 in_horz_combination_p
1699 = (!NILP (XWINDOW (window
)->parent
)
1700 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1702 /* For WINDOW and all windows on the same level. */
1705 w
= XWINDOW (window
);
1707 /* Get the dimension of the window sub-matrix for W, depending
1708 on whether this is a combination or a leaf window. */
1709 if (!NILP (w
->hchild
))
1710 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1712 window_change_flags
);
1713 else if (!NILP (w
->vchild
))
1714 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1716 window_change_flags
);
1719 /* If not already done, allocate sub-matrix structures. */
1720 if (w
->desired_matrix
== NULL
)
1722 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1723 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1724 *window_change_flags
|= NEW_LEAF_MATRIX
;
1727 /* Width and height MUST be chosen so that there are no
1728 holes in the frame matrix. */
1729 dim
.width
= required_matrix_width (w
);
1730 dim
.height
= required_matrix_height (w
);
1732 /* Will matrix be re-allocated? */
1733 if (x
!= w
->desired_matrix
->matrix_x
1734 || y
!= w
->desired_matrix
->matrix_y
1735 || dim
.width
!= w
->desired_matrix
->matrix_w
1736 || dim
.height
!= w
->desired_matrix
->matrix_h
1737 || (margin_glyphs_to_reserve (w
, dim
.width
,
1738 w
->left_margin_cols
)
1739 != w
->desired_matrix
->left_margin_glyphs
)
1740 || (margin_glyphs_to_reserve (w
, dim
.width
,
1741 w
->right_margin_cols
)
1742 != w
->desired_matrix
->right_margin_glyphs
))
1743 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1745 /* Actually change matrices, if allowed. Do not consider
1746 CHANGED_LEAF_MATRIX computed above here because the pool
1747 may have been changed which we don't now here. We trust
1748 that we only will be called with DIM_ONLY_P != 0 when
1752 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1753 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1757 /* If we are part of a horizontal combination, advance x for
1758 windows to the right of W; otherwise advance y for windows
1760 if (in_horz_combination_p
)
1765 /* Remember maximum glyph matrix dimensions. */
1766 wmax
= max (wmax
, dim
.width
);
1767 hmax
= max (hmax
, dim
.height
);
1769 /* Next window on same level. */
1772 while (!NILP (window
));
1774 /* Set `total' to the total glyph matrix dimension of this window
1775 level. In a vertical combination, the width is the width of the
1776 widest window; the height is the y we finally reached, corrected
1777 by the y we started with. In a horizontal combination, the total
1778 height is the height of the tallest window, and the width is the
1779 x we finally reached, corrected by the x we started with. */
1780 if (in_horz_combination_p
)
1782 total
.width
= x
- x0
;
1783 total
.height
= hmax
;
1788 total
.height
= y
- y0
;
1795 /* Return the required height of glyph matrices for window W. */
1798 required_matrix_height (struct window
*w
)
1800 #ifdef HAVE_WINDOW_SYSTEM
1801 struct frame
*f
= XFRAME (w
->frame
);
1803 if (FRAME_WINDOW_P (f
))
1805 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1806 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1807 return (((window_pixel_height
+ ch_height
- 1)
1808 / ch_height
) * w
->nrows_scale_factor
1809 /* One partially visible line at the top and
1810 bottom of the window. */
1812 /* 2 for header and mode line. */
1815 #endif /* HAVE_WINDOW_SYSTEM */
1817 return WINDOW_TOTAL_LINES (w
);
1821 /* Return the required width of glyph matrices for window W. */
1824 required_matrix_width (struct window
*w
)
1826 #ifdef HAVE_WINDOW_SYSTEM
1827 struct frame
*f
= XFRAME (w
->frame
);
1828 if (FRAME_WINDOW_P (f
))
1830 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1831 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1833 /* Compute number of glyphs needed in a glyph row. */
1834 return (((window_pixel_width
+ ch_width
- 1)
1835 / ch_width
) * w
->ncols_scale_factor
1836 /* 2 partially visible columns in the text area. */
1838 /* One partially visible column at the right
1839 edge of each marginal area. */
1842 #endif /* HAVE_WINDOW_SYSTEM */
1844 return XINT (w
->total_cols
);
1848 /* Allocate window matrices for window-based redisplay. W is the
1849 window whose matrices must be allocated/reallocated. */
1852 allocate_matrices_for_window_redisplay (struct window
*w
)
1856 if (!NILP (w
->vchild
))
1857 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1858 else if (!NILP (w
->hchild
))
1859 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1862 /* W is a leaf window. */
1865 /* If matrices are not yet allocated, allocate them now. */
1866 if (w
->desired_matrix
== NULL
)
1868 w
->desired_matrix
= new_glyph_matrix (NULL
);
1869 w
->current_matrix
= new_glyph_matrix (NULL
);
1872 dim
.width
= required_matrix_width (w
);
1873 dim
.height
= required_matrix_height (w
);
1874 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1875 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1878 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1883 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1884 do it for all frames; otherwise do it just for the given frame.
1885 This function must be called when a new frame is created, its size
1886 changes, or its window configuration changes. */
1889 adjust_glyphs (struct frame
*f
)
1891 /* Block input so that expose events and other events that access
1892 glyph matrices are not processed while we are changing them. */
1896 adjust_frame_glyphs (f
);
1899 Lisp_Object tail
, lisp_frame
;
1901 FOR_EACH_FRAME (tail
, lisp_frame
)
1902 adjust_frame_glyphs (XFRAME (lisp_frame
));
1909 /* Adjust frame glyphs when Emacs is initialized.
1911 To be called from init_display.
1913 We need a glyph matrix because redraw will happen soon.
1914 Unfortunately, window sizes on selected_frame are not yet set to
1915 meaningful values. I believe we can assume that there are only two
1916 windows on the frame---the mini-buffer and the root window. Frame
1917 height and width seem to be correct so far. So, set the sizes of
1918 windows to estimated values. */
1921 adjust_frame_glyphs_initially (void)
1923 struct frame
*sf
= SELECTED_FRAME ();
1924 struct window
*root
= XWINDOW (sf
->root_window
);
1925 struct window
*mini
= XWINDOW (root
->next
);
1926 int frame_lines
= FRAME_LINES (sf
);
1927 int frame_cols
= FRAME_COLS (sf
);
1928 int top_margin
= FRAME_TOP_MARGIN (sf
);
1930 /* Do it for the root window. */
1931 XSETFASTINT (root
->top_line
, top_margin
);
1932 XSETFASTINT (root
->total_lines
, frame_lines
- 1 - top_margin
);
1933 XSETFASTINT (root
->total_cols
, frame_cols
);
1935 /* Do it for the mini-buffer window. */
1936 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1937 XSETFASTINT (mini
->total_lines
, 1);
1938 XSETFASTINT (mini
->total_cols
, frame_cols
);
1940 adjust_frame_glyphs (sf
);
1941 glyphs_initialized_initially_p
= 1;
1945 /* Allocate/reallocate glyph matrices of a single frame F. */
1948 adjust_frame_glyphs (struct frame
*f
)
1950 if (FRAME_WINDOW_P (f
))
1951 adjust_frame_glyphs_for_window_redisplay (f
);
1953 adjust_frame_glyphs_for_frame_redisplay (f
);
1955 /* Don't forget the message buffer and the buffer for
1956 decode_mode_spec. */
1957 adjust_frame_message_buffer (f
);
1958 adjust_decode_mode_spec_buffer (f
);
1960 f
->glyphs_initialized_p
= 1;
1963 /* Return 1 if any window in the tree has nonzero window margins. See
1964 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1966 showing_window_margins_p (struct window
*w
)
1970 if (!NILP (w
->hchild
))
1972 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1975 else if (!NILP (w
->vchild
))
1977 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1980 else if (!NILP (w
->left_margin_cols
)
1981 || !NILP (w
->right_margin_cols
))
1984 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1990 /* In the window tree with root W, build current matrices of leaf
1991 windows from the frame's current matrix. */
1994 fake_current_matrices (Lisp_Object window
)
1998 for (; !NILP (window
); window
= w
->next
)
2000 w
= XWINDOW (window
);
2002 if (!NILP (w
->hchild
))
2003 fake_current_matrices (w
->hchild
);
2004 else if (!NILP (w
->vchild
))
2005 fake_current_matrices (w
->vchild
);
2009 struct frame
*f
= XFRAME (w
->frame
);
2010 struct glyph_matrix
*m
= w
->current_matrix
;
2011 struct glyph_matrix
*fm
= f
->current_matrix
;
2013 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
2014 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
2016 for (i
= 0; i
< m
->matrix_h
; ++i
)
2018 struct glyph_row
*r
= m
->rows
+ i
;
2019 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2021 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2022 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2024 r
->enabled_p
= fr
->enabled_p
;
2027 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2028 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2029 r
->used
[TEXT_AREA
] = (m
->matrix_w
2030 - r
->used
[LEFT_MARGIN_AREA
]
2031 - r
->used
[RIGHT_MARGIN_AREA
]);
2040 /* Save away the contents of frame F's current frame matrix. Value is
2041 a glyph matrix holding the contents of F's current frame matrix. */
2043 static struct glyph_matrix
*
2044 save_current_matrix (struct frame
*f
)
2047 struct glyph_matrix
*saved
;
2049 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2050 memset (saved
, 0, sizeof *saved
);
2051 saved
->nrows
= f
->current_matrix
->nrows
;
2052 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2053 * sizeof *saved
->rows
);
2054 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2056 for (i
= 0; i
< saved
->nrows
; ++i
)
2058 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2059 struct glyph_row
*to
= saved
->rows
+ i
;
2060 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2061 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2062 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2063 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2070 /* Restore the contents of frame F's current frame matrix from SAVED,
2071 and free memory associated with SAVED. */
2074 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2078 for (i
= 0; i
< saved
->nrows
; ++i
)
2080 struct glyph_row
*from
= saved
->rows
+ i
;
2081 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2082 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2083 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2084 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2085 xfree (from
->glyphs
[TEXT_AREA
]);
2088 xfree (saved
->rows
);
2094 /* Allocate/reallocate glyph matrices of a single frame F for
2095 frame-based redisplay. */
2098 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2100 struct dim matrix_dim
;
2102 int window_change_flags
;
2105 if (!FRAME_LIVE_P (f
))
2108 top_window_y
= FRAME_TOP_MARGIN (f
);
2110 /* Allocate glyph pool structures if not already done. */
2111 if (f
->desired_pool
== NULL
)
2113 f
->desired_pool
= new_glyph_pool ();
2114 f
->current_pool
= new_glyph_pool ();
2117 /* Allocate frames matrix structures if needed. */
2118 if (f
->desired_matrix
== NULL
)
2120 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2121 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2124 /* Compute window glyph matrices. (This takes the mini-buffer
2125 window into account). The result is the size of the frame glyph
2126 matrix needed. The variable window_change_flags is set to a bit
2127 mask indicating whether new matrices will be allocated or
2128 existing matrices change their size or location within the frame
2130 window_change_flags
= 0;
2132 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2135 &window_change_flags
);
2137 /* Add in menu bar lines, if any. */
2138 matrix_dim
.height
+= top_window_y
;
2140 /* Enlarge pools as necessary. */
2141 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2142 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2144 /* Set up glyph pointers within window matrices. Do this only if
2145 absolutely necessary since it requires a frame redraw. */
2146 if (pool_changed_p
|| window_change_flags
)
2148 /* Do it for window matrices. */
2149 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2151 &window_change_flags
);
2153 /* Size of frame matrices must equal size of frame. Note
2154 that we are called for X frames with window widths NOT equal
2155 to the frame width (from CHANGE_FRAME_SIZE_1). */
2156 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2157 && matrix_dim
.height
== FRAME_LINES (f
));
2159 /* Pointers to glyph memory in glyph rows are exchanged during
2160 the update phase of redisplay, which means in general that a
2161 frame's current matrix consists of pointers into both the
2162 desired and current glyph pool of the frame. Adjusting a
2163 matrix sets the frame matrix up so that pointers are all into
2164 the same pool. If we want to preserve glyph contents of the
2165 current matrix over a call to adjust_glyph_matrix, we must
2166 make a copy of the current glyphs, and restore the current
2167 matrix' contents from that copy. */
2168 if (display_completed
2169 && !FRAME_GARBAGED_P (f
)
2170 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2171 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2172 /* For some reason, the frame glyph matrix gets corrupted if
2173 any of the windows contain margins. I haven't been able
2174 to hunt down the reason, but for the moment this prevents
2175 the problem from manifesting. -- cyd */
2176 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2178 struct glyph_matrix
*copy
= save_current_matrix (f
);
2179 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2180 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2181 restore_current_matrix (f
, copy
);
2182 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2186 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2187 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2188 SET_FRAME_GARBAGED (f
);
2194 /* Allocate/reallocate glyph matrices of a single frame F for
2195 window-based redisplay. */
2198 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2200 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2202 /* Allocate/reallocate window matrices. */
2203 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2205 #ifdef HAVE_X_WINDOWS
2206 /* Allocate/ reallocate matrices of the dummy window used to display
2207 the menu bar under X when no X toolkit support is available. */
2208 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2210 /* Allocate a dummy window if not already done. */
2212 if (NILP (f
->menu_bar_window
))
2214 f
->menu_bar_window
= make_window ();
2215 w
= XWINDOW (f
->menu_bar_window
);
2216 XSETFRAME (w
->frame
, f
);
2217 w
->pseudo_window_p
= 1;
2220 w
= XWINDOW (f
->menu_bar_window
);
2222 /* Set window dimensions to frame dimensions and allocate or
2223 adjust glyph matrices of W. */
2224 XSETFASTINT (w
->top_line
, 0);
2225 XSETFASTINT (w
->left_col
, 0);
2226 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2227 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2228 allocate_matrices_for_window_redisplay (w
);
2230 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2231 #endif /* HAVE_X_WINDOWS */
2235 /* Allocate/ reallocate matrices of the tool bar window. If we
2236 don't have a tool bar window yet, make one. */
2238 if (NILP (f
->tool_bar_window
))
2240 f
->tool_bar_window
= make_window ();
2241 w
= XWINDOW (f
->tool_bar_window
);
2242 XSETFRAME (w
->frame
, f
);
2243 w
->pseudo_window_p
= 1;
2246 w
= XWINDOW (f
->tool_bar_window
);
2248 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2249 XSETFASTINT (w
->left_col
, 0);
2250 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2251 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2252 allocate_matrices_for_window_redisplay (w
);
2258 /* Adjust/ allocate message buffer of frame F.
2260 Note that the message buffer is never freed. Since I could not
2261 find a free in 19.34, I assume that freeing it would be
2262 problematic in some way and don't do it either.
2264 (Implementation note: It should be checked if we can free it
2265 eventually without causing trouble). */
2268 adjust_frame_message_buffer (struct frame
*f
)
2270 int size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2272 if (FRAME_MESSAGE_BUF (f
))
2274 char *buffer
= FRAME_MESSAGE_BUF (f
);
2275 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2276 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2279 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2283 /* Re-allocate buffer for decode_mode_spec on frame F. */
2286 adjust_decode_mode_spec_buffer (struct frame
*f
)
2288 f
->decode_mode_spec_buffer
2289 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2290 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2295 /**********************************************************************
2296 Freeing Glyph Matrices
2297 **********************************************************************/
2299 /* Free glyph memory for a frame F. F may be null. This function can
2300 be called for the same frame more than once. The root window of
2301 F may be nil when this function is called. This is the case when
2302 the function is called when F is destroyed. */
2305 free_glyphs (struct frame
*f
)
2307 if (f
&& f
->glyphs_initialized_p
)
2309 /* Block interrupt input so that we don't get surprised by an X
2310 event while we're in an inconsistent state. */
2312 f
->glyphs_initialized_p
= 0;
2314 /* Release window sub-matrices. */
2315 if (!NILP (f
->root_window
))
2316 free_window_matrices (XWINDOW (f
->root_window
));
2318 /* Free the dummy window for menu bars without X toolkit and its
2320 if (!NILP (f
->menu_bar_window
))
2322 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2323 free_glyph_matrix (w
->desired_matrix
);
2324 free_glyph_matrix (w
->current_matrix
);
2325 w
->desired_matrix
= w
->current_matrix
= NULL
;
2326 f
->menu_bar_window
= Qnil
;
2329 /* Free the tool bar window and its glyph matrices. */
2330 if (!NILP (f
->tool_bar_window
))
2332 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2333 free_glyph_matrix (w
->desired_matrix
);
2334 free_glyph_matrix (w
->current_matrix
);
2335 w
->desired_matrix
= w
->current_matrix
= NULL
;
2336 f
->tool_bar_window
= Qnil
;
2339 /* Release frame glyph matrices. Reset fields to zero in
2340 case we are called a second time. */
2341 if (f
->desired_matrix
)
2343 free_glyph_matrix (f
->desired_matrix
);
2344 free_glyph_matrix (f
->current_matrix
);
2345 f
->desired_matrix
= f
->current_matrix
= NULL
;
2348 /* Release glyph pools. */
2349 if (f
->desired_pool
)
2351 free_glyph_pool (f
->desired_pool
);
2352 free_glyph_pool (f
->current_pool
);
2353 f
->desired_pool
= f
->current_pool
= NULL
;
2361 /* Free glyph sub-matrices in the window tree rooted at W. This
2362 function may be called with a null pointer, and it may be called on
2363 the same tree more than once. */
2366 free_window_matrices (struct window
*w
)
2370 if (!NILP (w
->hchild
))
2371 free_window_matrices (XWINDOW (w
->hchild
));
2372 else if (!NILP (w
->vchild
))
2373 free_window_matrices (XWINDOW (w
->vchild
));
2376 /* This is a leaf window. Free its memory and reset fields
2377 to zero in case this function is called a second time for
2379 free_glyph_matrix (w
->current_matrix
);
2380 free_glyph_matrix (w
->desired_matrix
);
2381 w
->current_matrix
= w
->desired_matrix
= NULL
;
2384 /* Next window on same level. */
2385 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2390 /* Check glyph memory leaks. This function is called from
2391 shut_down_emacs. Note that frames are not destroyed when Emacs
2392 exits. We therefore free all glyph memory for all active frames
2393 explicitly and check that nothing is left allocated. */
2396 check_glyph_memory (void)
2398 Lisp_Object tail
, frame
;
2400 /* Free glyph memory for all frames. */
2401 FOR_EACH_FRAME (tail
, frame
)
2402 free_glyphs (XFRAME (frame
));
2404 /* Check that nothing is left allocated. */
2405 if (glyph_matrix_count
)
2407 if (glyph_pool_count
)
2413 /**********************************************************************
2414 Building a Frame Matrix
2415 **********************************************************************/
2417 /* Most of the redisplay code works on glyph matrices attached to
2418 windows. This is a good solution most of the time, but it is not
2419 suitable for terminal code. Terminal output functions cannot rely
2420 on being able to set an arbitrary terminal window. Instead they
2421 must be provided with a view of the whole frame, i.e. the whole
2422 screen. We build such a view by constructing a frame matrix from
2423 window matrices in this section.
2425 Windows that must be updated have their must_be_update_p flag set.
2426 For all such windows, their desired matrix is made part of the
2427 desired frame matrix. For other windows, their current matrix is
2428 made part of the desired frame matrix.
2430 +-----------------+----------------+
2431 | desired | desired |
2433 +-----------------+----------------+
2436 +----------------------------------+
2438 Desired window matrices can be made part of the frame matrix in a
2439 cheap way: We exploit the fact that the desired frame matrix and
2440 desired window matrices share their glyph memory. This is not
2441 possible for current window matrices. Their glyphs are copied to
2442 the desired frame matrix. The latter is equivalent to
2443 preserve_other_columns in the old redisplay.
2445 Used glyphs counters for frame matrix rows are the result of adding
2446 up glyph lengths of the window matrices. A line in the frame
2447 matrix is enabled, if a corresponding line in a window matrix is
2450 After building the desired frame matrix, it will be passed to
2451 terminal code, which will manipulate both the desired and current
2452 frame matrix. Changes applied to the frame's current matrix have
2453 to be visible in current window matrices afterwards, of course.
2455 This problem is solved like this:
2457 1. Window and frame matrices share glyphs. Window matrices are
2458 constructed in a way that their glyph contents ARE the glyph
2459 contents needed in a frame matrix. Thus, any modification of
2460 glyphs done in terminal code will be reflected in window matrices
2463 2. Exchanges of rows in a frame matrix done by terminal code are
2464 intercepted by hook functions so that corresponding row operations
2465 on window matrices can be performed. This is necessary because we
2466 use pointers to glyphs in glyph row structures. To satisfy the
2467 assumption of point 1 above that glyphs are updated implicitly in
2468 window matrices when they are manipulated via the frame matrix,
2469 window and frame matrix must of course agree where to find the
2470 glyphs for their rows. Possible manipulations that must be
2471 mirrored are assignments of rows of the desired frame matrix to the
2472 current frame matrix and scrolling the current frame matrix. */
2474 /* Build frame F's desired matrix from window matrices. Only windows
2475 which have the flag must_be_updated_p set have to be updated. Menu
2476 bar lines of a frame are not covered by window matrices, so make
2477 sure not to touch them in this function. */
2480 build_frame_matrix (struct frame
*f
)
2484 /* F must have a frame matrix when this function is called. */
2485 xassert (!FRAME_WINDOW_P (f
));
2487 /* Clear all rows in the frame matrix covered by window matrices.
2488 Menu bar lines are not covered by windows. */
2489 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2490 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2492 /* Build the matrix by walking the window tree. */
2493 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2494 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2498 /* Walk a window tree, building a frame matrix MATRIX from window
2499 matrices. W is the root of a window tree. */
2502 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2506 if (!NILP (w
->hchild
))
2507 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2508 else if (!NILP (w
->vchild
))
2509 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2511 build_frame_matrix_from_leaf_window (matrix
, w
);
2513 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2518 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2519 desired frame matrix built. W is a leaf window whose desired or
2520 current matrix is to be added to FRAME_MATRIX. W's flag
2521 must_be_updated_p determines which matrix it contributes to
2522 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2523 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2524 Adding a desired matrix means setting up used counters and such in
2525 frame rows, while adding a current window matrix to FRAME_MATRIX
2526 means copying glyphs. The latter case corresponds to
2527 preserve_other_columns in the old redisplay. */
2530 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2532 struct glyph_matrix
*window_matrix
;
2533 int window_y
, frame_y
;
2534 /* If non-zero, a glyph to insert at the right border of W. */
2535 GLYPH right_border_glyph
;
2537 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2539 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2540 if (w
->must_be_updated_p
)
2542 window_matrix
= w
->desired_matrix
;
2544 /* Decide whether we want to add a vertical border glyph. */
2545 if (!WINDOW_RIGHTMOST_P (w
))
2547 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2550 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2552 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
))
2553 && GLYPH_CODE_CHAR_VALID_P (gc
))
2555 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2556 spec_glyph_lookup_face (w
, &right_border_glyph
);
2559 if (GLYPH_FACE (right_border_glyph
) <= 0)
2560 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2564 window_matrix
= w
->current_matrix
;
2566 /* For all rows in the window matrix and corresponding rows in the
2569 frame_y
= window_matrix
->matrix_y
;
2570 while (window_y
< window_matrix
->nrows
)
2572 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2573 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2574 int current_row_p
= window_matrix
== w
->current_matrix
;
2576 /* Fill up the frame row with spaces up to the left margin of the
2578 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2580 /* Fill up areas in the window matrix row with spaces. */
2581 fill_up_glyph_row_with_spaces (window_row
);
2583 /* If only part of W's desired matrix has been built, and
2584 window_row wasn't displayed, use the corresponding current
2586 if (window_matrix
== w
->desired_matrix
2587 && !window_row
->enabled_p
)
2589 window_row
= w
->current_matrix
->rows
+ window_y
;
2595 /* Copy window row to frame row. */
2596 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2597 window_row
->glyphs
[0],
2598 window_matrix
->matrix_w
* sizeof (struct glyph
));
2602 xassert (window_row
->enabled_p
);
2604 /* Only when a desired row has been displayed, we want
2605 the corresponding frame row to be updated. */
2606 frame_row
->enabled_p
= 1;
2608 /* Maybe insert a vertical border between horizontally adjacent
2610 if (GLYPH_CHAR (right_border_glyph
) != 0)
2612 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2613 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2617 /* Window row window_y must be a slice of frame row
2619 xassert (glyph_row_slice_p (window_row
, frame_row
));
2621 /* If rows are in sync, we don't have to copy glyphs because
2622 frame and window share glyphs. */
2624 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2625 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2629 /* Set number of used glyphs in the frame matrix. Since we fill
2630 up with spaces, and visit leaf windows from left to right it
2631 can be done simply. */
2632 frame_row
->used
[TEXT_AREA
]
2633 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2641 /* Given a user-specified glyph, possibly including a Lisp-level face
2642 ID, return a glyph that has a realized face ID.
2643 This is used for glyphs displayed specially and not part of the text;
2644 for instance, vertical separators, truncation markers, etc. */
2647 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2649 int lface_id
= GLYPH_FACE (*glyph
);
2650 /* Convert the glyph's specified face to a realized (cache) face. */
2653 int face_id
= merge_faces (XFRAME (w
->frame
),
2654 Qt
, lface_id
, DEFAULT_FACE_ID
);
2655 SET_GLYPH_FACE (*glyph
, face_id
);
2659 /* Add spaces to a glyph row ROW in a window matrix.
2661 Each row has the form:
2663 +---------+-----------------------------+------------+
2664 | left | text | right |
2665 +---------+-----------------------------+------------+
2667 Left and right marginal areas are optional. This function adds
2668 spaces to areas so that there are no empty holes between areas.
2669 In other words: If the right area is not empty, the text area
2670 is filled up with spaces up to the right area. If the text area
2671 is not empty, the left area is filled up.
2673 To be called for frame-based redisplay, only. */
2676 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2678 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2679 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2680 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2684 /* Fill area AREA of glyph row ROW with spaces. To be called for
2685 frame-based redisplay only. */
2688 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2690 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2692 struct glyph
*end
= row
->glyphs
[area
+ 1];
2693 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2696 *text
++ = space_glyph
;
2697 row
->used
[area
] = text
- row
->glyphs
[area
];
2702 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2703 reached. In frame matrices only one area, TEXT_AREA, is used. */
2706 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2708 int i
= row
->used
[TEXT_AREA
];
2709 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2712 glyph
[i
++] = space_glyph
;
2714 row
->used
[TEXT_AREA
] = i
;
2719 /**********************************************************************
2720 Mirroring operations on frame matrices in window matrices
2721 **********************************************************************/
2723 /* Set frame being updated via frame-based redisplay to F. This
2724 function must be called before updates to make explicit that we are
2725 working on frame matrices or not. */
2728 set_frame_matrix_frame (struct frame
*f
)
2730 frame_matrix_frame
= f
;
2734 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2735 DESIRED_MATRIX is the desired matrix corresponding to
2736 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2737 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2738 frame_matrix_frame is non-null, this indicates that the exchange is
2739 done in frame matrices, and that we have to perform analogous
2740 operations in window matrices of frame_matrix_frame. */
2743 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2745 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2746 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2747 int mouse_face_p
= current_row
->mouse_face_p
;
2749 /* Do current_row = desired_row. This exchanges glyph pointers
2750 between both rows, and does a structure assignment otherwise. */
2751 assign_row (current_row
, desired_row
);
2753 /* Enable current_row to mark it as valid. */
2754 current_row
->enabled_p
= 1;
2755 current_row
->mouse_face_p
= mouse_face_p
;
2757 /* If we are called on frame matrices, perform analogous operations
2758 for window matrices. */
2759 if (frame_matrix_frame
)
2760 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2764 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2765 W's frame which has been made current (by swapping pointers between
2766 current and desired matrix). Perform analogous operations in the
2767 matrices of leaf windows in the window tree rooted at W. */
2770 mirror_make_current (struct window
*w
, int frame_row
)
2774 if (!NILP (w
->hchild
))
2775 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2776 else if (!NILP (w
->vchild
))
2777 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2780 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2781 here because the checks performed in debug mode there
2782 will not allow the conversion. */
2783 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2785 /* If FRAME_ROW is within W, assign the desired row to the
2786 current row (exchanging glyph pointers). */
2787 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2789 struct glyph_row
*current_row
2790 = MATRIX_ROW (w
->current_matrix
, row
);
2791 struct glyph_row
*desired_row
2792 = MATRIX_ROW (w
->desired_matrix
, row
);
2794 if (desired_row
->enabled_p
)
2795 assign_row (current_row
, desired_row
);
2797 swap_glyph_pointers (desired_row
, current_row
);
2798 current_row
->enabled_p
= 1;
2800 /* Set the Y coordinate of the mode/header line's row.
2801 It is needed in draw_row_with_mouse_face to find the
2802 screen coordinates. (Window-based redisplay sets
2803 this in update_window, but no one seems to do that
2804 for frame-based redisplay.) */
2805 if (current_row
->mode_line_p
)
2806 current_row
->y
= row
;
2810 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2815 /* Perform row dance after scrolling. We are working on the range of
2816 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2817 including) in MATRIX. COPY_FROM is a vector containing, for each
2818 row I in the range 0 <= I < NLINES, the index of the original line
2819 to move to I. This index is relative to the row range, i.e. 0 <=
2820 index < NLINES. RETAINED_P is a vector containing zero for each
2821 row 0 <= I < NLINES which is empty.
2823 This function is called from do_scrolling and do_direct_scrolling. */
2826 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2827 int *copy_from
, char *retained_p
)
2829 /* A copy of original rows. */
2830 struct glyph_row
*old_rows
;
2832 /* Rows to assign to. */
2833 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2837 /* Make a copy of the original rows. */
2838 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2839 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2841 /* Assign new rows, maybe clear lines. */
2842 for (i
= 0; i
< nlines
; ++i
)
2844 int enabled_before_p
= new_rows
[i
].enabled_p
;
2846 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2847 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2848 new_rows
[i
] = old_rows
[copy_from
[i
]];
2849 new_rows
[i
].enabled_p
= enabled_before_p
;
2851 /* RETAINED_P is zero for empty lines. */
2852 if (!retained_p
[copy_from
[i
]])
2853 new_rows
[i
].enabled_p
= 0;
2856 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2857 if (frame_matrix_frame
)
2858 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2859 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2863 /* Synchronize glyph pointers in the current matrix of window W with
2864 the current frame matrix. */
2867 sync_window_with_frame_matrix_rows (struct window
*w
)
2869 struct frame
*f
= XFRAME (w
->frame
);
2870 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2871 int left
, right
, x
, width
;
2873 /* Preconditions: W must be a leaf window on a tty frame. */
2874 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2875 xassert (!FRAME_WINDOW_P (f
));
2877 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2878 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2879 x
= w
->current_matrix
->matrix_x
;
2880 width
= w
->current_matrix
->matrix_w
;
2882 window_row
= w
->current_matrix
->rows
;
2883 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2884 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2886 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2888 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2889 = frame_row
->glyphs
[0] + x
;
2890 window_row
->glyphs
[TEXT_AREA
]
2891 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2892 window_row
->glyphs
[LAST_AREA
]
2893 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2894 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2895 = window_row
->glyphs
[LAST_AREA
] - right
;
2900 /* Return the window in the window tree rooted in W containing frame
2901 row ROW. Value is null if none is found. */
2903 static struct window
*
2904 frame_row_to_window (struct window
*w
, int row
)
2906 struct window
*found
= NULL
;
2910 if (!NILP (w
->hchild
))
2911 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2912 else if (!NILP (w
->vchild
))
2913 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2914 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2915 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2918 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2925 /* Perform a line dance in the window tree rooted at W, after
2926 scrolling a frame matrix in mirrored_line_dance.
2928 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2929 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2930 COPY_FROM is a vector containing, for each row I in the range 0 <=
2931 I < NLINES, the index of the original line to move to I. This
2932 index is relative to the row range, i.e. 0 <= index < NLINES.
2933 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2937 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2941 if (!NILP (w
->hchild
))
2942 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2943 nlines
, copy_from
, retained_p
);
2944 else if (!NILP (w
->vchild
))
2945 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2946 nlines
, copy_from
, retained_p
);
2949 /* W is a leaf window, and we are working on its current
2951 struct glyph_matrix
*m
= w
->current_matrix
;
2953 struct glyph_row
*old_rows
;
2955 /* Make a copy of the original rows of matrix m. */
2956 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2957 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2959 for (i
= 0; i
< nlines
; ++i
)
2961 /* Frame relative line assigned to. */
2962 int frame_to
= i
+ unchanged_at_top
;
2964 /* Frame relative line assigned. */
2965 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2967 /* Window relative line assigned to. */
2968 int window_to
= frame_to
- m
->matrix_y
;
2970 /* Window relative line assigned. */
2971 int window_from
= frame_from
- m
->matrix_y
;
2973 /* Is assigned line inside window? */
2974 int from_inside_window_p
2975 = window_from
>= 0 && window_from
< m
->matrix_h
;
2977 /* Is assigned to line inside window? */
2978 int to_inside_window_p
2979 = window_to
>= 0 && window_to
< m
->matrix_h
;
2981 if (from_inside_window_p
&& to_inside_window_p
)
2983 /* Enabled setting before assignment. */
2984 int enabled_before_p
;
2986 /* Do the assignment. The enabled_p flag is saved
2987 over the assignment because the old redisplay did
2989 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2990 m
->rows
[window_to
] = old_rows
[window_from
];
2991 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2993 /* If frame line is empty, window line is empty, too. */
2994 if (!retained_p
[copy_from
[i
]])
2995 m
->rows
[window_to
].enabled_p
= 0;
2997 else if (to_inside_window_p
)
2999 /* A copy between windows. This is an infrequent
3000 case not worth optimizing. */
3001 struct frame
*f
= XFRAME (w
->frame
);
3002 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3004 struct glyph_matrix
*m2
;
3007 w2
= frame_row_to_window (root
, frame_from
);
3008 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3009 -nw', FROM_FRAME sometimes has no associated window.
3010 This check avoids a segfault if W2 is null. */
3013 m2
= w2
->current_matrix
;
3014 m2_from
= frame_from
- m2
->matrix_y
;
3015 copy_row_except_pointers (m
->rows
+ window_to
,
3016 m2
->rows
+ m2_from
);
3018 /* If frame line is empty, window line is empty, too. */
3019 if (!retained_p
[copy_from
[i
]])
3020 m
->rows
[window_to
].enabled_p
= 0;
3024 else if (from_inside_window_p
)
3028 /* If there was a copy between windows, make sure glyph
3029 pointers are in sync with the frame matrix. */
3031 sync_window_with_frame_matrix_rows (w
);
3033 /* Check that no pointers are lost. */
3037 /* Next window on same level. */
3038 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3045 /* Check that window and frame matrices agree about their
3046 understanding where glyphs of the rows are to find. For each
3047 window in the window tree rooted at W, check that rows in the
3048 matrices of leaf window agree with their frame matrices about
3052 check_window_matrix_pointers (struct window
*w
)
3056 if (!NILP (w
->hchild
))
3057 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3058 else if (!NILP (w
->vchild
))
3059 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3062 struct frame
*f
= XFRAME (w
->frame
);
3063 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3064 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3067 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3072 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3073 a window and FRAME_MATRIX is the corresponding frame matrix. For
3074 each row in WINDOW_MATRIX check that it's a slice of the
3075 corresponding frame row. If it isn't, abort. */
3078 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3079 struct glyph_matrix
*frame_matrix
)
3081 /* Row number in WINDOW_MATRIX. */
3084 /* Row number corresponding to I in FRAME_MATRIX. */
3085 int j
= window_matrix
->matrix_y
;
3087 /* For all rows check that the row in the window matrix is a
3088 slice of the row in the frame matrix. If it isn't we didn't
3089 mirror an operation on the frame matrix correctly. */
3090 while (i
< window_matrix
->nrows
)
3092 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3093 frame_matrix
->rows
+ j
))
3099 #endif /* GLYPH_DEBUG != 0 */
3103 /**********************************************************************
3104 VPOS and HPOS translations
3105 **********************************************************************/
3109 /* Translate vertical position VPOS which is relative to window W to a
3110 vertical position relative to W's frame. */
3113 window_to_frame_vpos (struct window
*w
, int vpos
)
3115 struct frame
*f
= XFRAME (w
->frame
);
3117 xassert (!FRAME_WINDOW_P (f
));
3118 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3119 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3120 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (f
));
3125 /* Translate horizontal position HPOS which is relative to window W to
3126 a horizontal position relative to W's frame. */
3129 window_to_frame_hpos (struct window
*w
, int hpos
)
3131 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3132 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3136 #endif /* GLYPH_DEBUG */
3140 /**********************************************************************
3142 **********************************************************************/
3144 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3145 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3150 CHECK_LIVE_FRAME (frame
);
3153 /* Ignore redraw requests, if frame has no glyphs yet.
3154 (Implementation note: It still has to be checked why we are
3155 called so early here). */
3156 if (!glyphs_initialized_initially_p
)
3161 if (FRAME_MSDOS_P (f
))
3162 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3165 clear_current_matrices (f
);
3167 if (FRAME_TERMCAP_P (f
))
3168 fflush (FRAME_TTY (f
)->output
);
3169 windows_or_buffers_changed
++;
3170 /* Mark all windows as inaccurate, so that every window will have
3171 its redisplay done. */
3172 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3173 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3179 /* Redraw frame F. This is nothing more than a call to the Lisp
3180 function redraw-frame. */
3183 redraw_frame (struct frame
*f
)
3186 XSETFRAME (frame
, f
);
3187 Fredraw_frame (frame
);
3191 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3192 doc
: /* Clear and redisplay all visible frames. */)
3195 Lisp_Object tail
, frame
;
3197 FOR_EACH_FRAME (tail
, frame
)
3198 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3199 Fredraw_frame (frame
);
3206 /***********************************************************************
3208 ***********************************************************************/
3210 /* Update frame F based on the data in desired matrices.
3212 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3213 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3216 Value is non-zero if redisplay was stopped due to pending input. */
3219 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3221 /* 1 means display has been paused because of pending input. */
3223 struct window
*root_window
= XWINDOW (f
->root_window
);
3225 if (redisplay_dont_pause
)
3227 #if PERIODIC_PREEMPTION_CHECKING
3228 else if (NILP (Vredisplay_preemption_period
))
3230 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3233 double p
= XFLOATINT (Vredisplay_preemption_period
);
3236 if (detect_input_pending_ignore_squeezables ())
3243 usec
= (p
- sec
) * 1000000;
3245 EMACS_GET_TIME (tm
);
3246 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3247 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3251 if (FRAME_WINDOW_P (f
))
3253 /* We are working on window matrix basis. All windows whose
3254 flag must_be_updated_p is set have to be updated. */
3256 /* Record that we are not working on frame matrices. */
3257 set_frame_matrix_frame (NULL
);
3259 /* Update all windows in the window tree of F, maybe stopping
3260 when pending input is detected. */
3263 /* Update the menu bar on X frames that don't have toolkit
3265 if (WINDOWP (f
->menu_bar_window
))
3266 update_window (XWINDOW (f
->menu_bar_window
), 1);
3268 /* Update the tool-bar window, if present. */
3269 if (WINDOWP (f
->tool_bar_window
))
3271 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3273 /* Update tool-bar window. */
3274 if (w
->must_be_updated_p
)
3278 update_window (w
, 1);
3279 w
->must_be_updated_p
= 0;
3281 /* Swap tool-bar strings. We swap because we want to
3283 tem
= f
->current_tool_bar_string
;
3284 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3285 f
->desired_tool_bar_string
= tem
;
3290 /* Update windows. */
3291 paused_p
= update_window_tree (root_window
, force_p
);
3294 /* This flush is a performance bottleneck under X,
3295 and it doesn't seem to be necessary anyway (in general).
3296 It is necessary when resizing the window with the mouse, or
3297 at least the fringes are not redrawn in a timely manner. ++kfs */
3298 if (f
->force_flush_display_p
)
3300 FRAME_RIF (f
)->flush_display (f
);
3301 f
->force_flush_display_p
= 0;
3306 /* We are working on frame matrix basis. Set the frame on whose
3307 frame matrix we operate. */
3308 set_frame_matrix_frame (f
);
3310 /* Build F's desired matrix from window matrices. */
3311 build_frame_matrix (f
);
3313 /* Update the display */
3315 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3318 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3320 if (FRAME_TTY (f
)->termscript
)
3321 fflush (FRAME_TTY (f
)->termscript
);
3322 if (FRAME_TERMCAP_P (f
))
3323 fflush (FRAME_TTY (f
)->output
);
3326 /* Check window matrices for lost pointers. */
3328 check_window_matrix_pointers (root_window
);
3329 add_frame_display_history (f
, paused_p
);
3333 #if PERIODIC_PREEMPTION_CHECKING
3336 /* Reset flags indicating that a window should be updated. */
3337 set_window_update_flags (root_window
, 0);
3339 display_completed
= !paused_p
;
3345 /************************************************************************
3346 Window-based updates
3347 ************************************************************************/
3349 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3350 don't stop updating when input is pending. */
3353 update_window_tree (struct window
*w
, int force_p
)
3357 while (w
&& !paused_p
)
3359 if (!NILP (w
->hchild
))
3360 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3361 else if (!NILP (w
->vchild
))
3362 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3363 else if (w
->must_be_updated_p
)
3364 paused_p
|= update_window (w
, force_p
);
3366 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3373 /* Update window W if its flag must_be_updated_p is non-zero. If
3374 FORCE_P is non-zero, don't stop updating if input is pending. */
3377 update_single_window (struct window
*w
, int force_p
)
3379 if (w
->must_be_updated_p
)
3381 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3383 /* Record that this is not a frame-based redisplay. */
3384 set_frame_matrix_frame (NULL
);
3386 if (redisplay_dont_pause
)
3388 #if PERIODIC_PREEMPTION_CHECKING
3389 else if (NILP (Vredisplay_preemption_period
))
3391 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3394 double p
= XFLOATINT (Vredisplay_preemption_period
);
3398 usec
= (p
- sec
) * 1000000;
3400 EMACS_GET_TIME (tm
);
3401 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3402 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3408 update_window (w
, force_p
);
3411 /* Reset flag in W. */
3412 w
->must_be_updated_p
= 0;
3416 #ifdef HAVE_WINDOW_SYSTEM
3418 /* Redraw lines from the current matrix of window W that are
3419 overlapped by other rows. YB is bottom-most y-position in W. */
3422 redraw_overlapped_rows (struct window
*w
, int yb
)
3425 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3427 /* If rows overlapping others have been changed, the rows being
3428 overlapped have to be redrawn. This won't draw lines that have
3429 already been drawn in update_window_line because overlapped_p in
3430 desired rows is 0, so after row assignment overlapped_p in
3431 current rows is 0. */
3432 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3434 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3436 if (!row
->enabled_p
)
3438 else if (row
->mode_line_p
)
3441 if (row
->overlapped_p
)
3443 enum glyph_row_area area
;
3445 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3448 updated_area
= area
;
3449 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3450 area
== TEXT_AREA
? row
->x
: 0);
3451 if (row
->used
[area
])
3452 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3454 FRAME_RIF (f
)->clear_end_of_line (-1);
3457 row
->overlapped_p
= 0;
3460 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3466 /* Redraw lines from the current matrix of window W that overlap
3467 others. YB is bottom-most y-position in W. */
3470 redraw_overlapping_rows (struct window
*w
, int yb
)
3473 struct glyph_row
*row
;
3474 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3476 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3478 row
= w
->current_matrix
->rows
+ i
;
3480 if (!row
->enabled_p
)
3482 else if (row
->mode_line_p
)
3485 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3487 if (row
->overlapping_p
)
3491 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3492 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3493 overlaps
|= OVERLAPS_PRED
;
3494 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3495 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3496 overlaps
|= OVERLAPS_SUCC
;
3500 if (row
->used
[LEFT_MARGIN_AREA
])
3501 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3503 if (row
->used
[TEXT_AREA
])
3504 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3506 if (row
->used
[RIGHT_MARGIN_AREA
])
3507 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3509 /* Record in neighbour rows that ROW overwrites part of
3511 if (overlaps
& OVERLAPS_PRED
)
3512 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3513 if (overlaps
& OVERLAPS_SUCC
)
3514 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3523 #endif /* HAVE_WINDOW_SYSTEM */
3526 #if defined GLYPH_DEBUG && 0
3528 /* Check that no row in the current matrix of window W is enabled
3529 which is below what's displayed in the window. */
3532 check_current_matrix_flags (struct window
*w
)
3534 int last_seen_p
= 0;
3535 int i
, yb
= window_text_bottom_y (w
);
3537 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3539 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3540 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3542 else if (last_seen_p
&& row
->enabled_p
)
3547 #endif /* GLYPH_DEBUG */
3550 /* Update display of window W. FORCE_P non-zero means that we should
3551 not stop when detecting pending input. */
3554 update_window (struct window
*w
, int force_p
)
3556 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3558 #if !PERIODIC_PREEMPTION_CHECKING
3559 int preempt_count
= baud_rate
/ 2400 + 1;
3561 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3563 /* Check that W's frame doesn't have glyph matrices. */
3564 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3567 /* Check pending input the first time so that we can quickly return. */
3568 #if !PERIODIC_PREEMPTION_CHECKING
3570 detect_input_pending_ignore_squeezables ();
3573 /* If forced to complete the update, or if no input is pending, do
3575 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3577 struct glyph_row
*row
, *end
;
3578 struct glyph_row
*mode_line_row
;
3579 struct glyph_row
*header_line_row
;
3580 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3581 #if ! PERIODIC_PREEMPTION_CHECKING
3585 rif
->update_window_begin_hook (w
);
3586 yb
= window_text_bottom_y (w
);
3588 /* If window has a header line, update it before everything else.
3589 Adjust y-positions of other rows by the header line height. */
3590 row
= desired_matrix
->rows
;
3591 end
= row
+ desired_matrix
->nrows
- 1;
3593 if (row
->mode_line_p
)
3595 header_line_row
= row
;
3599 header_line_row
= NULL
;
3601 /* Update the mode line, if necessary. */
3602 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3603 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3605 mode_line_row
->y
= yb
;
3606 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3608 &mouse_face_overwritten_p
);
3611 /* Find first enabled row. Optimizations in redisplay_internal
3612 may lead to an update with only one row enabled. There may
3613 be also completely empty matrices. */
3614 while (row
< end
&& !row
->enabled_p
)
3617 /* Try reusing part of the display by copying. */
3618 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3620 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3623 /* All rows were found to be equal. */
3629 /* We've scrolled the display. */
3635 /* Update the rest of the lines. */
3636 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3639 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3642 /* We'll have to play a little bit with when to
3643 detect_input_pending. If it's done too often,
3644 scrolling large windows with repeated scroll-up
3645 commands will too quickly pause redisplay. */
3646 #if PERIODIC_PREEMPTION_CHECKING
3650 EMACS_GET_TIME (tm
);
3651 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3652 if (EMACS_TIME_NEG_P (dif
))
3654 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3655 if (detect_input_pending_ignore_squeezables ())
3660 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3661 detect_input_pending_ignore_squeezables ();
3663 changed_p
|= update_window_line (w
, vpos
,
3664 &mouse_face_overwritten_p
);
3666 /* Mark all rows below the last visible one in the current
3667 matrix as invalid. This is necessary because of
3668 variable line heights. Consider the case of three
3669 successive redisplays, where the first displays 5
3670 lines, the second 3 lines, and the third 5 lines again.
3671 If the second redisplay wouldn't mark rows in the
3672 current matrix invalid, the third redisplay might be
3673 tempted to optimize redisplay based on lines displayed
3674 in the first redisplay. */
3675 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3676 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3677 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3680 /* Was display preempted? */
3681 paused_p
= row
< end
;
3685 /* Update the header line after scrolling because a new header
3686 line would otherwise overwrite lines at the top of the window
3687 that can be scrolled. */
3688 if (header_line_row
&& header_line_row
->enabled_p
)
3690 header_line_row
->y
= 0;
3691 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3694 /* Fix the appearance of overlapping/overlapped rows. */
3695 if (!paused_p
&& !w
->pseudo_window_p
)
3697 #ifdef HAVE_WINDOW_SYSTEM
3698 if (changed_p
&& rif
->fix_overlapping_area
)
3700 redraw_overlapped_rows (w
, yb
);
3701 redraw_overlapping_rows (w
, yb
);
3705 /* Make cursor visible at cursor position of W. */
3706 set_window_cursor_after_update (w
);
3708 #if 0 /* Check that current matrix invariants are satisfied. This is
3709 for debugging only. See the comment of check_matrix_invariants. */
3710 IF_DEBUG (check_matrix_invariants (w
));
3715 /* Remember the redisplay method used to display the matrix. */
3716 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3719 #ifdef HAVE_WINDOW_SYSTEM
3720 update_window_fringes (w
, 0);
3723 /* End the update of window W. Don't set the cursor if we
3724 paused updating the display because in this case,
3725 set_window_cursor_after_update hasn't been called, and
3726 output_cursor doesn't contain the cursor location. */
3727 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3733 /* check_current_matrix_flags (w); */
3734 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3737 clear_glyph_matrix (desired_matrix
);
3743 /* Update the display of area AREA in window W, row number VPOS.
3744 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3747 update_marginal_area (struct window
*w
, int area
, int vpos
)
3749 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3750 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3752 /* Let functions in xterm.c know what area subsequent X positions
3753 will be relative to. */
3754 updated_area
= area
;
3756 /* Set cursor to start of glyphs, write them, and clear to the end
3757 of the area. I don't think that something more sophisticated is
3758 necessary here, since marginal areas will not be the default. */
3759 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3760 if (desired_row
->used
[area
])
3761 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3762 rif
->clear_end_of_line (-1);
3766 /* Update the display of the text area of row VPOS in window W.
3767 Value is non-zero if display has changed. */
3770 update_text_area (struct window
*w
, int vpos
)
3772 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3773 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3774 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3777 /* Let functions in xterm.c know what area subsequent X positions
3778 will be relative to. */
3779 updated_area
= TEXT_AREA
;
3781 /* If rows are at different X or Y, or rows have different height,
3782 or the current row is marked invalid, write the entire line. */
3783 if (!current_row
->enabled_p
3784 || desired_row
->y
!= current_row
->y
3785 || desired_row
->ascent
!= current_row
->ascent
3786 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3787 || desired_row
->phys_height
!= current_row
->phys_height
3788 || desired_row
->visible_height
!= current_row
->visible_height
3789 || current_row
->overlapped_p
3790 /* This next line is necessary for correctly redrawing
3791 mouse-face areas after scrolling and other operations.
3792 However, it causes excessive flickering when mouse is moved
3793 across the mode line. Luckily, turning it off for the mode
3794 line doesn't seem to hurt anything. -- cyd.
3795 But it is still needed for the header line. -- kfs. */
3796 || (current_row
->mouse_face_p
3797 && !(current_row
->mode_line_p
&& vpos
> 0))
3798 || current_row
->x
!= desired_row
->x
)
3800 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3802 if (desired_row
->used
[TEXT_AREA
])
3803 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3804 desired_row
->used
[TEXT_AREA
]);
3806 /* Clear to end of window. */
3807 rif
->clear_end_of_line (-1);
3810 /* This erases the cursor. We do this here because
3811 notice_overwritten_cursor cannot easily check this, which
3812 might indicate that the whole functionality of
3813 notice_overwritten_cursor would better be implemented here.
3814 On the other hand, we need notice_overwritten_cursor as long
3815 as mouse highlighting is done asynchronously outside of
3817 if (vpos
== w
->phys_cursor
.vpos
)
3818 w
->phys_cursor_on_p
= 0;
3823 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3824 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3825 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3826 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3827 int abort_skipping
= 0;
3829 /* If the desired row extends its face to the text area end, and
3830 unless the current row also does so at the same position,
3831 make sure we write at least one glyph, so that the face
3832 extension actually takes place. */
3833 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3834 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3835 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3836 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3839 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3843 /* Loop over glyphs that current and desired row may have
3847 int can_skip_p
= !abort_skipping
;
3849 /* Skip over glyphs that both rows have in common. These
3850 don't have to be written. We can't skip if the last
3851 current glyph overlaps the glyph to its right. For
3852 example, consider a current row of `if ' with the `f' in
3853 Courier bold so that it overlaps the ` ' to its right.
3854 If the desired row is ` ', we would skip over the space
3855 after the `if' and there would remain a pixel from the
3856 `f' on the screen. */
3857 if (overlapping_glyphs_p
&& i
> 0)
3859 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3862 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3864 can_skip_p
= (right
== 0 && !abort_skipping
);
3872 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3874 x
+= desired_glyph
->pixel_width
;
3875 ++desired_glyph
, ++current_glyph
, ++i
;
3878 /* Consider the case that the current row contains "xxx
3879 ppp ggg" in italic Courier font, and the desired row
3880 is "xxx ggg". The character `p' has lbearing, `g'
3881 has not. The loop above will stop in front of the
3882 first `p' in the current row. If we would start
3883 writing glyphs there, we wouldn't erase the lbearing
3884 of the `p'. The rest of the lbearing problem is then
3885 taken care of by draw_glyphs. */
3886 if (overlapping_glyphs_p
3888 && i
< current_row
->used
[TEXT_AREA
]
3889 && (current_row
->used
[TEXT_AREA
]
3890 != desired_row
->used
[TEXT_AREA
]))
3894 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3896 while (left
> 0 && i
> 0)
3898 --i
, --desired_glyph
, --current_glyph
;
3899 x
-= desired_glyph
->pixel_width
;
3900 left
-= desired_glyph
->pixel_width
;
3903 /* Abort the skipping algorithm if we end up before
3904 our starting point, to avoid looping (bug#1070).
3905 This can happen when the lbearing is larger than
3907 abort_skipping
= (i
< start_hpos
);
3911 /* Try to avoid writing the entire rest of the desired row
3912 by looking for a resync point. This mainly prevents
3913 mode line flickering in the case the mode line is in
3914 fixed-pitch font, which it usually will be. */
3915 if (i
< desired_row
->used
[TEXT_AREA
])
3917 int start_x
= x
, start_hpos
= i
;
3918 struct glyph
*start
= desired_glyph
;
3920 int skip_first_p
= !can_skip_p
;
3922 /* Find the next glyph that's equal again. */
3925 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3928 x
+= desired_glyph
->pixel_width
;
3929 current_x
+= current_glyph
->pixel_width
;
3930 ++desired_glyph
, ++current_glyph
, ++i
;
3934 if (i
== start_hpos
|| x
!= current_x
)
3938 desired_glyph
= start
;
3942 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3943 rif
->write_glyphs (start
, i
- start_hpos
);
3948 /* Write the rest. */
3949 if (i
< desired_row
->used
[TEXT_AREA
])
3951 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3952 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3956 /* Maybe clear to end of line. */
3957 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3959 /* If new row extends to the end of the text area, nothing
3960 has to be cleared, if and only if we did a write_glyphs
3961 above. This is made sure by setting desired_stop_pos
3962 appropriately above. */
3963 xassert (i
< desired_row
->used
[TEXT_AREA
]
3964 || ((desired_row
->used
[TEXT_AREA
]
3965 == current_row
->used
[TEXT_AREA
])
3966 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3968 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3970 /* If old row extends to the end of the text area, clear. */
3971 if (i
>= desired_row
->used
[TEXT_AREA
])
3972 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3973 desired_row
->pixel_width
);
3974 rif
->clear_end_of_line (-1);
3977 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3979 /* Otherwise clear to the end of the old row. Everything
3980 after that position should be clear already. */
3983 if (i
>= desired_row
->used
[TEXT_AREA
])
3984 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3985 desired_row
->pixel_width
);
3987 /* If cursor is displayed at the end of the line, make sure
3988 it's cleared. Nowadays we don't have a phys_cursor_glyph
3989 with which to erase the cursor (because this method
3990 doesn't work with lbearing/rbearing), so we must do it
3992 if (vpos
== w
->phys_cursor
.vpos
3993 && (desired_row
->reversed_p
3994 ? (w
->phys_cursor
.hpos
< 0)
3995 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3997 w
->phys_cursor_on_p
= 0;
4001 xlim
= current_row
->pixel_width
;
4002 rif
->clear_end_of_line (xlim
);
4011 /* Update row VPOS in window W. Value is non-zero if display has been
4015 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
4017 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
4018 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
4019 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4022 /* Set the row being updated. This is important to let xterm.c
4023 know what line height values are in effect. */
4024 updated_row
= desired_row
;
4026 /* A row can be completely invisible in case a desired matrix was
4027 built with a vscroll and then make_cursor_line_fully_visible shifts
4028 the matrix. Make sure to make such rows current anyway, since
4029 we need the correct y-position, for example, in the current matrix. */
4030 if (desired_row
->mode_line_p
4031 || desired_row
->visible_height
> 0)
4033 xassert (desired_row
->enabled_p
);
4035 /* Update display of the left margin area, if there is one. */
4036 if (!desired_row
->full_width_p
4037 && !NILP (w
->left_margin_cols
))
4040 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4043 /* Update the display of the text area. */
4044 if (update_text_area (w
, vpos
))
4047 if (current_row
->mouse_face_p
)
4048 *mouse_face_overwritten_p
= 1;
4051 /* Update display of the right margin area, if there is one. */
4052 if (!desired_row
->full_width_p
4053 && !NILP (w
->right_margin_cols
))
4056 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4059 /* Draw truncation marks etc. */
4060 if (!current_row
->enabled_p
4061 || desired_row
->y
!= current_row
->y
4062 || desired_row
->visible_height
!= current_row
->visible_height
4063 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4064 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4065 || current_row
->redraw_fringe_bitmaps_p
4066 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4067 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4068 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4069 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4070 rif
->after_update_window_line_hook (desired_row
);
4073 /* Update current_row from desired_row. */
4074 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4080 /* Set the cursor after an update of window W. This function may only
4081 be called from update_window. */
4084 set_window_cursor_after_update (struct window
*w
)
4086 struct frame
*f
= XFRAME (w
->frame
);
4087 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4088 int cx
, cy
, vpos
, hpos
;
4090 /* Not intended for frame matrix updates. */
4091 xassert (FRAME_WINDOW_P (f
));
4093 if (cursor_in_echo_area
4094 && !NILP (echo_area_buffer
[0])
4095 /* If we are showing a message instead of the mini-buffer,
4096 show the cursor for the message instead. */
4097 && XWINDOW (minibuf_window
) == w
4098 && EQ (minibuf_window
, echo_area_window
)
4099 /* These cases apply only to the frame that contains
4100 the active mini-buffer window. */
4101 && FRAME_HAS_MINIBUF_P (f
)
4102 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4104 cx
= cy
= vpos
= hpos
= 0;
4106 if (cursor_in_echo_area
>= 0)
4108 /* If the mini-buffer is several lines high, find the last
4109 line that has any text on it. Note: either all lines
4110 are enabled or none. Otherwise we wouldn't be able to
4112 struct glyph_row
*row
, *last_row
;
4113 struct glyph
*glyph
;
4114 int yb
= window_text_bottom_y (w
);
4117 row
= w
->current_matrix
->rows
;
4118 while (row
->enabled_p
4119 && (last_row
== NULL
4120 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4122 if (row
->used
[TEXT_AREA
]
4123 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4130 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4131 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4133 while (last
> start
&& last
->charpos
< 0)
4136 for (glyph
= start
; glyph
< last
; ++glyph
)
4138 cx
+= glyph
->pixel_width
;
4143 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4151 hpos
= w
->cursor
.hpos
;
4152 vpos
= w
->cursor
.vpos
;
4155 /* Window cursor can be out of sync for horizontally split windows. */
4156 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4157 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4158 vpos
= max (0, vpos
);
4159 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4160 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4164 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4165 tree rooted at W. */
4168 set_window_update_flags (struct window
*w
, int on_p
)
4172 if (!NILP (w
->hchild
))
4173 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4174 else if (!NILP (w
->vchild
))
4175 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4177 w
->must_be_updated_p
= on_p
;
4179 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4185 /***********************************************************************
4186 Window-Based Scrolling
4187 ***********************************************************************/
4189 /* Structure describing rows in scrolling_window. */
4193 /* Number of occurrences of this row in desired and current matrix. */
4194 int old_uses
, new_uses
;
4196 /* Vpos of row in new matrix. */
4197 int new_line_number
;
4199 /* Bucket index of this row_entry in the hash table row_table. */
4202 /* The row described by this entry. */
4203 struct glyph_row
*row
;
4205 /* Hash collision chain. */
4206 struct row_entry
*next
;
4209 /* A pool to allocate row_entry structures from, and the size of the
4210 pool. The pool is reallocated in scrolling_window when we find
4211 that we need a larger one. */
4213 static struct row_entry
*row_entry_pool
;
4214 static int row_entry_pool_size
;
4216 /* Index of next free entry in row_entry_pool. */
4218 static int row_entry_idx
;
4220 /* The hash table used during scrolling, and the table's size. This
4221 table is used to quickly identify equal rows in the desired and
4224 static struct row_entry
**row_table
;
4225 static int row_table_size
;
4227 /* Vectors of pointers to row_entry structures belonging to the
4228 current and desired matrix, and the size of the vectors. */
4230 static struct row_entry
**old_lines
, **new_lines
;
4231 static int old_lines_size
, new_lines_size
;
4233 /* A pool to allocate run structures from, and its size. */
4235 static struct run
*run_pool
;
4236 static int runs_size
;
4238 /* A vector of runs of lines found during scrolling. */
4240 static struct run
**runs
;
4242 /* Add glyph row ROW to the scrolling hash table. */
4244 static INLINE
struct row_entry
*
4245 add_row_entry (struct glyph_row
*row
)
4247 struct row_entry
*entry
;
4248 int i
= row
->hash
% row_table_size
;
4250 entry
= row_table
[i
];
4251 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4252 entry
= entry
->next
;
4256 entry
= row_entry_pool
+ row_entry_idx
++;
4258 entry
->old_uses
= entry
->new_uses
= 0;
4259 entry
->new_line_number
= 0;
4261 entry
->next
= row_table
[i
];
4262 row_table
[i
] = entry
;
4269 /* Try to reuse part of the current display of W by scrolling lines.
4270 HEADER_LINE_P non-zero means W has a header line.
4272 The algorithm is taken from Communications of the ACM, Apr78 "A
4273 Technique for Isolating Differences Between Files." It should take
4276 A short outline of the steps of the algorithm
4278 1. Skip lines equal at the start and end of both matrices.
4280 2. Enter rows in the current and desired matrix into a symbol
4281 table, counting how often they appear in both matrices.
4283 3. Rows that appear exactly once in both matrices serve as anchors,
4284 i.e. we assume that such lines are likely to have been moved.
4286 4. Starting from anchor lines, extend regions to be scrolled both
4287 forward and backward.
4291 -1 if all rows were found to be equal.
4292 0 to indicate that we did not scroll the display, or
4293 1 if we did scroll. */
4296 scrolling_window (struct window
*w
, int header_line_p
)
4298 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4299 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4300 int yb
= window_text_bottom_y (w
);
4301 int i
, j
, first_old
, first_new
, last_old
, last_new
;
4302 int nruns
, nbytes
, n
, run_idx
;
4303 struct row_entry
*entry
;
4304 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4306 /* Skip over rows equal at the start. */
4307 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4309 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4310 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4314 && !d
->redraw_fringe_bitmaps_p
4316 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4317 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4318 && row_equal_p (c
, d
, 1))
4327 /* Give up if some rows in the desired matrix are not enabled. */
4328 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4331 first_old
= first_new
= i
;
4333 /* Set last_new to the index + 1 of the last enabled row in the
4336 while (i
< desired_matrix
->nrows
- 1
4337 && MATRIX_ROW (desired_matrix
, i
)->enabled_p
4338 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
)) <= yb
)
4341 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4346 /* Set last_old to the index + 1 of the last enabled row in the
4347 current matrix. We don't look at the enabled flag here because
4348 we plan to reuse part of the display even if other parts are
4351 while (i
< current_matrix
->nrows
- 1)
4353 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4362 /* Skip over rows equal at the bottom. */
4365 while (i
- 1 > first_new
4366 && j
- 1 > first_old
4367 && MATRIX_ROW (current_matrix
, i
- 1)->enabled_p
4368 && (MATRIX_ROW (current_matrix
, i
- 1)->y
4369 == MATRIX_ROW (desired_matrix
, j
- 1)->y
)
4370 && !MATRIX_ROW (desired_matrix
, j
- 1)->redraw_fringe_bitmaps_p
4371 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4372 MATRIX_ROW (current_matrix
, j
- 1), 1))
4377 /* Nothing to do if all rows are equal. */
4378 if (last_new
== first_new
)
4381 /* Reallocate vectors, tables etc. if necessary. */
4383 if (current_matrix
->nrows
> old_lines_size
)
4385 old_lines_size
= current_matrix
->nrows
;
4386 nbytes
= old_lines_size
* sizeof *old_lines
;
4387 old_lines
= (struct row_entry
**) xrealloc (old_lines
, nbytes
);
4390 if (desired_matrix
->nrows
> new_lines_size
)
4392 new_lines_size
= desired_matrix
->nrows
;
4393 nbytes
= new_lines_size
* sizeof *new_lines
;
4394 new_lines
= (struct row_entry
**) xrealloc (new_lines
, nbytes
);
4397 n
= desired_matrix
->nrows
+ current_matrix
->nrows
;
4398 if (3 * n
> row_table_size
)
4400 row_table_size
= next_almost_prime (3 * n
);
4401 nbytes
= row_table_size
* sizeof *row_table
;
4402 row_table
= (struct row_entry
**) xrealloc (row_table
, nbytes
);
4403 memset (row_table
, 0, nbytes
);
4406 if (n
> row_entry_pool_size
)
4408 row_entry_pool_size
= n
;
4409 nbytes
= row_entry_pool_size
* sizeof *row_entry_pool
;
4410 row_entry_pool
= (struct row_entry
*) xrealloc (row_entry_pool
, nbytes
);
4413 if (desired_matrix
->nrows
> runs_size
)
4415 runs_size
= desired_matrix
->nrows
;
4416 nbytes
= runs_size
* sizeof *runs
;
4417 runs
= (struct run
**) xrealloc (runs
, nbytes
);
4418 nbytes
= runs_size
* sizeof *run_pool
;
4419 run_pool
= (struct run
*) xrealloc (run_pool
, nbytes
);
4422 nruns
= run_idx
= 0;
4425 /* Add rows from the current and desired matrix to the hash table
4426 row_hash_table to be able to find equal ones quickly. */
4428 for (i
= first_old
; i
< last_old
; ++i
)
4430 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4432 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4433 old_lines
[i
] = entry
;
4437 old_lines
[i
] = NULL
;
4440 for (i
= first_new
; i
< last_new
; ++i
)
4442 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4443 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4445 entry
->new_line_number
= i
;
4446 new_lines
[i
] = entry
;
4449 /* Identify moves based on lines that are unique and equal
4450 in both matrices. */
4451 for (i
= first_old
; i
< last_old
;)
4453 && old_lines
[i
]->old_uses
== 1
4454 && old_lines
[i
]->new_uses
== 1)
4457 int new_line
= old_lines
[i
]->new_line_number
;
4458 struct run
*run
= run_pool
+ run_idx
++;
4461 run
->current_vpos
= i
;
4462 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4463 run
->desired_vpos
= new_line
;
4464 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4466 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4468 /* Extend backward. */
4471 while (p
> first_old
4473 && old_lines
[p
] == new_lines
[q
])
4475 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4476 --run
->current_vpos
;
4477 --run
->desired_vpos
;
4480 run
->desired_y
-= h
;
4481 run
->current_y
-= h
;
4485 /* Extend forward. */
4490 && old_lines
[p
] == new_lines
[q
])
4492 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4498 /* Insert run into list of all runs. Order runs by copied
4499 pixel lines. Note that we record runs that don't have to
4500 be copied because they are already in place. This is done
4501 because we can avoid calling update_window_line in this
4503 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4505 for (q
= nruns
; q
> p
; --q
)
4506 runs
[q
] = runs
[q
- 1];
4515 /* Do the moves. Do it in a way that we don't overwrite something
4516 we want to copy later on. This is not solvable in general
4517 because there is only one display and we don't have a way to
4518 exchange areas on this display. Example:
4520 +-----------+ +-----------+
4522 +-----------+ --> +-----------+
4524 +-----------+ +-----------+
4526 Instead, prefer bigger moves, and invalidate moves that would
4527 copy from where we copied to. */
4529 for (i
= 0; i
< nruns
; ++i
)
4530 if (runs
[i
]->nrows
> 0)
4532 struct run
*r
= runs
[i
];
4534 /* Copy on the display. */
4535 if (r
->current_y
!= r
->desired_y
)
4537 rif
->scroll_run_hook (w
, r
);
4539 /* Invalidate runs that copy from where we copied to. */
4540 for (j
= i
+ 1; j
< nruns
; ++j
)
4542 struct run
*p
= runs
[j
];
4544 if ((p
->current_y
>= r
->desired_y
4545 && p
->current_y
< r
->desired_y
+ r
->height
)
4546 || (p
->current_y
+ p
->height
>= r
->desired_y
4547 && (p
->current_y
+ p
->height
4548 < r
->desired_y
+ r
->height
)))
4553 /* Assign matrix rows. */
4554 for (j
= 0; j
< r
->nrows
; ++j
)
4556 struct glyph_row
*from
, *to
;
4557 int to_overlapped_p
;
4559 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4560 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4561 to_overlapped_p
= to
->overlapped_p
;
4562 if (!from
->mode_line_p
&& !w
->pseudo_window_p
4563 && (to
->left_fringe_bitmap
!= from
->left_fringe_bitmap
4564 || to
->right_fringe_bitmap
!= from
->right_fringe_bitmap
4565 || to
->left_fringe_face_id
!= from
->left_fringe_face_id
4566 || to
->right_fringe_face_id
!= from
->right_fringe_face_id
4567 || to
->overlay_arrow_bitmap
!= from
->overlay_arrow_bitmap
))
4568 from
->redraw_fringe_bitmaps_p
= 1;
4569 assign_row (to
, from
);
4570 to
->enabled_p
= 1, from
->enabled_p
= 0;
4571 to
->overlapped_p
= to_overlapped_p
;
4575 /* Clear the hash table, for the next time. */
4576 for (i
= 0; i
< row_entry_idx
; ++i
)
4577 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4579 /* Value is 1 to indicate that we scrolled the display. */
4585 /************************************************************************
4587 ************************************************************************/
4589 /* Update the desired frame matrix of frame F.
4591 FORCE_P non-zero means that the update should not be stopped by
4592 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4593 should not be tried.
4595 Value is non-zero if update was stopped due to pending input. */
4598 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4600 /* Frame matrices to work on. */
4601 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4602 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4605 int preempt_count
= baud_rate
/ 2400 + 1;
4607 xassert (current_matrix
&& desired_matrix
);
4609 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4610 calculate_costs (f
);
4612 if (preempt_count
<= 0)
4615 #if !PERIODIC_PREEMPTION_CHECKING
4616 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4623 /* If we cannot insert/delete lines, it's no use trying it. */
4624 if (!FRAME_LINE_INS_DEL_OK (f
))
4627 /* See if any of the desired lines are enabled; don't compute for
4628 i/d line if just want cursor motion. */
4629 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4630 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4633 /* Try doing i/d line, if not yet inhibited. */
4634 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4635 force_p
|= scrolling (f
);
4637 /* Update the individual lines as needed. Do bottom line first. */
4638 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4639 update_frame_line (f
, desired_matrix
->nrows
- 1);
4641 /* Now update the rest of the lines. */
4642 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4644 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4646 if (FRAME_TERMCAP_P (f
))
4648 /* Flush out every so many lines.
4649 Also flush out if likely to have more than 1k buffered
4650 otherwise. I'm told that some telnet connections get
4651 really screwed by more than 1k output at once. */
4652 FILE *display_output
= FRAME_TTY (f
)->output
;
4655 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4657 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4659 fflush (display_output
);
4660 if (preempt_count
== 1)
4662 #ifdef EMACS_OUTQSIZE
4663 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4664 /* Probably not a tty. Ignore the error and reset
4666 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4669 if (baud_rate
<= outq
&& baud_rate
> 0)
4670 sleep (outq
/ baud_rate
);
4676 #if PERIODIC_PREEMPTION_CHECKING
4680 EMACS_GET_TIME (tm
);
4681 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4682 if (EMACS_TIME_NEG_P (dif
))
4684 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4685 if (detect_input_pending_ignore_squeezables ())
4690 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4691 detect_input_pending_ignore_squeezables ();
4694 update_frame_line (f
, i
);
4698 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4700 /* Now just clean up termcap drivers and set cursor, etc. */
4703 if ((cursor_in_echo_area
4704 /* If we are showing a message instead of the mini-buffer,
4705 show the cursor for the message instead of for the
4706 (now hidden) mini-buffer contents. */
4707 || (EQ (minibuf_window
, selected_window
)
4708 && EQ (minibuf_window
, echo_area_window
)
4709 && !NILP (echo_area_buffer
[0])))
4710 /* These cases apply only to the frame that contains
4711 the active mini-buffer window. */
4712 && FRAME_HAS_MINIBUF_P (f
)
4713 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4715 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4718 if (cursor_in_echo_area
< 0)
4720 /* Negative value of cursor_in_echo_area means put
4721 cursor at beginning of line. */
4727 /* Positive value of cursor_in_echo_area means put
4728 cursor at the end of the prompt. If the mini-buffer
4729 is several lines high, find the last line that has
4731 row
= FRAME_LINES (f
);
4737 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4739 /* Frame rows are filled up with spaces that
4740 must be ignored here. */
4741 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4743 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4744 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4747 && (last
- 1)->charpos
< 0)
4753 while (row
> top
&& col
== 0);
4755 /* Make sure COL is not out of range. */
4756 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4758 /* If we have another row, advance cursor into it. */
4759 if (row
< FRAME_LINES (f
) - 1)
4761 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4764 /* Otherwise move it back in range. */
4766 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4770 cursor_to (f
, row
, col
);
4774 /* We have only one cursor on terminal frames. Use it to
4775 display the cursor of the selected window. */
4776 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4777 if (w
->cursor
.vpos
>= 0
4778 /* The cursor vpos may be temporarily out of bounds
4779 in the following situation: There is one window,
4780 with the cursor in the lower half of it. The window
4781 is split, and a message causes a redisplay before
4782 a new cursor position has been computed. */
4783 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4785 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4786 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4788 if (INTEGERP (w
->left_margin_cols
))
4789 x
+= XFASTINT (w
->left_margin_cols
);
4791 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4792 cursor_to (f
, y
, x
);
4797 #if !PERIODIC_PREEMPTION_CHECKING
4801 clear_desired_matrices (f
);
4806 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4809 scrolling (struct frame
*frame
)
4811 int unchanged_at_top
, unchanged_at_bottom
;
4814 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4815 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4816 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4817 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4819 int free_at_end_vpos
= FRAME_LINES (frame
);
4820 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4821 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4823 if (!current_matrix
)
4826 /* Compute hash codes of all the lines. Also calculate number of
4827 changed lines, number of unchanged lines at the beginning, and
4828 number of unchanged lines at the end. */
4830 unchanged_at_top
= 0;
4831 unchanged_at_bottom
= FRAME_LINES (frame
);
4832 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4834 /* Give up on this scrolling if some old lines are not enabled. */
4835 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4837 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4838 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4840 /* This line cannot be redrawn, so don't let scrolling mess it. */
4841 new_hash
[i
] = old_hash
[i
];
4842 #define INFINITY 1000000 /* Taken from scroll.c */
4843 draw_cost
[i
] = INFINITY
;
4847 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4848 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4851 if (old_hash
[i
] != new_hash
[i
])
4854 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4856 else if (i
== unchanged_at_top
)
4858 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4861 /* If changed lines are few, don't allow preemption, don't scroll. */
4862 if ((!FRAME_SCROLL_REGION_OK (frame
)
4863 && changed_lines
< baud_rate
/ 2400)
4864 || unchanged_at_bottom
== FRAME_LINES (frame
))
4867 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4868 - unchanged_at_bottom
);
4870 if (FRAME_SCROLL_REGION_OK (frame
))
4871 free_at_end_vpos
-= unchanged_at_bottom
;
4872 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4873 free_at_end_vpos
= -1;
4875 /* If large window, fast terminal and few lines in common between
4876 current frame and desired frame, don't bother with i/d calc. */
4877 if (!FRAME_SCROLL_REGION_OK (frame
)
4878 && window_size
>= 18 && baud_rate
> 2400
4880 10 * scrolling_max_lines_saved (unchanged_at_top
,
4881 FRAME_LINES (frame
) - unchanged_at_bottom
,
4882 old_hash
, new_hash
, draw_cost
)))
4885 if (window_size
< 2)
4888 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4889 draw_cost
+ unchanged_at_top
- 1,
4890 old_draw_cost
+ unchanged_at_top
- 1,
4891 old_hash
+ unchanged_at_top
- 1,
4892 new_hash
+ unchanged_at_top
- 1,
4893 free_at_end_vpos
- unchanged_at_top
);
4899 /* Count the number of blanks at the start of the vector of glyphs R
4900 which is LEN glyphs long. */
4903 count_blanks (struct glyph
*r
, int len
)
4907 for (i
= 0; i
< len
; ++i
)
4908 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4915 /* Count the number of glyphs in common at the start of the glyph
4916 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4917 of STR2. Value is the number of equal glyphs equal at the start. */
4920 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4922 struct glyph
*p1
= str1
;
4923 struct glyph
*p2
= str2
;
4927 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4934 /* Char insertion/deletion cost vector, from term.c */
4936 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
4939 /* Perform a frame-based update on line VPOS in frame FRAME. */
4942 update_frame_line (struct frame
*f
, int vpos
)
4944 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4946 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4947 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4948 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4949 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4950 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4951 int must_write_whole_line_p
;
4952 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4953 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4954 != FACE_TTY_DEFAULT_BG_COLOR
);
4956 if (colored_spaces_p
)
4959 /* Current row not enabled means it has unknown contents. We must
4960 write the whole desired line in that case. */
4961 must_write_whole_line_p
= !current_row
->enabled_p
;
4962 if (must_write_whole_line_p
)
4969 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4970 olen
= current_row
->used
[TEXT_AREA
];
4972 /* Ignore trailing spaces, if we can. */
4973 if (!write_spaces_p
)
4974 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4978 current_row
->enabled_p
= 1;
4979 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4981 /* If desired line is empty, just clear the line. */
4982 if (!desired_row
->enabled_p
)
4988 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4989 nlen
= desired_row
->used
[TEXT_AREA
];
4990 nend
= nbody
+ nlen
;
4992 /* If display line has unknown contents, write the whole line. */
4993 if (must_write_whole_line_p
)
4995 /* Ignore spaces at the end, if we can. */
4996 if (!write_spaces_p
)
4997 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5000 /* Write the contents of the desired line. */
5003 cursor_to (f
, vpos
, 0);
5004 write_glyphs (f
, nbody
, nlen
);
5007 /* Don't call clear_end_of_line if we already wrote the whole
5008 line. The cursor will not be at the right margin in that
5009 case but in the line below. */
5010 if (nlen
< FRAME_TOTAL_COLS (f
))
5012 cursor_to (f
, vpos
, nlen
);
5013 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5016 /* Make sure we are in the right row, otherwise cursor movement
5017 with cmgoto might use `ch' in the wrong row. */
5018 cursor_to (f
, vpos
, 0);
5020 make_current (desired_matrix
, current_matrix
, vpos
);
5024 /* Pretend trailing spaces are not there at all,
5025 unless for one reason or another we must write all spaces. */
5026 if (!write_spaces_p
)
5027 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5030 /* If there's no i/d char, quickly do the best we can without it. */
5031 if (!FRAME_CHAR_INS_DEL_OK (f
))
5035 /* Find the first glyph in desired row that doesn't agree with
5036 a glyph in the current row, and write the rest from there on. */
5037 for (i
= 0; i
< nlen
; i
++)
5039 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5041 /* Find the end of the run of different glyphs. */
5045 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5046 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5049 /* Output this run of non-matching chars. */
5050 cursor_to (f
, vpos
, i
);
5051 write_glyphs (f
, nbody
+ i
, j
- i
);
5054 /* Now find the next non-match. */
5058 /* Clear the rest of the line, or the non-clear part of it. */
5061 cursor_to (f
, vpos
, nlen
);
5062 clear_end_of_line (f
, olen
);
5065 /* Make current row = desired row. */
5066 make_current (desired_matrix
, current_matrix
, vpos
);
5070 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5071 characters in a row. */
5075 /* If current line is blank, skip over initial spaces, if
5076 possible, and write the rest. */
5080 nsp
= count_blanks (nbody
, nlen
);
5084 cursor_to (f
, vpos
, nsp
);
5085 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5088 /* Exchange contents between current_frame and new_frame. */
5089 make_current (desired_matrix
, current_matrix
, vpos
);
5093 /* Compute number of leading blanks in old and new contents. */
5094 osp
= count_blanks (obody
, olen
);
5095 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5097 /* Compute number of matching chars starting with first non-blank. */
5098 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5099 nbody
+ nsp
, nbody
+ nlen
);
5101 /* Spaces in new match implicit space past the end of old. */
5102 /* A bug causing this to be a no-op was fixed in 18.29. */
5103 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5106 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5110 /* Avoid doing insert/delete char
5111 just cause number of leading spaces differs
5112 when the following text does not match. */
5113 if (begmatch
== 0 && osp
!= nsp
)
5114 osp
= nsp
= min (osp
, nsp
);
5116 /* Find matching characters at end of line */
5119 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5121 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5126 endmatch
= obody
+ olen
- op1
;
5128 /* tem gets the distance to insert or delete.
5129 endmatch is how many characters we save by doing so.
5132 tem
= (nlen
- nsp
) - (olen
- osp
);
5134 && (!FRAME_CHAR_INS_DEL_OK (f
)
5135 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5138 /* nsp - osp is the distance to insert or delete.
5139 If that is nonzero, begmatch is known to be nonzero also.
5140 begmatch + endmatch is how much we save by doing the ins/del.
5144 && (!FRAME_CHAR_INS_DEL_OK (f
)
5145 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5149 osp
= nsp
= min (osp
, nsp
);
5152 /* Now go through the line, inserting, writing and
5153 deleting as appropriate. */
5157 cursor_to (f
, vpos
, nsp
);
5158 delete_glyphs (f
, osp
- nsp
);
5162 /* If going to delete chars later in line
5163 and insert earlier in the line,
5164 must delete first to avoid losing data in the insert */
5165 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5167 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5168 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5169 olen
= nlen
- (nsp
- osp
);
5171 cursor_to (f
, vpos
, osp
);
5172 insert_glyphs (f
, 0, nsp
- osp
);
5176 tem
= nsp
+ begmatch
+ endmatch
;
5177 if (nlen
!= tem
|| olen
!= tem
)
5179 if (!endmatch
|| nlen
== olen
)
5181 /* If new text being written reaches right margin, there is
5182 no need to do clear-to-eol at the end of this function
5183 (and it would not be safe, since cursor is not going to
5184 be "at the margin" after the text is done). */
5185 if (nlen
== FRAME_TOTAL_COLS (f
))
5188 /* Function write_glyphs is prepared to do nothing
5189 if passed a length <= 0. Check it here to avoid
5190 unnecessary cursor movement. */
5193 cursor_to (f
, vpos
, nsp
+ begmatch
);
5194 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5197 else if (nlen
> olen
)
5199 /* Here, we used to have the following simple code:
5200 ----------------------------------------
5201 write_glyphs (nbody + nsp + begmatch, olen - tem);
5202 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5203 ----------------------------------------
5204 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5205 is a padding glyph. */
5206 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5209 cursor_to (f
, vpos
, nsp
+ begmatch
);
5211 /* Calculate columns we can actually overwrite. */
5212 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5214 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5216 /* If we left columns to be overwritten, we must delete them. */
5217 del
= olen
- tem
- out
;
5219 delete_glyphs (f
, del
);
5221 /* At last, we insert columns not yet written out. */
5222 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5225 else if (olen
> nlen
)
5227 cursor_to (f
, vpos
, nsp
+ begmatch
);
5228 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5229 delete_glyphs (f
, olen
- nlen
);
5235 /* If any unerased characters remain after the new line, erase them. */
5238 cursor_to (f
, vpos
, nlen
);
5239 clear_end_of_line (f
, olen
);
5242 /* Exchange contents between current_frame and new_frame. */
5243 make_current (desired_matrix
, current_matrix
, vpos
);
5248 /***********************************************************************
5249 X/Y Position -> Buffer Position
5250 ***********************************************************************/
5252 /* Determine what's under window-relative pixel position (*X, *Y).
5253 Return the OBJECT (string or buffer) that's there.
5254 Return in *POS the position in that object.
5255 Adjust *X and *Y to character positions.
5256 Return in *DX and *DY the pixel coordinates of the click,
5257 relative to the top left corner of OBJECT, or relative to
5258 the top left corner of the character glyph at (*X, *Y)
5260 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5261 if the coordinates point to an empty area of the display. */
5264 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
)
5267 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5268 struct text_pos startp
;
5270 struct glyph_row
*row
;
5271 #ifdef HAVE_WINDOW_SYSTEM
5272 struct image
*img
= 0;
5276 /* We used to set current_buffer directly here, but that does the
5277 wrong thing with `face-remapping-alist' (bug#2044). */
5278 Fset_buffer (w
->buffer
);
5279 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5280 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5281 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5282 start_display (&it
, w
, startp
);
5286 /* First, move to the beginning of the row corresponding to *Y. We
5287 need to be in that row to get the correct value of base paragraph
5288 direction for the text at (*X, *Y). */
5289 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5291 /* TO_X is the pixel position that the iterator will compute for the
5292 glyph at *X. We add it.first_visible_x because iterator
5293 positions include the hscroll. */
5294 to_x
= x0
+ it
.first_visible_x
;
5295 if (it
.bidi_it
.paragraph_dir
== R2L
)
5296 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5297 text area. This is because the iterator, even in R2L
5298 paragraphs, delivers glyphs as if they started at the left
5299 margin of the window. (When we actually produce glyphs for
5300 display, we reverse their order in PRODUCE_GLYPHS, but the
5301 iterator doesn't know about that.) The following line adjusts
5302 the pixel position to the iterator geometry, which is what
5303 move_it_* routines use. (The -1 is because in a window whose
5304 text-area width is W, the rightmost pixel position is W-1, and
5305 it should be mirrored into zero pixel position.) */
5306 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5308 /* Now move horizontally in the row to the glyph under *X. Second
5309 argument is ZV to prevent move_it_in_display_line from matching
5310 based on buffer positions. */
5311 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5313 Fset_buffer (old_current_buffer
);
5315 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5316 *dy
= *y
- it
.current_y
;
5319 if (STRINGP (it
.string
))
5322 if (it
.what
== IT_COMPOSITION
5323 && it
.cmp_it
.nchars
> 1
5324 && it
.cmp_it
.reversed_p
)
5326 /* The current display element is a grapheme cluster in a
5327 composition. In that case, we need the position of the first
5328 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5329 it.current points to the last character of the cluster, thus
5330 we must move back to the first character of the same
5332 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5333 if (STRINGP (it
.string
))
5334 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5336 BYTEPOS (pos
->pos
) = CHAR_TO_BYTE (CHARPOS (pos
->pos
));
5339 #ifdef HAVE_WINDOW_SYSTEM
5340 if (it
.what
== IT_IMAGE
)
5342 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5343 && !NILP (img
->spec
))
5344 *object
= img
->spec
;
5348 if (it
.vpos
< w
->current_matrix
->nrows
5349 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5352 if (it
.hpos
< row
->used
[TEXT_AREA
])
5354 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5355 #ifdef HAVE_WINDOW_SYSTEM
5358 *dy
-= row
->ascent
- glyph
->ascent
;
5359 *dx
+= glyph
->slice
.img
.x
;
5360 *dy
+= glyph
->slice
.img
.y
;
5361 /* Image slices positions are still relative to the entire image */
5362 *width
= img
->width
;
5363 *height
= img
->height
;
5368 *width
= glyph
->pixel_width
;
5369 *height
= glyph
->ascent
+ glyph
->descent
;
5375 *height
= row
->height
;
5380 *width
= *height
= 0;
5383 /* Add extra (default width) columns if clicked after EOL. */
5384 x1
= max(0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5386 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5395 /* Value is the string under window-relative coordinates X/Y in the
5396 mode line or header line (PART says which) of window W, or nil if none.
5397 *CHARPOS is set to the position in the string returned. */
5400 mode_line_string (struct window
*w
, enum window_part part
,
5401 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5402 int *dx
, int *dy
, int *width
, int *height
)
5404 struct glyph_row
*row
;
5405 struct glyph
*glyph
, *end
;
5407 Lisp_Object string
= Qnil
;
5409 if (part
== ON_MODE_LINE
)
5410 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5412 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5414 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5416 if (row
->mode_line_p
&& row
->enabled_p
)
5418 /* Find the glyph under X. If we find one with a string object,
5419 it's the one we were looking for. */
5420 glyph
= row
->glyphs
[TEXT_AREA
];
5421 end
= glyph
+ row
->used
[TEXT_AREA
];
5422 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5423 x0
-= glyph
->pixel_width
;
5424 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5427 string
= glyph
->object
;
5428 *charpos
= glyph
->charpos
;
5429 *width
= glyph
->pixel_width
;
5430 *height
= glyph
->ascent
+ glyph
->descent
;
5431 #ifdef HAVE_WINDOW_SYSTEM
5432 if (glyph
->type
== IMAGE_GLYPH
)
5435 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5437 *object
= img
->spec
;
5438 y0
-= row
->ascent
- glyph
->ascent
;
5444 /* Add extra (default width) columns if clicked after EOL. */
5445 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5447 *height
= row
->height
;
5454 *width
= *height
= 0;
5464 /* Value is the string under window-relative coordinates X/Y in either
5465 marginal area, or nil if none. *CHARPOS is set to the position in
5466 the string returned. */
5469 marginal_area_string (struct window
*w
, enum window_part part
,
5470 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5471 int *dx
, int *dy
, int *width
, int *height
)
5473 struct glyph_row
*row
= w
->current_matrix
->rows
;
5474 struct glyph
*glyph
, *end
;
5475 int x0
, y0
, i
, wy
= *y
;
5477 Lisp_Object string
= Qnil
;
5479 if (part
== ON_LEFT_MARGIN
)
5480 area
= LEFT_MARGIN_AREA
;
5481 else if (part
== ON_RIGHT_MARGIN
)
5482 area
= RIGHT_MARGIN_AREA
;
5486 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5487 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5490 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5494 /* Find the glyph under X. If we find one with a string object,
5495 it's the one we were looking for. */
5496 if (area
== RIGHT_MARGIN_AREA
)
5497 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5498 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5499 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5500 + window_box_width (w
, LEFT_MARGIN_AREA
)
5501 + window_box_width (w
, TEXT_AREA
));
5503 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5504 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5507 glyph
= row
->glyphs
[area
];
5508 end
= glyph
+ row
->used
[area
];
5509 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5510 x0
-= glyph
->pixel_width
;
5511 *x
= glyph
- row
->glyphs
[area
];
5514 string
= glyph
->object
;
5515 *charpos
= glyph
->charpos
;
5516 *width
= glyph
->pixel_width
;
5517 *height
= glyph
->ascent
+ glyph
->descent
;
5518 #ifdef HAVE_WINDOW_SYSTEM
5519 if (glyph
->type
== IMAGE_GLYPH
)
5522 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5524 *object
= img
->spec
;
5525 y0
-= row
->ascent
- glyph
->ascent
;
5526 x0
+= glyph
->slice
.img
.x
;
5527 y0
+= glyph
->slice
.img
.y
;
5533 /* Add extra (default width) columns if clicked after EOL. */
5534 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5536 *height
= row
->height
;
5543 *width
= *height
= 0;
5553 /***********************************************************************
5554 Changing Frame Sizes
5555 ***********************************************************************/
5560 window_change_signal (int signalnum
) /* If we don't have an argument, */
5561 /* some compilers complain in signal calls. */
5564 int old_errno
= errno
;
5566 struct tty_display_info
*tty
;
5568 signal (SIGWINCH
, window_change_signal
);
5569 SIGNAL_THREAD_CHECK (signalnum
);
5571 /* The frame size change obviously applies to a single
5572 termcap-controlled terminal, but we can't decide which.
5573 Therefore, we resize the frames corresponding to each tty.
5575 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5577 if (! tty
->term_initted
)
5580 /* Suspended tty frames have tty->input == NULL avoid trying to
5585 get_tty_size (fileno (tty
->input
), &width
, &height
);
5587 if (width
> 5 && height
> 2) {
5588 Lisp_Object tail
, frame
;
5590 FOR_EACH_FRAME (tail
, frame
)
5591 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5592 /* Record the new sizes, but don't reallocate the data
5593 structures now. Let that be done later outside of the
5595 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5601 #endif /* SIGWINCH */
5604 /* Do any change in frame size that was requested by a signal. SAFE
5605 non-zero means this function is called from a place where it is
5606 safe to change frame sizes while a redisplay is in progress. */
5609 do_pending_window_change (int safe
)
5611 /* If window_change_signal should have run before, run it now. */
5612 if (redisplaying_p
&& !safe
)
5615 while (delayed_size_change
)
5617 Lisp_Object tail
, frame
;
5619 delayed_size_change
= 0;
5621 FOR_EACH_FRAME (tail
, frame
)
5623 struct frame
*f
= XFRAME (frame
);
5625 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5626 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5633 /* Change the frame height and/or width. Values may be given as zero to
5634 indicate no change is to take place.
5636 If DELAY is non-zero, then assume we're being called from a signal
5637 handler, and queue the change for later - perhaps the next
5638 redisplay. Since this tries to resize windows, we can't call it
5639 from a signal handler.
5641 SAFE non-zero means this function is called from a place where it's
5642 safe to change frame sizes while a redisplay is in progress. */
5645 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5647 Lisp_Object tail
, frame
;
5649 if (FRAME_MSDOS_P (f
))
5651 /* On MS-DOS, all frames use the same screen, so a change in
5652 size affects all frames. Termcap now supports multiple
5654 FOR_EACH_FRAME (tail
, frame
)
5655 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5656 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5657 pretend
, delay
, safe
);
5660 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5664 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5666 int new_frame_total_cols
;
5667 int count
= SPECPDL_INDEX ();
5669 /* If we can't deal with the change now, queue it for later. */
5670 if (delay
|| (redisplaying_p
&& !safe
))
5672 f
->new_text_lines
= newheight
;
5673 f
->new_text_cols
= newwidth
;
5674 delayed_size_change
= 1;
5678 /* This size-change overrides any pending one for this frame. */
5679 f
->new_text_lines
= 0;
5680 f
->new_text_cols
= 0;
5682 /* If an argument is zero, set it to the current value. */
5684 newheight
= FRAME_LINES (f
);
5686 newwidth
= FRAME_COLS (f
);
5688 /* Compute width of windows in F.
5689 This is the width of the frame without vertical scroll bars. */
5690 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5692 /* Round up to the smallest acceptable size. */
5693 check_frame_size (f
, &newheight
, &newwidth
);
5695 /* If we're not changing the frame size, quit now. */
5696 /* Frame width may be unchanged but the text portion may change, for example,
5697 fullscreen and remove/add scroll bar. */
5698 if (newheight
== FRAME_LINES (f
)
5699 && newwidth
== FRAME_COLS (f
) // text portion unchanged
5700 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
)) // frame width unchanged
5706 /* We only can set screen dimensions to certain values supported
5707 by our video hardware. Try to find the smallest size greater
5708 or equal to the requested dimensions. */
5709 dos_set_window_size (&newheight
, &newwidth
);
5712 if (newheight
!= FRAME_LINES (f
))
5714 resize_frame_windows (f
, newheight
, 0);
5716 /* MSDOS frames cannot PRETEND, as they change frame size by
5717 manipulating video hardware. */
5718 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5719 FrameRows (FRAME_TTY (f
)) = newheight
;
5722 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5724 resize_frame_windows (f
, new_frame_total_cols
, 1);
5726 /* MSDOS frames cannot PRETEND, as they change frame size by
5727 manipulating video hardware. */
5728 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5729 FrameCols (FRAME_TTY (f
)) = newwidth
;
5731 if (WINDOWP (f
->tool_bar_window
))
5732 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5735 FRAME_LINES (f
) = newheight
;
5736 SET_FRAME_COLS (f
, newwidth
);
5739 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5740 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5742 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5744 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5745 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5746 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5747 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5751 calculate_costs (f
);
5752 SET_FRAME_GARBAGED (f
);
5757 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5759 run_window_configuration_change_hook (f
);
5761 unbind_to (count
, Qnil
);
5766 /***********************************************************************
5767 Terminal Related Lisp Functions
5768 ***********************************************************************/
5770 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5771 1, 1, "FOpen termscript file: ",
5772 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5773 FILE = nil means just close any termscript file currently open. */)
5776 struct tty_display_info
*tty
;
5778 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5779 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5780 error ("Current frame is not on a tty device");
5784 if (tty
->termscript
!= 0)
5787 fclose (tty
->termscript
);
5790 tty
->termscript
= 0;
5794 file
= Fexpand_file_name (file
, Qnil
);
5795 tty
->termscript
= fopen (SSDATA (file
), "w");
5796 if (tty
->termscript
== 0)
5797 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5803 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5804 Ssend_string_to_terminal
, 1, 2, 0,
5805 doc
: /* Send STRING to the terminal without alteration.
5806 Control characters in STRING will have terminal-dependent effects.
5808 Optional parameter TERMINAL specifies the tty terminal device to use.
5809 It may be a terminal object, a frame, or nil for the terminal used by
5810 the currently selected frame. In batch mode, STRING is sent to stdout
5811 when TERMINAL is nil. */)
5812 (Lisp_Object string
, Lisp_Object terminal
)
5814 struct terminal
*t
= get_terminal (terminal
, 1);
5817 /* ??? Perhaps we should do something special for multibyte strings here. */
5818 CHECK_STRING (string
);
5822 error ("Unknown terminal device");
5824 if (t
->type
== output_initial
)
5826 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5827 error ("Device %d is not a termcap terminal device", t
->id
);
5830 struct tty_display_info
*tty
= t
->display_info
.tty
;
5833 error ("Terminal is currently suspended");
5835 if (tty
->termscript
)
5837 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5838 fflush (tty
->termscript
);
5842 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5849 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5850 doc
: /* Beep, or flash the screen.
5851 Also, unless an argument is given,
5852 terminate any keyboard macro currently executing. */)
5860 ring_bell (XFRAME (selected_frame
));
5869 bitch_at_user (void)
5873 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5874 error ("Keyboard macro terminated by a command ringing the bell");
5876 ring_bell (XFRAME (selected_frame
));
5881 /***********************************************************************
5883 ***********************************************************************/
5885 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5886 doc
: /* Pause, without updating display, for SECONDS seconds.
5887 SECONDS may be a floating-point value, meaning that you can wait for a
5888 fraction of a second. Optional second arg MILLISECONDS specifies an
5889 additional wait period, in milliseconds; this may be useful if your
5890 Emacs was built without floating point support.
5891 \(Not all operating systems support waiting for a fraction of a second.) */)
5892 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5896 if (NILP (milliseconds
))
5897 XSETINT (milliseconds
, 0);
5899 CHECK_NUMBER (milliseconds
);
5900 usec
= XINT (milliseconds
) * 1000;
5903 double duration
= extract_float (seconds
);
5904 sec
= (int) duration
;
5905 usec
+= (duration
- sec
) * 1000000;
5908 #ifndef EMACS_HAS_USECS
5909 if (sec
== 0 && usec
!= 0)
5910 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
5913 /* Assure that 0 <= usec < 1000000. */
5916 /* We can't rely on the rounding being correct if usec is negative. */
5917 if (-1000000 < usec
)
5918 sec
--, usec
+= 1000000;
5920 sec
-= -usec
/ 1000000, usec
= 1000000 - (-usec
% 1000000);
5923 sec
+= usec
/ 1000000, usec
%= 1000000;
5925 if (sec
< 0 || (sec
== 0 && usec
== 0))
5928 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
5934 /* This is just like wait_reading_process_output, except that
5937 TIMEOUT is number of seconds to wait (float or integer),
5938 or t to wait forever.
5939 READING is 1 if reading input.
5940 If DO_DISPLAY is >0 display process output while waiting.
5941 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5945 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5949 swallow_events (do_display
);
5951 if ((detect_input_pending_run_timers (do_display
))
5952 || !NILP (Vexecuting_kbd_macro
))
5955 if (do_display
>= 2)
5956 redisplay_preserve_echo_area (2);
5958 if (INTEGERP (timeout
))
5960 sec
= XINT (timeout
);
5963 else if (FLOATP (timeout
))
5965 double seconds
= XFLOAT_DATA (timeout
);
5966 sec
= (int) seconds
;
5967 usec
= (int) ((seconds
- sec
) * 1000000);
5969 else if (EQ (timeout
, Qt
))
5975 wrong_type_argument (Qnumberp
, timeout
);
5977 if (sec
== 0 && usec
== 0 && !EQ (timeout
, Qt
))
5984 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
5987 return detect_input_pending () ? Qnil
: Qt
;
5991 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5992 doc
: /* Perform redisplay if no input is available.
5993 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
5994 perform a full redisplay even if input is available.
5995 Return t if redisplay was performed, nil otherwise. */)
6001 if ((detect_input_pending_run_timers (1)
6002 && NILP (force
) && !redisplay_dont_pause
)
6003 || !NILP (Vexecuting_kbd_macro
))
6006 count
= SPECPDL_INDEX ();
6007 if (!NILP (force
) && !redisplay_dont_pause
)
6008 specbind (Qredisplay_dont_pause
, Qt
);
6009 redisplay_preserve_echo_area (2);
6010 unbind_to (count
, Qnil
);
6016 /***********************************************************************
6017 Other Lisp Functions
6018 ***********************************************************************/
6020 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6021 session's frames, frame names, buffers, buffer-read-only flags, and
6022 buffer-modified-flags. */
6024 static Lisp_Object frame_and_buffer_state
;
6027 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6028 Sframe_or_buffer_changed_p
, 0, 1, 0,
6029 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6030 VARIABLE is a variable name whose value is either nil or a state vector
6031 that will be updated to contain all frames and buffers,
6032 aside from buffers whose names start with space,
6033 along with the buffers' read-only and modified flags. This allows a fast
6034 check to see whether buffer menus might need to be recomputed.
6035 If this function returns non-nil, it updates the internal vector to reflect
6038 If VARIABLE is nil, an internal variable is used. Users should not
6039 pass nil for VARIABLE. */)
6040 (Lisp_Object variable
)
6042 Lisp_Object state
, tail
, frame
, buf
;
6043 Lisp_Object
*vecp
, *end
;
6046 if (! NILP (variable
))
6048 CHECK_SYMBOL (variable
);
6049 state
= Fsymbol_value (variable
);
6050 if (! VECTORP (state
))
6054 state
= frame_and_buffer_state
;
6056 vecp
= XVECTOR (state
)->contents
;
6057 end
= vecp
+ ASIZE (state
);
6059 FOR_EACH_FRAME (tail
, frame
)
6063 if (!EQ (*vecp
++, frame
))
6067 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6070 /* Check that the buffer info matches. */
6071 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6073 buf
= XCDR (XCAR (tail
));
6074 /* Ignore buffers that aren't included in buffer lists. */
6075 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6079 if (!EQ (*vecp
++, buf
))
6083 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6087 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6092 /* Detect deletion of a buffer at the end of the list. */
6093 if (EQ (*vecp
, Qlambda
))
6096 /* Come here if we decide the data has changed. */
6098 /* Count the size we will need.
6099 Start with 1 so there is room for at least one lambda at the end. */
6101 FOR_EACH_FRAME (tail
, frame
)
6103 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6105 /* Reallocate the vector if data has grown to need it,
6106 or if it has shrunk a lot. */
6107 if (! VECTORP (state
)
6108 || n
> ASIZE (state
)
6109 || n
+ 20 < ASIZE (state
) / 2)
6110 /* Add 20 extra so we grow it less often. */
6112 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6113 if (! NILP (variable
))
6114 Fset (variable
, state
);
6116 frame_and_buffer_state
= state
;
6119 /* Record the new data in the (possibly reallocated) vector. */
6120 vecp
= XVECTOR (state
)->contents
;
6121 FOR_EACH_FRAME (tail
, frame
)
6124 *vecp
++ = XFRAME (frame
)->name
;
6126 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6128 buf
= XCDR (XCAR (tail
));
6129 /* Ignore buffers that aren't included in buffer lists. */
6130 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6133 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6134 *vecp
++ = Fbuffer_modified_p (buf
);
6136 /* Fill up the vector with lambdas (always at least one). */
6138 while (vecp
- XVECTOR (state
)->contents
6141 /* Make sure we didn't overflow the vector. */
6142 if (vecp
- XVECTOR (state
)->contents
6150 /***********************************************************************
6152 ***********************************************************************/
6154 /* Initialization done when Emacs fork is started, before doing stty.
6155 Determine terminal type and set terminal_driver. Then invoke its
6156 decoding routine to set up variables in the terminal package. */
6161 char *terminal_type
;
6163 /* Construct the space glyph. */
6164 space_glyph
.type
= CHAR_GLYPH
;
6165 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6166 space_glyph
.charpos
= -1;
6169 cursor_in_echo_area
= 0;
6170 terminal_type
= (char *) 0;
6172 /* Now is the time to initialize this; it's used by init_sys_modes
6174 Vinitial_window_system
= Qnil
;
6176 /* SIGWINCH needs to be handled no matter what display we start
6177 with. Otherwise newly opened tty frames will not resize
6182 #endif /* CANNOT_DUMP */
6183 signal (SIGWINCH
, window_change_signal
);
6184 #endif /* SIGWINCH */
6186 /* If running as a daemon, no need to initialize any frames/terminal. */
6190 /* If the user wants to use a window system, we shouldn't bother
6191 initializing the terminal. This is especially important when the
6192 terminal is so dumb that emacs gives up before and doesn't bother
6193 using the window system.
6195 If the DISPLAY environment variable is set and nonempty,
6196 try to use X, and die with an error message if that doesn't work. */
6198 #ifdef HAVE_X_WINDOWS
6199 if (! inhibit_window_system
&& ! display_arg
)
6202 display
= getenv ("DISPLAY");
6203 display_arg
= (display
!= 0 && *display
!= 0);
6205 if (display_arg
&& !x_display_ok (display
))
6207 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6209 inhibit_window_system
= 1;
6213 if (!inhibit_window_system
&& display_arg
6219 Vinitial_window_system
= Qx
;
6221 Vwindow_system_version
= make_number (11);
6223 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6224 /* In some versions of ncurses,
6225 tputs crashes if we have not called tgetent.
6227 { char b
[2044]; tgetent (b
, "xterm");}
6229 adjust_frame_glyphs_initially ();
6232 #endif /* HAVE_X_WINDOWS */
6235 if (!inhibit_window_system
)
6237 Vinitial_window_system
= Qw32
;
6238 Vwindow_system_version
= make_number (1);
6239 adjust_frame_glyphs_initially ();
6242 #endif /* HAVE_NTGUI */
6245 if (!inhibit_window_system
6251 Vinitial_window_system
= Qns
;
6252 Vwindow_system_version
= make_number(10);
6253 adjust_frame_glyphs_initially ();
6258 /* If no window system has been specified, try to use the terminal. */
6261 fatal ("standard input is not a tty");
6266 terminal_type
= "w32console";
6268 /* Look at the TERM variable. */
6269 terminal_type
= (char *) getenv ("TERM");
6273 #ifdef HAVE_WINDOW_SYSTEM
6274 if (! inhibit_window_system
)
6275 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6277 #endif /* HAVE_WINDOW_SYSTEM */
6278 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6284 struct frame
*f
= XFRAME (selected_frame
);
6286 /* Open a display on the controlling tty. */
6287 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6289 /* Convert the initial frame to use the new display. */
6290 if (f
->output_method
!= output_initial
)
6292 f
->output_method
= t
->type
;
6295 t
->reference_count
++;
6297 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6299 if (f
->output_method
== output_termcap
)
6300 create_tty_output (f
);
6302 t
->display_info
.tty
->top_frame
= selected_frame
;
6303 change_frame_size (XFRAME (selected_frame
),
6304 FrameRows (t
->display_info
.tty
),
6305 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6307 /* Delete the initial terminal. */
6308 if (--initial_terminal
->reference_count
== 0
6309 && initial_terminal
->delete_terminal_hook
)
6310 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6312 /* Update frame parameters to reflect the new type. */
6313 Fmodify_frame_parameters
6314 (selected_frame
, Fcons (Fcons (Qtty_type
,
6315 Ftty_type (selected_frame
)), Qnil
));
6316 if (t
->display_info
.tty
->name
)
6317 Fmodify_frame_parameters (selected_frame
,
6318 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6321 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6326 struct frame
*sf
= SELECTED_FRAME ();
6327 int width
= FRAME_TOTAL_COLS (sf
);
6328 int height
= FRAME_LINES (sf
);
6330 unsigned int total_glyphs
= height
* (width
+ 2) * sizeof (struct glyph
);
6332 /* If these sizes are so big they cause overflow, just ignore the
6333 change. It's not clear what better we could do. */
6334 if (total_glyphs
/ sizeof (struct glyph
) / height
!= width
+ 2)
6335 fatal ("screen size %dx%d too big", width
, height
);
6338 adjust_frame_glyphs_initially ();
6339 calculate_costs (XFRAME (selected_frame
));
6341 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6344 && NILP (Vinitial_window_system
))
6346 /* For the initial frame, we don't have any way of knowing what
6347 are the foreground and background colors of the terminal. */
6348 struct frame
*sf
= SELECTED_FRAME();
6350 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6351 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6352 call0 (intern ("tty-set-up-initial-frame-faces"));
6358 /***********************************************************************
6360 ***********************************************************************/
6362 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6363 Sinternal_show_cursor
, 2, 2, 0,
6364 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6365 WINDOW nil means use the selected window. SHOW non-nil means
6366 show a cursor in WINDOW in the next redisplay. SHOW nil means
6367 don't show a cursor. */)
6368 (Lisp_Object window
, Lisp_Object show
)
6370 /* Don't change cursor state while redisplaying. This could confuse
6372 if (!redisplaying_p
)
6375 window
= selected_window
;
6377 CHECK_WINDOW (window
);
6379 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6386 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6387 Sinternal_show_cursor_p
, 0, 1, 0,
6388 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6389 WINDOW nil or omitted means report on the selected window. */)
6390 (Lisp_Object window
)
6395 window
= selected_window
;
6397 CHECK_WINDOW (window
);
6399 w
= XWINDOW (window
);
6400 return w
->cursor_off_p
? Qnil
: Qt
;
6403 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6404 Slast_nonminibuf_frame
, 0, 0, 0,
6405 doc
: /* Value is last nonminibuffer frame. */)
6408 Lisp_Object frame
= Qnil
;
6410 if (last_nonminibuf_frame
)
6411 XSETFRAME (frame
, last_nonminibuf_frame
);
6416 /***********************************************************************
6418 ***********************************************************************/
6421 syms_of_display (void)
6423 defsubr (&Sredraw_frame
);
6424 defsubr (&Sredraw_display
);
6425 defsubr (&Sframe_or_buffer_changed_p
);
6426 defsubr (&Sopen_termscript
);
6428 defsubr (&Sredisplay
);
6429 defsubr (&Ssleep_for
);
6430 defsubr (&Ssend_string_to_terminal
);
6431 defsubr (&Sinternal_show_cursor
);
6432 defsubr (&Sinternal_show_cursor_p
);
6433 defsubr (&Slast_nonminibuf_frame
);
6436 defsubr (&Sdump_redisplay_history
);
6439 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6440 staticpro (&frame_and_buffer_state
);
6442 Qdisplay_table
= intern_c_string ("display-table");
6443 staticpro (&Qdisplay_table
);
6444 Qredisplay_dont_pause
= intern_c_string ("redisplay-dont-pause");
6445 staticpro (&Qredisplay_dont_pause
);
6447 DEFVAR_INT ("baud-rate", baud_rate
,
6448 doc
: /* *The output baud rate of the terminal.
6449 On most systems, changing this value will affect the amount of padding
6450 and the other strategic decisions made during redisplay. */);
6452 DEFVAR_BOOL ("inverse-video", inverse_video
,
6453 doc
: /* *Non-nil means invert the entire frame display.
6454 This means everything is in inverse video which otherwise would not be. */);
6456 DEFVAR_BOOL ("visible-bell", visible_bell
,
6457 doc
: /* *Non-nil means try to flash the frame to represent a bell.
6459 See also `ring-bell-function'. */);
6461 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6462 doc
: /* *Non-nil means no need to redraw entire frame after suspending.
6463 A non-nil value is useful if the terminal can automatically preserve
6464 Emacs's frame display when you reenter Emacs.
6465 It is up to you to set this variable if your terminal can do that. */);
6467 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6468 doc
: /* Name of the window system that Emacs uses for the first frame.
6469 The value is a symbol:
6470 nil for a termcap frame (a character-only terminal),
6471 'x' for an Emacs frame that is really an X window,
6472 'w32' for an Emacs frame that is a window on MS-Windows display,
6473 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6474 'pc' for a direct-write MS-DOS frame.
6476 Use of this variable as a boolean is deprecated. Instead,
6477 use `display-graphic-p' or any of the other `display-*-p'
6478 predicates which report frame's specific UI-related capabilities. */);
6480 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6481 doc
: /* Name of window system through which the selected frame is displayed.
6482 The value is a symbol:
6483 nil for a termcap frame (a character-only terminal),
6484 'x' for an Emacs frame that is really an X window,
6485 'w32' for an Emacs frame that is a window on MS-Windows display,
6486 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6487 'pc' for a direct-write MS-DOS frame.
6489 Use of this variable as a boolean is deprecated. Instead,
6490 use `display-graphic-p' or any of the other `display-*-p'
6491 predicates which report frame's specific UI-related capabilities. */);
6493 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6494 doc
: /* The version number of the window system in use.
6495 For X windows, this is 11. */);
6497 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6498 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6500 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6501 doc
: /* Table defining how to output a glyph code to the frame.
6502 If not nil, this is a vector indexed by glyph code to define the glyph.
6503 Each element can be:
6504 integer: a glyph code which this glyph is an alias for.
6505 string: output this glyph using that string (not impl. in X windows).
6506 nil: this glyph mod 524288 is the code of a character to output,
6507 and this glyph / 524288 is the face number (see `face-id') to use
6508 while outputting it. */);
6509 Vglyph_table
= Qnil
;
6511 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6512 doc
: /* Display table to use for buffers that specify none.
6513 See `buffer-display-table' for more information. */);
6514 Vstandard_display_table
= Qnil
;
6516 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6517 doc
: /* *Non-nil means update isn't paused when input is detected. */);
6518 redisplay_dont_pause
= 0;
6520 #if PERIODIC_PREEMPTION_CHECKING
6521 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6522 doc
: /* *The period in seconds between checking for input during redisplay.
6523 If input is detected, redisplay is pre-empted, and the input is processed.
6524 If nil, never pre-empt redisplay. */);
6525 Vredisplay_preemption_period
= make_float (0.10);
6532 Vinitial_window_system
= Qnil
;
6533 Vwindow_system_version
= Qnil
;