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 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 swap_glyph_pointers (struct glyph_row
*, struct glyph_row
*);
131 static int glyph_row_slice_p (struct glyph_row
*, struct glyph_row
*);
133 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
134 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
136 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
138 static struct glyph_pool
*new_glyph_pool (void);
139 static void free_glyph_pool (struct glyph_pool
*);
140 static void adjust_frame_glyphs_initially (void);
141 static void adjust_frame_message_buffer (struct frame
*);
142 static void adjust_decode_mode_spec_buffer (struct frame
*);
143 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
144 static void build_frame_matrix (struct frame
*);
145 void clear_current_matrices (struct frame
*);
146 void scroll_glyph_matrix_range (struct glyph_matrix
*, int, int,
148 static void clear_window_matrices (struct window
*, int);
149 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
150 static int scrolling_window (struct window
*, int);
151 static int update_window_line (struct window
*, int, int *);
152 static void update_marginal_area (struct window
*, int, int);
153 static int update_text_area (struct window
*, int);
154 static void make_current (struct glyph_matrix
*, struct glyph_matrix
*,
156 static void mirror_make_current (struct window
*, int);
157 void check_window_matrix_pointers (struct window
*);
159 static void check_matrix_pointers (struct glyph_matrix
*,
160 struct glyph_matrix
*);
162 static void mirror_line_dance (struct window
*, int, int, int *, char *);
163 static int update_window_tree (struct window
*, int);
164 static int update_window (struct window
*, int);
165 static int update_frame_1 (struct frame
*, int, int);
166 static void set_window_cursor_after_update (struct window
*);
167 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
168 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
171 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
172 are supported, so we can check for input during redisplay at
173 regular intervals. */
174 #ifdef EMACS_HAS_USECS
175 #define PERIODIC_PREEMPTION_CHECKING 1
177 #define PERIODIC_PREEMPTION_CHECKING 0
180 #if PERIODIC_PREEMPTION_CHECKING
182 /* Redisplay preemption timers. */
184 static EMACS_TIME preemption_period
;
185 static EMACS_TIME preemption_next_check
;
189 /* Nonzero upon entry to redisplay means do not assume anything about
190 current contents of actual terminal frame; clear and redraw it. */
194 /* Nonzero means last display completed. Zero means it was preempted. */
196 int display_completed
;
198 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
201 /* The currently selected frame. In a single-frame version, this
202 variable always equals the_only_frame. */
204 Lisp_Object selected_frame
;
206 /* A frame which is not just a mini-buffer, or 0 if there are no such
207 frames. This is usually the most recent such frame that was
208 selected. In a single-frame version, this variable always holds
209 the address of the_only_frame. */
211 struct frame
*last_nonminibuf_frame
;
213 /* 1 means SIGWINCH happened when not safe. */
215 int delayed_size_change
;
217 /* 1 means glyph initialization has been completed at startup. */
219 static int glyphs_initialized_initially_p
;
221 /* Updated window if != 0. Set by update_window. */
223 struct window
*updated_window
;
225 /* Glyph row updated in update_window_line, and area that is updated. */
227 struct glyph_row
*updated_row
;
230 /* A glyph for a space. */
232 struct glyph space_glyph
;
234 /* Counts of allocated structures. These counts serve to diagnose
235 memory leaks and double frees. */
237 int glyph_matrix_count
;
238 int glyph_pool_count
;
240 /* If non-null, the frame whose frame matrices are manipulated. If
241 null, window matrices are worked on. */
243 static struct frame
*frame_matrix_frame
;
245 /* Non-zero means that fonts have been loaded since the last glyph
246 matrix adjustments. Redisplay must stop, and glyph matrices must
247 be adjusted when this flag becomes non-zero during display. The
248 reason fonts can be loaded so late is that fonts of fontsets are
249 loaded on demand. Another reason is that a line contains many
250 characters displayed by zero width or very narrow glyphs of
251 variable-width fonts. */
255 /* Convert vpos and hpos from frame to window and vice versa.
256 This may only be used for terminal frames. */
260 static int window_to_frame_vpos (struct window
*, int);
261 static int window_to_frame_hpos (struct window
*, int);
262 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
263 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
265 /* One element of the ring buffer containing redisplay history
268 struct redisplay_history
270 char trace
[512 + 100];
273 /* The size of the history buffer. */
275 #define REDISPLAY_HISTORY_SIZE 30
277 /* The redisplay history buffer. */
279 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
281 /* Next free entry in redisplay_history. */
283 static int history_idx
;
285 /* A tick that's incremented each time something is added to the
288 static unsigned history_tick
;
290 static void add_frame_display_history (struct frame
*, int);
291 static void add_window_display_history (struct window
*, char *, int);
293 /* Add to the redisplay history how window W has been displayed.
294 MSG is a trace containing the information how W's glyph matrix
295 has been constructed. PAUSED_P non-zero means that the update
296 has been interrupted for pending input. */
299 add_window_display_history (struct window
*w
, char *msg
, int paused_p
)
303 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
305 buf
= redisplay_history
[history_idx
].trace
;
308 sprintf (buf
, "%d: window %p (`%s')%s\n",
311 ((BUFFERP (w
->buffer
)
312 && STRINGP (XBUFFER (w
->buffer
)->name
))
313 ? SSDATA (XBUFFER (w
->buffer
)->name
)
315 paused_p
? " ***paused***" : "");
320 /* Add to the redisplay history that frame F has been displayed.
321 PAUSED_P non-zero means that the update has been interrupted for
325 add_frame_display_history (struct frame
*f
, int paused_p
)
329 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
331 buf
= redisplay_history
[history_idx
].trace
;
334 sprintf (buf
, "%d: update frame %p%s",
336 f
, paused_p
? " ***paused***" : "");
340 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
341 Sdump_redisplay_history
, 0, 0, "",
342 doc
: /* Dump redisplay history to stderr. */)
347 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
350 i
= REDISPLAY_HISTORY_SIZE
- 1;
351 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
358 #else /* GLYPH_DEBUG == 0 */
360 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
361 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
363 #endif /* GLYPH_DEBUG == 0 */
366 #if defined PROFILING && !HAVE___EXECUTABLE_START
367 /* FIXME: only used to find text start for profiling. */
370 safe_bcopy (const char *from
, char *to
, int size
)
376 /***********************************************************************
378 ***********************************************************************/
380 /* Allocate and return a glyph_matrix structure. POOL is the glyph
381 pool from which memory for the matrix should be allocated, or null
382 for window-based redisplay where no glyph pools are used. The
383 member `pool' of the glyph matrix structure returned is set to
384 POOL, the structure is otherwise zeroed. */
386 struct glyph_matrix
*
387 new_glyph_matrix (struct glyph_pool
*pool
)
389 struct glyph_matrix
*result
;
391 /* Allocate and clear. */
392 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
393 memset (result
, 0, sizeof *result
);
395 /* Increment number of allocated matrices. This count is used
396 to detect memory leaks. */
397 ++glyph_matrix_count
;
399 /* Set pool and return. */
405 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
407 The global counter glyph_matrix_count is decremented when a matrix
408 is freed. If the count gets negative, more structures were freed
409 than allocated, i.e. one matrix was freed more than once or a bogus
410 pointer was passed to this function.
412 If MATRIX->pool is null, this means that the matrix manages its own
413 glyph memory---this is done for matrices on X frames. Freeing the
414 matrix also frees the glyph memory in this case. */
417 free_glyph_matrix (struct glyph_matrix
*matrix
)
423 /* Detect the case that more matrices are freed than were
425 if (--glyph_matrix_count
< 0)
428 /* Free glyph memory if MATRIX owns it. */
429 if (matrix
->pool
== NULL
)
430 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
431 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
433 /* Free row structures and the matrix itself. */
434 xfree (matrix
->rows
);
440 /* Return the number of glyphs to reserve for a marginal area of
441 window W. TOTAL_GLYPHS is the number of glyphs in a complete
442 display line of window W. MARGIN gives the width of the marginal
443 area in canonical character units. MARGIN should be an integer
447 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
451 if (NUMBERP (margin
))
453 int width
= XFASTINT (w
->total_cols
);
454 double d
= max (0, XFLOATINT (margin
));
455 d
= min (width
/ 2 - 1, d
);
456 n
= (int) ((double) total_glyphs
/ width
* d
);
465 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
468 W is null if the function is called for a frame glyph matrix.
469 Otherwise it is the window MATRIX is a member of. X and Y are the
470 indices of the first column and row of MATRIX within the frame
471 matrix, if such a matrix exists. They are zero for purely
472 window-based redisplay. DIM is the needed size of the matrix.
474 In window-based redisplay, where no frame matrices exist, glyph
475 matrices manage their own glyph storage. Otherwise, they allocate
476 storage from a common frame glyph pool which can be found in
479 The reason for this memory management strategy is to avoid complete
480 frame redraws if possible. When we allocate from a common pool, a
481 change of the location or size of a sub-matrix within the pool
482 requires a complete redisplay of the frame because we cannot easily
483 make sure that the current matrices of all windows still agree with
484 what is displayed on the screen. While this is usually fast, it
485 leads to screen flickering. */
488 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
492 int marginal_areas_changed_p
= 0;
493 int header_line_changed_p
= 0;
494 int header_line_p
= 0;
495 int left
= -1, right
= -1;
496 int window_width
= -1, window_height
= -1;
498 /* See if W had a header line that has disappeared now, or vice versa.
502 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
504 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
505 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
507 matrix
->header_line_p
= header_line_p
;
509 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
510 Do nothing if MATRIX' size, position, vscroll, and marginal areas
511 haven't changed. This optimization is important because preserving
512 the matrix means preventing redisplay. */
513 if (matrix
->pool
== NULL
)
515 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
516 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
517 xassert (left
>= 0 && right
>= 0);
518 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
519 || right
!= matrix
->right_margin_glyphs
);
521 if (!marginal_areas_changed_p
523 && !header_line_changed_p
524 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
525 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
526 && matrix
->window_height
== window_height
527 && matrix
->window_vscroll
== w
->vscroll
528 && matrix
->window_width
== window_width
)
532 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
533 if (matrix
->rows_allocated
< dim
.height
)
535 int size
= dim
.height
* sizeof (struct glyph_row
);
536 new_rows
= dim
.height
- matrix
->rows_allocated
;
537 matrix
->rows
= (struct glyph_row
*) xrealloc (matrix
->rows
, size
);
538 memset (matrix
->rows
+ matrix
->rows_allocated
, 0,
539 new_rows
* sizeof *matrix
->rows
);
540 matrix
->rows_allocated
= dim
.height
;
545 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
546 on a frame not using window-based redisplay. Set up pointers for
547 each row into the glyph pool. */
550 xassert (matrix
->pool
->glyphs
);
554 left
= margin_glyphs_to_reserve (w
, dim
.width
,
555 w
->left_margin_cols
);
556 right
= margin_glyphs_to_reserve (w
, dim
.width
,
557 w
->right_margin_cols
);
562 for (i
= 0; i
< dim
.height
; ++i
)
564 struct glyph_row
*row
= &matrix
->rows
[i
];
566 row
->glyphs
[LEFT_MARGIN_AREA
]
567 = (matrix
->pool
->glyphs
568 + (y
+ i
) * matrix
->pool
->ncolumns
572 || row
== matrix
->rows
+ dim
.height
- 1
573 || (row
== matrix
->rows
&& matrix
->header_line_p
))
575 row
->glyphs
[TEXT_AREA
]
576 = row
->glyphs
[LEFT_MARGIN_AREA
];
577 row
->glyphs
[RIGHT_MARGIN_AREA
]
578 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
579 row
->glyphs
[LAST_AREA
]
580 = row
->glyphs
[RIGHT_MARGIN_AREA
];
584 row
->glyphs
[TEXT_AREA
]
585 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
586 row
->glyphs
[RIGHT_MARGIN_AREA
]
587 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
588 row
->glyphs
[LAST_AREA
]
589 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
593 matrix
->left_margin_glyphs
= left
;
594 matrix
->right_margin_glyphs
= right
;
598 /* If MATRIX->pool is null, MATRIX is responsible for managing
599 its own memory. It is a window matrix for window-based redisplay.
600 Allocate glyph memory from the heap. */
601 if (dim
.width
> matrix
->matrix_w
603 || header_line_changed_p
604 || marginal_areas_changed_p
)
606 struct glyph_row
*row
= matrix
->rows
;
607 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
611 row
->glyphs
[LEFT_MARGIN_AREA
]
612 = (struct glyph
*) xrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
614 * sizeof (struct glyph
)));
616 /* The mode line never has marginal areas. */
617 if (row
== matrix
->rows
+ dim
.height
- 1
618 || (row
== matrix
->rows
&& matrix
->header_line_p
))
620 row
->glyphs
[TEXT_AREA
]
621 = row
->glyphs
[LEFT_MARGIN_AREA
];
622 row
->glyphs
[RIGHT_MARGIN_AREA
]
623 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
624 row
->glyphs
[LAST_AREA
]
625 = row
->glyphs
[RIGHT_MARGIN_AREA
];
629 row
->glyphs
[TEXT_AREA
]
630 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
631 row
->glyphs
[RIGHT_MARGIN_AREA
]
632 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
633 row
->glyphs
[LAST_AREA
]
634 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
640 xassert (left
>= 0 && right
>= 0);
641 matrix
->left_margin_glyphs
= left
;
642 matrix
->right_margin_glyphs
= right
;
645 /* Number of rows to be used by MATRIX. */
646 matrix
->nrows
= dim
.height
;
647 xassert (matrix
->nrows
>= 0);
651 if (matrix
== w
->current_matrix
)
653 /* Mark rows in a current matrix of a window as not having
654 valid contents. It's important to not do this for
655 desired matrices. When Emacs starts, it may already be
656 building desired matrices when this function runs. */
657 if (window_width
< 0)
658 window_width
= window_box_width (w
, -1);
660 /* Optimize the case that only the height has changed (C-x 2,
661 upper window). Invalidate all rows that are no longer part
663 if (!marginal_areas_changed_p
664 && !header_line_changed_p
666 && dim
.width
== matrix
->matrix_w
667 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
668 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
669 && matrix
->window_width
== window_width
)
671 /* Find the last row in the window. */
672 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
673 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
679 /* Window end is invalid, if inside of the rows that
680 are invalidated below. */
681 if (INTEGERP (w
->window_end_vpos
)
682 && XFASTINT (w
->window_end_vpos
) >= i
)
683 w
->window_end_valid
= Qnil
;
685 while (i
< matrix
->nrows
)
686 matrix
->rows
[i
++].enabled_p
= 0;
690 for (i
= 0; i
< matrix
->nrows
; ++i
)
691 matrix
->rows
[i
].enabled_p
= 0;
694 else if (matrix
== w
->desired_matrix
)
696 /* Rows in desired matrices always have to be cleared;
697 redisplay expects this is the case when it runs, so it
698 had better be the case when we adjust matrices between
700 for (i
= 0; i
< matrix
->nrows
; ++i
)
701 matrix
->rows
[i
].enabled_p
= 0;
706 /* Remember last values to be able to optimize frame redraws. */
707 matrix
->matrix_x
= x
;
708 matrix
->matrix_y
= y
;
709 matrix
->matrix_w
= dim
.width
;
710 matrix
->matrix_h
= dim
.height
;
712 /* Record the top y location and height of W at the time the matrix
713 was last adjusted. This is used to optimize redisplay above. */
716 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
717 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
718 matrix
->window_height
= window_height
;
719 matrix
->window_width
= window_width
;
720 matrix
->window_vscroll
= w
->vscroll
;
725 /* Reverse the contents of rows in MATRIX between START and END. The
726 contents of the row at END - 1 end up at START, END - 2 at START +
727 1 etc. This is part of the implementation of rotate_matrix (see
731 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
735 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
737 /* Non-ISO HP/UX compiler doesn't like auto struct
739 struct glyph_row temp
;
740 temp
= matrix
->rows
[i
];
741 matrix
->rows
[i
] = matrix
->rows
[j
];
742 matrix
->rows
[j
] = temp
;
747 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
748 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
749 indices. (Note: this does not copy glyphs, only glyph pointers in
750 row structures are moved around).
752 The algorithm used for rotating the vector was, I believe, first
753 described by Kernighan. See the vector R as consisting of two
754 sub-vectors AB, where A has length BY for BY >= 0. The result
755 after rotating is then BA. Reverse both sub-vectors to get ArBr
756 and reverse the result to get (ArBr)r which is BA. Similar for
760 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
764 /* Up (rotate left, i.e. towards lower indices). */
766 reverse_rows (matrix
, first
, first
+ by
);
767 reverse_rows (matrix
, first
+ by
, last
);
768 reverse_rows (matrix
, first
, last
);
772 /* Down (rotate right, i.e. towards higher indices). */
773 reverse_rows (matrix
, last
- by
, last
);
774 reverse_rows (matrix
, first
, last
- by
);
775 reverse_rows (matrix
, first
, last
);
780 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
781 with indices START <= index < END. Increment positions by DELTA/
785 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
786 EMACS_INT delta
, EMACS_INT delta_bytes
)
788 /* Check that START and END are reasonable values. */
789 xassert (start
>= 0 && start
<= matrix
->nrows
);
790 xassert (end
>= 0 && end
<= matrix
->nrows
);
791 xassert (start
<= end
);
793 for (; start
< end
; ++start
)
794 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
798 /* Enable a range of rows in glyph matrix MATRIX. START and END are
799 the row indices of the first and last + 1 row to enable. If
800 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
803 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
805 xassert (start
<= end
);
806 xassert (start
>= 0 && start
< matrix
->nrows
);
807 xassert (end
>= 0 && end
<= matrix
->nrows
);
809 for (; start
< end
; ++start
)
810 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
816 This empties all rows in MATRIX by setting the enabled_p flag for
817 all rows of the matrix to zero. The function prepare_desired_row
818 will eventually really clear a row when it sees one with a zero
821 Resets update hints to defaults value. The only update hint
822 currently present is the flag MATRIX->no_scrolling_p. */
825 clear_glyph_matrix (struct glyph_matrix
*matrix
)
829 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
830 matrix
->no_scrolling_p
= 0;
835 /* Shift part of the glyph matrix MATRIX of window W up or down.
836 Increment y-positions in glyph rows between START and END by DY,
837 and recompute their visible height. */
840 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
844 xassert (start
<= end
);
845 xassert (start
>= 0 && start
< matrix
->nrows
);
846 xassert (end
>= 0 && end
<= matrix
->nrows
);
848 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
849 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
851 for (; start
< end
; ++start
)
853 struct glyph_row
*row
= &matrix
->rows
[start
];
856 row
->visible_height
= row
->height
;
859 row
->visible_height
-= min_y
- row
->y
;
860 if (row
->y
+ row
->height
> max_y
)
861 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
866 /* Mark all rows in current matrices of frame F as invalid. Marking
867 invalid is done by setting enabled_p to zero for all rows in a
871 clear_current_matrices (register struct frame
*f
)
873 /* Clear frame current matrix, if we have one. */
874 if (f
->current_matrix
)
875 clear_glyph_matrix (f
->current_matrix
);
877 /* Clear the matrix of the menu bar window, if such a window exists.
878 The menu bar window is currently used to display menus on X when
879 no toolkit support is compiled in. */
880 if (WINDOWP (f
->menu_bar_window
))
881 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
883 /* Clear the matrix of the tool-bar window, if any. */
884 if (WINDOWP (f
->tool_bar_window
))
885 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
887 /* Clear current window matrices. */
888 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
889 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
893 /* Clear out all display lines of F for a coming redisplay. */
896 clear_desired_matrices (register struct frame
*f
)
898 if (f
->desired_matrix
)
899 clear_glyph_matrix (f
->desired_matrix
);
901 if (WINDOWP (f
->menu_bar_window
))
902 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
904 if (WINDOWP (f
->tool_bar_window
))
905 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
907 /* Do it for window matrices. */
908 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
909 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
913 /* Clear matrices in window tree rooted in W. If DESIRED_P is
914 non-zero clear desired matrices, otherwise clear current matrices. */
917 clear_window_matrices (struct window
*w
, int desired_p
)
921 if (!NILP (w
->hchild
))
923 xassert (WINDOWP (w
->hchild
));
924 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
926 else if (!NILP (w
->vchild
))
928 xassert (WINDOWP (w
->vchild
));
929 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
934 clear_glyph_matrix (w
->desired_matrix
);
937 clear_glyph_matrix (w
->current_matrix
);
938 w
->window_end_valid
= Qnil
;
942 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
948 /***********************************************************************
951 See dispextern.h for an overall explanation of glyph rows.
952 ***********************************************************************/
954 /* Clear glyph row ROW. Do it in a way that makes it robust against
955 changes in the glyph_row structure, i.e. addition or removal of
956 structure members. */
958 static struct glyph_row null_row
;
961 clear_glyph_row (struct glyph_row
*row
)
963 struct glyph
*p
[1 + LAST_AREA
];
966 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
967 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
968 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
969 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
974 /* Restore pointers. */
975 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
976 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
977 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
978 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
980 #if 0 /* At some point, some bit-fields of struct glyph were not set,
981 which made glyphs unequal when compared with GLYPH_EQUAL_P.
982 Redisplay outputs such glyphs, and flickering effects were
983 the result. This also depended on the contents of memory
984 returned by xmalloc. If flickering happens again, activate
985 the code below. If the flickering is gone with that, chances
986 are that the flickering has the same reason as here. */
987 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
992 /* Make ROW an empty, enabled row of canonical character height,
993 in window W starting at y-position Y. */
996 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
1000 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1001 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
1003 clear_glyph_row (row
);
1005 row
->ascent
= row
->phys_ascent
= 0;
1006 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
1007 row
->visible_height
= row
->height
;
1010 row
->visible_height
-= min_y
- row
->y
;
1011 if (row
->y
+ row
->height
> max_y
)
1012 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
1018 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1019 are the amounts by which to change positions. Note that the first
1020 glyph of the text area of a row can have a buffer position even if
1021 the used count of the text area is zero. Such rows display line
1025 increment_row_positions (struct glyph_row
*row
,
1026 EMACS_INT delta
, EMACS_INT delta_bytes
)
1030 /* Increment start and end positions. */
1031 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1032 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1033 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1034 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1035 CHARPOS (row
->start
.pos
) += delta
;
1036 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1037 CHARPOS (row
->end
.pos
) += delta
;
1038 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1040 if (!row
->enabled_p
)
1043 /* Increment positions in glyphs. */
1044 for (area
= 0; area
< LAST_AREA
; ++area
)
1045 for (i
= 0; i
< row
->used
[area
]; ++i
)
1046 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1047 && row
->glyphs
[area
][i
].charpos
> 0)
1048 row
->glyphs
[area
][i
].charpos
+= delta
;
1050 /* Capture the case of rows displaying a line end. */
1051 if (row
->used
[TEXT_AREA
] == 0
1052 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1053 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1058 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1059 contents, i.e. glyph structure contents are exchanged between A and
1060 B without changing glyph pointers in A and B. */
1063 swap_glyphs_in_rows (a
, b
)
1064 struct glyph_row
*a
, *b
;
1068 for (area
= 0; area
< LAST_AREA
; ++area
)
1070 /* Number of glyphs to swap. */
1071 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1073 /* Start of glyphs in area of row A. */
1074 struct glyph
*glyph_a
= a
->glyphs
[area
];
1076 /* End + 1 of glyphs in area of row A. */
1077 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1079 /* Start of glyphs in area of row B. */
1080 struct glyph
*glyph_b
= b
->glyphs
[area
];
1082 while (glyph_a
< glyph_a_end
)
1084 /* Non-ISO HP/UX compiler doesn't like auto struct
1088 *glyph_a
= *glyph_b
;
1098 /* Exchange pointers to glyph memory between glyph rows A and B. */
1101 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1104 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1106 struct glyph
*temp
= a
->glyphs
[i
];
1107 a
->glyphs
[i
] = b
->glyphs
[i
];
1108 b
->glyphs
[i
] = temp
;
1113 /* Copy glyph row structure FROM to glyph row structure TO, except
1114 that glyph pointers in the structures are left unchanged. */
1117 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1119 struct glyph
*pointers
[1 + LAST_AREA
];
1121 /* Save glyph pointers of TO. */
1122 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1124 /* Do a structure assignment. */
1127 /* Restore original pointers of TO. */
1128 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1132 /* Assign glyph row FROM to glyph row TO. This works like a structure
1133 assignment TO = FROM, except that glyph pointers are not copied but
1134 exchanged between TO and FROM. Pointers must be exchanged to avoid
1138 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1140 swap_glyph_pointers (to
, from
);
1141 copy_row_except_pointers (to
, from
);
1145 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1146 a row in a window matrix, is a slice of the glyph memory of the
1147 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1148 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1149 memory of FRAME_ROW. */
1154 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1156 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1157 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1158 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1160 return (frame_glyph_start
<= window_glyph_start
1161 && window_glyph_start
< frame_glyph_end
);
1164 #endif /* GLYPH_DEBUG */
1168 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1169 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1170 in WINDOW_MATRIX is found satisfying the condition. */
1172 static struct glyph_row
*
1173 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1174 struct glyph_matrix
*frame_matrix
, int row
)
1178 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1180 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1181 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1182 frame_matrix
->rows
+ row
))
1185 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1190 /* Prepare ROW for display. Desired rows are cleared lazily,
1191 i.e. they are only marked as to be cleared by setting their
1192 enabled_p flag to zero. When a row is to be displayed, a prior
1193 call to this function really clears it. */
1196 prepare_desired_row (struct glyph_row
*row
)
1198 if (!row
->enabled_p
)
1200 unsigned rp
= row
->reversed_p
;
1202 clear_glyph_row (row
);
1204 row
->reversed_p
= rp
;
1209 /* Return a hash code for glyph row ROW. */
1212 line_hash_code (struct glyph_row
*row
)
1218 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1219 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1223 int c
= glyph
->u
.ch
;
1224 int face_id
= glyph
->face_id
;
1225 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1227 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1228 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1240 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1241 the number of characters in the line. If must_write_spaces is
1242 zero, leading and trailing spaces are ignored. */
1245 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1247 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1248 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1249 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1251 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1252 int glyph_table_len
= GLYPH_TABLE_LENGTH
;
1254 /* Ignore trailing and leading spaces if we can. */
1255 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1257 /* Skip from the end over trailing spaces. */
1258 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1261 /* All blank line. */
1265 /* Skip over leading spaces. */
1266 while (CHAR_GLYPH_SPACE_P (*beg
))
1270 /* If we don't have a glyph-table, each glyph is one character,
1271 so return the number of glyphs. */
1272 if (glyph_table_base
== 0)
1276 /* Otherwise, scan the glyphs and accumulate their total length
1283 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1285 if (GLYPH_INVALID_P (g
)
1286 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1289 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1299 /* Test two glyph rows A and B for equality. Value is non-zero if A
1300 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1301 mouse_face_p flags of A and B, too. */
1304 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1308 else if (a
->hash
!= b
->hash
)
1312 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1315 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1318 /* Compare glyphs. */
1319 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1321 if (a
->used
[area
] != b
->used
[area
])
1324 a_glyph
= a
->glyphs
[area
];
1325 a_end
= a_glyph
+ a
->used
[area
];
1326 b_glyph
= b
->glyphs
[area
];
1328 while (a_glyph
< a_end
1329 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1330 ++a_glyph
, ++b_glyph
;
1332 if (a_glyph
!= a_end
)
1336 if (a
->fill_line_p
!= b
->fill_line_p
1337 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1338 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1339 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1340 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1341 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1342 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1343 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1344 || a
->overlapped_p
!= b
->overlapped_p
1345 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1346 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1347 || a
->reversed_p
!= b
->reversed_p
1348 /* Different partially visible characters on left margin. */
1350 /* Different height. */
1351 || a
->ascent
!= b
->ascent
1352 || a
->phys_ascent
!= b
->phys_ascent
1353 || a
->phys_height
!= b
->phys_height
1354 || a
->visible_height
!= b
->visible_height
)
1363 /***********************************************************************
1366 See dispextern.h for an overall explanation of glyph pools.
1367 ***********************************************************************/
1369 /* Allocate a glyph_pool structure. The structure returned is
1370 initialized with zeros. The global variable glyph_pool_count is
1371 incremented for each pool allocated. */
1373 static struct glyph_pool
*
1374 new_glyph_pool (void)
1376 struct glyph_pool
*result
;
1378 /* Allocate a new glyph_pool and clear it. */
1379 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1380 memset (result
, 0, sizeof *result
);
1382 /* For memory leak and double deletion checking. */
1389 /* Free a glyph_pool structure POOL. The function may be called with
1390 a null POOL pointer. The global variable glyph_pool_count is
1391 decremented with every pool structure freed. If this count gets
1392 negative, more structures were freed than allocated, i.e. one
1393 structure must have been freed more than once or a bogus pointer
1394 was passed to free_glyph_pool. */
1397 free_glyph_pool (struct glyph_pool
*pool
)
1401 /* More freed than allocated? */
1403 xassert (glyph_pool_count
>= 0);
1405 xfree (pool
->glyphs
);
1411 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1412 columns we need. This function never shrinks a pool. The only
1413 case in which this would make sense, would be when a frame's size
1414 is changed from a large value to a smaller one. But, if someone
1415 does it once, we can expect that he will do it again.
1417 Value is non-zero if the pool changed in a way which makes
1418 re-adjusting window glyph matrices necessary. */
1421 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1426 changed_p
= (pool
->glyphs
== 0
1427 || matrix_dim
.height
!= pool
->nrows
1428 || matrix_dim
.width
!= pool
->ncolumns
);
1430 /* Enlarge the glyph pool. */
1431 needed
= matrix_dim
.width
* matrix_dim
.height
;
1432 if (needed
> pool
->nglyphs
)
1434 int size
= needed
* sizeof (struct glyph
);
1438 pool
->glyphs
= (struct glyph
*) xrealloc (pool
->glyphs
, size
);
1439 memset (pool
->glyphs
+ pool
->nglyphs
, 0,
1440 size
- pool
->nglyphs
* sizeof (struct glyph
));
1444 pool
->glyphs
= (struct glyph
*) xmalloc (size
);
1445 memset (pool
->glyphs
, 0, size
);
1448 pool
->nglyphs
= needed
;
1451 /* Remember the number of rows and columns because (a) we use them
1452 to do sanity checks, and (b) the number of columns determines
1453 where rows in the frame matrix start---this must be available to
1454 determine pointers to rows of window sub-matrices. */
1455 pool
->nrows
= matrix_dim
.height
;
1456 pool
->ncolumns
= matrix_dim
.width
;
1463 /***********************************************************************
1465 ***********************************************************************/
1470 /* Flush standard output. This is sometimes useful to call from the debugger.
1471 XXX Maybe this should be changed to flush the current terminal instead of
1482 /* Check that no glyph pointers have been lost in MATRIX. If a
1483 pointer has been lost, e.g. by using a structure assignment between
1484 rows, at least one pointer must occur more than once in the rows of
1488 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1492 for (i
= 0; i
< matrix
->nrows
; ++i
)
1493 for (j
= 0; j
< matrix
->nrows
; ++j
)
1495 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1496 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1500 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1503 matrix_row (struct glyph_matrix
*matrix
, int row
)
1505 xassert (matrix
&& matrix
->rows
);
1506 xassert (row
>= 0 && row
< matrix
->nrows
);
1508 /* That's really too slow for normal testing because this function
1509 is called almost everywhere. Although---it's still astonishingly
1510 fast, so it is valuable to have for debugging purposes. */
1512 check_matrix_pointer_lossage (matrix
);
1515 return matrix
->rows
+ row
;
1519 #if 0 /* This function makes invalid assumptions when text is
1520 partially invisible. But it might come handy for debugging
1523 /* Check invariants that must hold for an up to date current matrix of
1527 check_matrix_invariants (struct window
*w
)
1529 struct glyph_matrix
*matrix
= w
->current_matrix
;
1530 int yb
= window_text_bottom_y (w
);
1531 struct glyph_row
*row
= matrix
->rows
;
1532 struct glyph_row
*last_text_row
= NULL
;
1533 struct buffer
*saved
= current_buffer
;
1534 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1537 /* This can sometimes happen for a fresh window. */
1538 if (matrix
->nrows
< 2)
1541 set_buffer_temp (buffer
);
1543 /* Note: last row is always reserved for the mode line. */
1544 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1545 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1547 struct glyph_row
*next
= row
+ 1;
1549 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1550 last_text_row
= row
;
1552 /* Check that character and byte positions are in sync. */
1553 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1554 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1555 xassert (BYTEPOS (row
->start
.pos
)
1556 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1558 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1559 have such a position temporarily in case of a minibuffer
1560 displaying something like `[Sole completion]' at its end. */
1561 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1563 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1564 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1565 xassert (BYTEPOS (row
->end
.pos
)
1566 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1569 /* Check that end position of `row' is equal to start position
1571 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1573 xassert (MATRIX_ROW_END_CHARPOS (row
)
1574 == MATRIX_ROW_START_CHARPOS (next
));
1575 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1576 == MATRIX_ROW_START_BYTEPOS (next
));
1577 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1578 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1583 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1584 xassert (w
->desired_matrix
->rows
!= NULL
);
1585 set_buffer_temp (saved
);
1590 #endif /* GLYPH_DEBUG != 0 */
1594 /**********************************************************************
1595 Allocating/ Adjusting Glyph Matrices
1596 **********************************************************************/
1598 /* Allocate glyph matrices over a window tree for a frame-based
1601 X and Y are column/row within the frame glyph matrix where
1602 sub-matrices for the window tree rooted at WINDOW must be
1603 allocated. DIM_ONLY_P non-zero means that the caller of this
1604 function is only interested in the result matrix dimension, and
1605 matrix adjustments should not be performed.
1607 The function returns the total width/height of the sub-matrices of
1608 the window tree. If called on a frame root window, the computation
1609 will take the mini-buffer window into account.
1611 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1613 NEW_LEAF_MATRIX set if any window in the tree did not have a
1614 glyph matrices yet, and
1616 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1617 any window in the tree will be changed or have been changed (see
1620 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1623 Windows are arranged into chains of windows on the same level
1624 through the next fields of window structures. Such a level can be
1625 either a sequence of horizontally adjacent windows from left to
1626 right, or a sequence of vertically adjacent windows from top to
1627 bottom. Each window in a horizontal sequence can be either a leaf
1628 window or a vertical sequence; a window in a vertical sequence can
1629 be either a leaf or a horizontal sequence. All windows in a
1630 horizontal sequence have the same height, and all windows in a
1631 vertical sequence have the same width.
1633 This function uses, for historical reasons, a more general
1634 algorithm to determine glyph matrix dimensions that would be
1637 The matrix height of a horizontal sequence is determined by the
1638 maximum height of any matrix in the sequence. The matrix width of
1639 a horizontal sequence is computed by adding up matrix widths of
1640 windows in the sequence.
1642 |<------- result width ------->|
1643 +---------+----------+---------+ ---
1646 +---------+ | | result height
1651 The matrix width of a vertical sequence is the maximum matrix width
1652 of any window in the sequence. Its height is computed by adding up
1653 matrix heights of windows in the sequence.
1655 |<---- result width -->|
1663 +------------+---------+ |
1666 +------------+---------+ --- */
1668 /* Bit indicating that a new matrix will be allocated or has been
1671 #define NEW_LEAF_MATRIX (1 << 0)
1673 /* Bit indicating that a matrix will or has changed its location or
1676 #define CHANGED_LEAF_MATRIX (1 << 1)
1679 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1680 int dim_only_p
, int *window_change_flags
)
1682 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1684 int wmax
= 0, hmax
= 0;
1688 int in_horz_combination_p
;
1690 /* What combination is WINDOW part of? Compute this once since the
1691 result is the same for all windows in the `next' chain. The
1692 special case of a root window (parent equal to nil) is treated
1693 like a vertical combination because a root window's `next'
1694 points to the mini-buffer window, if any, which is arranged
1695 vertically below other windows. */
1696 in_horz_combination_p
1697 = (!NILP (XWINDOW (window
)->parent
)
1698 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1700 /* For WINDOW and all windows on the same level. */
1703 w
= XWINDOW (window
);
1705 /* Get the dimension of the window sub-matrix for W, depending
1706 on whether this is a combination or a leaf window. */
1707 if (!NILP (w
->hchild
))
1708 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1710 window_change_flags
);
1711 else if (!NILP (w
->vchild
))
1712 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1714 window_change_flags
);
1717 /* If not already done, allocate sub-matrix structures. */
1718 if (w
->desired_matrix
== NULL
)
1720 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1721 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1722 *window_change_flags
|= NEW_LEAF_MATRIX
;
1725 /* Width and height MUST be chosen so that there are no
1726 holes in the frame matrix. */
1727 dim
.width
= required_matrix_width (w
);
1728 dim
.height
= required_matrix_height (w
);
1730 /* Will matrix be re-allocated? */
1731 if (x
!= w
->desired_matrix
->matrix_x
1732 || y
!= w
->desired_matrix
->matrix_y
1733 || dim
.width
!= w
->desired_matrix
->matrix_w
1734 || dim
.height
!= w
->desired_matrix
->matrix_h
1735 || (margin_glyphs_to_reserve (w
, dim
.width
,
1736 w
->left_margin_cols
)
1737 != w
->desired_matrix
->left_margin_glyphs
)
1738 || (margin_glyphs_to_reserve (w
, dim
.width
,
1739 w
->right_margin_cols
)
1740 != w
->desired_matrix
->right_margin_glyphs
))
1741 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1743 /* Actually change matrices, if allowed. Do not consider
1744 CHANGED_LEAF_MATRIX computed above here because the pool
1745 may have been changed which we don't now here. We trust
1746 that we only will be called with DIM_ONLY_P != 0 when
1750 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1751 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1755 /* If we are part of a horizontal combination, advance x for
1756 windows to the right of W; otherwise advance y for windows
1758 if (in_horz_combination_p
)
1763 /* Remember maximum glyph matrix dimensions. */
1764 wmax
= max (wmax
, dim
.width
);
1765 hmax
= max (hmax
, dim
.height
);
1767 /* Next window on same level. */
1770 while (!NILP (window
));
1772 /* Set `total' to the total glyph matrix dimension of this window
1773 level. In a vertical combination, the width is the width of the
1774 widest window; the height is the y we finally reached, corrected
1775 by the y we started with. In a horizontal combination, the total
1776 height is the height of the tallest window, and the width is the
1777 x we finally reached, corrected by the x we started with. */
1778 if (in_horz_combination_p
)
1780 total
.width
= x
- x0
;
1781 total
.height
= hmax
;
1786 total
.height
= y
- y0
;
1793 /* Return the required height of glyph matrices for window W. */
1796 required_matrix_height (struct window
*w
)
1798 #ifdef HAVE_WINDOW_SYSTEM
1799 struct frame
*f
= XFRAME (w
->frame
);
1801 if (FRAME_WINDOW_P (f
))
1803 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1804 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1805 return (((window_pixel_height
+ ch_height
- 1)
1806 / ch_height
) * w
->nrows_scale_factor
1807 /* One partially visible line at the top and
1808 bottom of the window. */
1810 /* 2 for header and mode line. */
1813 #endif /* HAVE_WINDOW_SYSTEM */
1815 return WINDOW_TOTAL_LINES (w
);
1819 /* Return the required width of glyph matrices for window W. */
1822 required_matrix_width (struct window
*w
)
1824 #ifdef HAVE_WINDOW_SYSTEM
1825 struct frame
*f
= XFRAME (w
->frame
);
1826 if (FRAME_WINDOW_P (f
))
1828 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1829 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1831 /* Compute number of glyphs needed in a glyph row. */
1832 return (((window_pixel_width
+ ch_width
- 1)
1833 / ch_width
) * w
->ncols_scale_factor
1834 /* 2 partially visible columns in the text area. */
1836 /* One partially visible column at the right
1837 edge of each marginal area. */
1840 #endif /* HAVE_WINDOW_SYSTEM */
1842 return XINT (w
->total_cols
);
1846 /* Allocate window matrices for window-based redisplay. W is the
1847 window whose matrices must be allocated/reallocated. */
1850 allocate_matrices_for_window_redisplay (struct window
*w
)
1854 if (!NILP (w
->vchild
))
1855 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1856 else if (!NILP (w
->hchild
))
1857 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1860 /* W is a leaf window. */
1863 /* If matrices are not yet allocated, allocate them now. */
1864 if (w
->desired_matrix
== NULL
)
1866 w
->desired_matrix
= new_glyph_matrix (NULL
);
1867 w
->current_matrix
= new_glyph_matrix (NULL
);
1870 dim
.width
= required_matrix_width (w
);
1871 dim
.height
= required_matrix_height (w
);
1872 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1873 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1876 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1881 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1882 do it for all frames; otherwise do it just for the given frame.
1883 This function must be called when a new frame is created, its size
1884 changes, or its window configuration changes. */
1887 adjust_glyphs (struct frame
*f
)
1889 /* Block input so that expose events and other events that access
1890 glyph matrices are not processed while we are changing them. */
1894 adjust_frame_glyphs (f
);
1897 Lisp_Object tail
, lisp_frame
;
1899 FOR_EACH_FRAME (tail
, lisp_frame
)
1900 adjust_frame_glyphs (XFRAME (lisp_frame
));
1907 /* Adjust frame glyphs when Emacs is initialized.
1909 To be called from init_display.
1911 We need a glyph matrix because redraw will happen soon.
1912 Unfortunately, window sizes on selected_frame are not yet set to
1913 meaningful values. I believe we can assume that there are only two
1914 windows on the frame---the mini-buffer and the root window. Frame
1915 height and width seem to be correct so far. So, set the sizes of
1916 windows to estimated values. */
1919 adjust_frame_glyphs_initially (void)
1921 struct frame
*sf
= SELECTED_FRAME ();
1922 struct window
*root
= XWINDOW (sf
->root_window
);
1923 struct window
*mini
= XWINDOW (root
->next
);
1924 int frame_lines
= FRAME_LINES (sf
);
1925 int frame_cols
= FRAME_COLS (sf
);
1926 int top_margin
= FRAME_TOP_MARGIN (sf
);
1928 /* Do it for the root window. */
1929 XSETFASTINT (root
->top_line
, top_margin
);
1930 XSETFASTINT (root
->total_cols
, frame_cols
);
1931 set_window_height (sf
->root_window
, frame_lines
- 1 - top_margin
, 0);
1933 /* Do it for the mini-buffer window. */
1934 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1935 XSETFASTINT (mini
->total_cols
, frame_cols
);
1936 set_window_height (root
->next
, 1, 0);
1938 adjust_frame_glyphs (sf
);
1939 glyphs_initialized_initially_p
= 1;
1943 /* Allocate/reallocate glyph matrices of a single frame F. */
1946 adjust_frame_glyphs (struct frame
*f
)
1948 if (FRAME_WINDOW_P (f
))
1949 adjust_frame_glyphs_for_window_redisplay (f
);
1951 adjust_frame_glyphs_for_frame_redisplay (f
);
1953 /* Don't forget the message buffer and the buffer for
1954 decode_mode_spec. */
1955 adjust_frame_message_buffer (f
);
1956 adjust_decode_mode_spec_buffer (f
);
1958 f
->glyphs_initialized_p
= 1;
1961 /* Return 1 if any window in the tree has nonzero window margins. See
1962 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1964 showing_window_margins_p (struct window
*w
)
1968 if (!NILP (w
->hchild
))
1970 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1973 else if (!NILP (w
->vchild
))
1975 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1978 else if (!NILP (w
->left_margin_cols
)
1979 || !NILP (w
->right_margin_cols
))
1982 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1988 /* In the window tree with root W, build current matrices of leaf
1989 windows from the frame's current matrix. */
1992 fake_current_matrices (Lisp_Object window
)
1996 for (; !NILP (window
); window
= w
->next
)
1998 w
= XWINDOW (window
);
2000 if (!NILP (w
->hchild
))
2001 fake_current_matrices (w
->hchild
);
2002 else if (!NILP (w
->vchild
))
2003 fake_current_matrices (w
->vchild
);
2007 struct frame
*f
= XFRAME (w
->frame
);
2008 struct glyph_matrix
*m
= w
->current_matrix
;
2009 struct glyph_matrix
*fm
= f
->current_matrix
;
2011 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
2012 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
2014 for (i
= 0; i
< m
->matrix_h
; ++i
)
2016 struct glyph_row
*r
= m
->rows
+ i
;
2017 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2019 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2020 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2022 r
->enabled_p
= fr
->enabled_p
;
2025 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2026 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2027 r
->used
[TEXT_AREA
] = (m
->matrix_w
2028 - r
->used
[LEFT_MARGIN_AREA
]
2029 - r
->used
[RIGHT_MARGIN_AREA
]);
2038 /* Save away the contents of frame F's current frame matrix. Value is
2039 a glyph matrix holding the contents of F's current frame matrix. */
2041 static struct glyph_matrix
*
2042 save_current_matrix (struct frame
*f
)
2045 struct glyph_matrix
*saved
;
2047 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2048 memset (saved
, 0, sizeof *saved
);
2049 saved
->nrows
= f
->current_matrix
->nrows
;
2050 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2051 * sizeof *saved
->rows
);
2052 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2054 for (i
= 0; i
< saved
->nrows
; ++i
)
2056 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2057 struct glyph_row
*to
= saved
->rows
+ i
;
2058 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2059 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2060 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2061 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2068 /* Restore the contents of frame F's current frame matrix from SAVED,
2069 and free memory associated with SAVED. */
2072 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2076 for (i
= 0; i
< saved
->nrows
; ++i
)
2078 struct glyph_row
*from
= saved
->rows
+ i
;
2079 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2080 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2081 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2082 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2083 xfree (from
->glyphs
[TEXT_AREA
]);
2086 xfree (saved
->rows
);
2092 /* Allocate/reallocate glyph matrices of a single frame F for
2093 frame-based redisplay. */
2096 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2098 struct dim matrix_dim
;
2100 int window_change_flags
;
2103 if (!FRAME_LIVE_P (f
))
2106 top_window_y
= FRAME_TOP_MARGIN (f
);
2108 /* Allocate glyph pool structures if not already done. */
2109 if (f
->desired_pool
== NULL
)
2111 f
->desired_pool
= new_glyph_pool ();
2112 f
->current_pool
= new_glyph_pool ();
2115 /* Allocate frames matrix structures if needed. */
2116 if (f
->desired_matrix
== NULL
)
2118 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2119 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2122 /* Compute window glyph matrices. (This takes the mini-buffer
2123 window into account). The result is the size of the frame glyph
2124 matrix needed. The variable window_change_flags is set to a bit
2125 mask indicating whether new matrices will be allocated or
2126 existing matrices change their size or location within the frame
2128 window_change_flags
= 0;
2130 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2133 &window_change_flags
);
2135 /* Add in menu bar lines, if any. */
2136 matrix_dim
.height
+= top_window_y
;
2138 /* Enlarge pools as necessary. */
2139 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2140 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2142 /* Set up glyph pointers within window matrices. Do this only if
2143 absolutely necessary since it requires a frame redraw. */
2144 if (pool_changed_p
|| window_change_flags
)
2146 /* Do it for window matrices. */
2147 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2149 &window_change_flags
);
2151 /* Size of frame matrices must equal size of frame. Note
2152 that we are called for X frames with window widths NOT equal
2153 to the frame width (from CHANGE_FRAME_SIZE_1). */
2154 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2155 && matrix_dim
.height
== FRAME_LINES (f
));
2157 /* Pointers to glyph memory in glyph rows are exchanged during
2158 the update phase of redisplay, which means in general that a
2159 frame's current matrix consists of pointers into both the
2160 desired and current glyph pool of the frame. Adjusting a
2161 matrix sets the frame matrix up so that pointers are all into
2162 the same pool. If we want to preserve glyph contents of the
2163 current matrix over a call to adjust_glyph_matrix, we must
2164 make a copy of the current glyphs, and restore the current
2165 matrix' contents from that copy. */
2166 if (display_completed
2167 && !FRAME_GARBAGED_P (f
)
2168 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2169 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2170 /* For some reason, the frame glyph matrix gets corrupted if
2171 any of the windows contain margins. I haven't been able
2172 to hunt down the reason, but for the moment this prevents
2173 the problem from manifesting. -- cyd */
2174 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2176 struct glyph_matrix
*copy
= save_current_matrix (f
);
2177 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2178 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2179 restore_current_matrix (f
, copy
);
2180 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2184 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2185 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2186 SET_FRAME_GARBAGED (f
);
2192 /* Allocate/reallocate glyph matrices of a single frame F for
2193 window-based redisplay. */
2196 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2198 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2200 /* Allocate/reallocate window matrices. */
2201 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2203 #ifdef HAVE_X_WINDOWS
2204 /* Allocate/ reallocate matrices of the dummy window used to display
2205 the menu bar under X when no X toolkit support is available. */
2206 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2208 /* Allocate a dummy window if not already done. */
2210 if (NILP (f
->menu_bar_window
))
2212 f
->menu_bar_window
= make_window ();
2213 w
= XWINDOW (f
->menu_bar_window
);
2214 XSETFRAME (w
->frame
, f
);
2215 w
->pseudo_window_p
= 1;
2218 w
= XWINDOW (f
->menu_bar_window
);
2220 /* Set window dimensions to frame dimensions and allocate or
2221 adjust glyph matrices of W. */
2222 XSETFASTINT (w
->top_line
, 0);
2223 XSETFASTINT (w
->left_col
, 0);
2224 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2225 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2226 allocate_matrices_for_window_redisplay (w
);
2228 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2229 #endif /* HAVE_X_WINDOWS */
2233 /* Allocate/ reallocate matrices of the tool bar window. If we
2234 don't have a tool bar window yet, make one. */
2236 if (NILP (f
->tool_bar_window
))
2238 f
->tool_bar_window
= make_window ();
2239 w
= XWINDOW (f
->tool_bar_window
);
2240 XSETFRAME (w
->frame
, f
);
2241 w
->pseudo_window_p
= 1;
2244 w
= XWINDOW (f
->tool_bar_window
);
2246 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2247 XSETFASTINT (w
->left_col
, 0);
2248 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2249 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2250 allocate_matrices_for_window_redisplay (w
);
2256 /* Adjust/ allocate message buffer of frame F.
2258 Note that the message buffer is never freed. Since I could not
2259 find a free in 19.34, I assume that freeing it would be
2260 problematic in some way and don't do it either.
2262 (Implementation note: It should be checked if we can free it
2263 eventually without causing trouble). */
2266 adjust_frame_message_buffer (struct frame
*f
)
2268 int size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2270 if (FRAME_MESSAGE_BUF (f
))
2272 char *buffer
= FRAME_MESSAGE_BUF (f
);
2273 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2274 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2277 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2281 /* Re-allocate buffer for decode_mode_spec on frame F. */
2284 adjust_decode_mode_spec_buffer (struct frame
*f
)
2286 f
->decode_mode_spec_buffer
2287 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2288 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2293 /**********************************************************************
2294 Freeing Glyph Matrices
2295 **********************************************************************/
2297 /* Free glyph memory for a frame F. F may be null. This function can
2298 be called for the same frame more than once. The root window of
2299 F may be nil when this function is called. This is the case when
2300 the function is called when F is destroyed. */
2303 free_glyphs (struct frame
*f
)
2305 if (f
&& f
->glyphs_initialized_p
)
2307 /* Block interrupt input so that we don't get surprised by an X
2308 event while we're in an inconsistent state. */
2310 f
->glyphs_initialized_p
= 0;
2312 /* Release window sub-matrices. */
2313 if (!NILP (f
->root_window
))
2314 free_window_matrices (XWINDOW (f
->root_window
));
2316 /* Free the dummy window for menu bars without X toolkit and its
2318 if (!NILP (f
->menu_bar_window
))
2320 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2321 free_glyph_matrix (w
->desired_matrix
);
2322 free_glyph_matrix (w
->current_matrix
);
2323 w
->desired_matrix
= w
->current_matrix
= NULL
;
2324 f
->menu_bar_window
= Qnil
;
2327 /* Free the tool bar window and its glyph matrices. */
2328 if (!NILP (f
->tool_bar_window
))
2330 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2331 free_glyph_matrix (w
->desired_matrix
);
2332 free_glyph_matrix (w
->current_matrix
);
2333 w
->desired_matrix
= w
->current_matrix
= NULL
;
2334 f
->tool_bar_window
= Qnil
;
2337 /* Release frame glyph matrices. Reset fields to zero in
2338 case we are called a second time. */
2339 if (f
->desired_matrix
)
2341 free_glyph_matrix (f
->desired_matrix
);
2342 free_glyph_matrix (f
->current_matrix
);
2343 f
->desired_matrix
= f
->current_matrix
= NULL
;
2346 /* Release glyph pools. */
2347 if (f
->desired_pool
)
2349 free_glyph_pool (f
->desired_pool
);
2350 free_glyph_pool (f
->current_pool
);
2351 f
->desired_pool
= f
->current_pool
= NULL
;
2359 /* Free glyph sub-matrices in the window tree rooted at W. This
2360 function may be called with a null pointer, and it may be called on
2361 the same tree more than once. */
2364 free_window_matrices (struct window
*w
)
2368 if (!NILP (w
->hchild
))
2369 free_window_matrices (XWINDOW (w
->hchild
));
2370 else if (!NILP (w
->vchild
))
2371 free_window_matrices (XWINDOW (w
->vchild
));
2374 /* This is a leaf window. Free its memory and reset fields
2375 to zero in case this function is called a second time for
2377 free_glyph_matrix (w
->current_matrix
);
2378 free_glyph_matrix (w
->desired_matrix
);
2379 w
->current_matrix
= w
->desired_matrix
= NULL
;
2382 /* Next window on same level. */
2383 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2388 /* Check glyph memory leaks. This function is called from
2389 shut_down_emacs. Note that frames are not destroyed when Emacs
2390 exits. We therefore free all glyph memory for all active frames
2391 explicitly and check that nothing is left allocated. */
2394 check_glyph_memory (void)
2396 Lisp_Object tail
, frame
;
2398 /* Free glyph memory for all frames. */
2399 FOR_EACH_FRAME (tail
, frame
)
2400 free_glyphs (XFRAME (frame
));
2402 /* Check that nothing is left allocated. */
2403 if (glyph_matrix_count
)
2405 if (glyph_pool_count
)
2411 /**********************************************************************
2412 Building a Frame Matrix
2413 **********************************************************************/
2415 /* Most of the redisplay code works on glyph matrices attached to
2416 windows. This is a good solution most of the time, but it is not
2417 suitable for terminal code. Terminal output functions cannot rely
2418 on being able to set an arbitrary terminal window. Instead they
2419 must be provided with a view of the whole frame, i.e. the whole
2420 screen. We build such a view by constructing a frame matrix from
2421 window matrices in this section.
2423 Windows that must be updated have their must_be_update_p flag set.
2424 For all such windows, their desired matrix is made part of the
2425 desired frame matrix. For other windows, their current matrix is
2426 made part of the desired frame matrix.
2428 +-----------------+----------------+
2429 | desired | desired |
2431 +-----------------+----------------+
2434 +----------------------------------+
2436 Desired window matrices can be made part of the frame matrix in a
2437 cheap way: We exploit the fact that the desired frame matrix and
2438 desired window matrices share their glyph memory. This is not
2439 possible for current window matrices. Their glyphs are copied to
2440 the desired frame matrix. The latter is equivalent to
2441 preserve_other_columns in the old redisplay.
2443 Used glyphs counters for frame matrix rows are the result of adding
2444 up glyph lengths of the window matrices. A line in the frame
2445 matrix is enabled, if a corresponding line in a window matrix is
2448 After building the desired frame matrix, it will be passed to
2449 terminal code, which will manipulate both the desired and current
2450 frame matrix. Changes applied to the frame's current matrix have
2451 to be visible in current window matrices afterwards, of course.
2453 This problem is solved like this:
2455 1. Window and frame matrices share glyphs. Window matrices are
2456 constructed in a way that their glyph contents ARE the glyph
2457 contents needed in a frame matrix. Thus, any modification of
2458 glyphs done in terminal code will be reflected in window matrices
2461 2. Exchanges of rows in a frame matrix done by terminal code are
2462 intercepted by hook functions so that corresponding row operations
2463 on window matrices can be performed. This is necessary because we
2464 use pointers to glyphs in glyph row structures. To satisfy the
2465 assumption of point 1 above that glyphs are updated implicitly in
2466 window matrices when they are manipulated via the frame matrix,
2467 window and frame matrix must of course agree where to find the
2468 glyphs for their rows. Possible manipulations that must be
2469 mirrored are assignments of rows of the desired frame matrix to the
2470 current frame matrix and scrolling the current frame matrix. */
2472 /* Build frame F's desired matrix from window matrices. Only windows
2473 which have the flag must_be_updated_p set have to be updated. Menu
2474 bar lines of a frame are not covered by window matrices, so make
2475 sure not to touch them in this function. */
2478 build_frame_matrix (struct frame
*f
)
2482 /* F must have a frame matrix when this function is called. */
2483 xassert (!FRAME_WINDOW_P (f
));
2485 /* Clear all rows in the frame matrix covered by window matrices.
2486 Menu bar lines are not covered by windows. */
2487 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2488 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2490 /* Build the matrix by walking the window tree. */
2491 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2492 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2496 /* Walk a window tree, building a frame matrix MATRIX from window
2497 matrices. W is the root of a window tree. */
2500 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2504 if (!NILP (w
->hchild
))
2505 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2506 else if (!NILP (w
->vchild
))
2507 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2509 build_frame_matrix_from_leaf_window (matrix
, w
);
2511 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2516 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2517 desired frame matrix built. W is a leaf window whose desired or
2518 current matrix is to be added to FRAME_MATRIX. W's flag
2519 must_be_updated_p determines which matrix it contributes to
2520 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2521 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2522 Adding a desired matrix means setting up used counters and such in
2523 frame rows, while adding a current window matrix to FRAME_MATRIX
2524 means copying glyphs. The latter case corresponds to
2525 preserve_other_columns in the old redisplay. */
2528 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2530 struct glyph_matrix
*window_matrix
;
2531 int window_y
, frame_y
;
2532 /* If non-zero, a glyph to insert at the right border of W. */
2533 GLYPH right_border_glyph
;
2535 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2537 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2538 if (w
->must_be_updated_p
)
2540 window_matrix
= w
->desired_matrix
;
2542 /* Decide whether we want to add a vertical border glyph. */
2543 if (!WINDOW_RIGHTMOST_P (w
))
2545 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2548 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2550 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
))
2551 && GLYPH_CODE_CHAR_VALID_P (gc
))
2553 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2554 spec_glyph_lookup_face (w
, &right_border_glyph
);
2557 if (GLYPH_FACE (right_border_glyph
) <= 0)
2558 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2562 window_matrix
= w
->current_matrix
;
2564 /* For all rows in the window matrix and corresponding rows in the
2567 frame_y
= window_matrix
->matrix_y
;
2568 while (window_y
< window_matrix
->nrows
)
2570 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2571 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2572 int current_row_p
= window_matrix
== w
->current_matrix
;
2574 /* Fill up the frame row with spaces up to the left margin of the
2576 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2578 /* Fill up areas in the window matrix row with spaces. */
2579 fill_up_glyph_row_with_spaces (window_row
);
2581 /* If only part of W's desired matrix has been built, and
2582 window_row wasn't displayed, use the corresponding current
2584 if (window_matrix
== w
->desired_matrix
2585 && !window_row
->enabled_p
)
2587 window_row
= w
->current_matrix
->rows
+ window_y
;
2593 /* Copy window row to frame row. */
2594 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2595 window_row
->glyphs
[0],
2596 window_matrix
->matrix_w
* sizeof (struct glyph
));
2600 xassert (window_row
->enabled_p
);
2602 /* Only when a desired row has been displayed, we want
2603 the corresponding frame row to be updated. */
2604 frame_row
->enabled_p
= 1;
2606 /* Maybe insert a vertical border between horizontally adjacent
2608 if (GLYPH_CHAR (right_border_glyph
) != 0)
2610 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2611 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2615 /* Window row window_y must be a slice of frame row
2617 xassert (glyph_row_slice_p (window_row
, frame_row
));
2619 /* If rows are in sync, we don't have to copy glyphs because
2620 frame and window share glyphs. */
2622 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2623 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2627 /* Set number of used glyphs in the frame matrix. Since we fill
2628 up with spaces, and visit leaf windows from left to right it
2629 can be done simply. */
2630 frame_row
->used
[TEXT_AREA
]
2631 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2639 /* Given a user-specified glyph, possibly including a Lisp-level face
2640 ID, return a glyph that has a realized face ID.
2641 This is used for glyphs displayed specially and not part of the text;
2642 for instance, vertical separators, truncation markers, etc. */
2645 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2647 int lface_id
= GLYPH_FACE (*glyph
);
2648 /* Convert the glyph's specified face to a realized (cache) face. */
2651 int face_id
= merge_faces (XFRAME (w
->frame
),
2652 Qt
, lface_id
, DEFAULT_FACE_ID
);
2653 SET_GLYPH_FACE (*glyph
, face_id
);
2657 /* Add spaces to a glyph row ROW in a window matrix.
2659 Each row has the form:
2661 +---------+-----------------------------+------------+
2662 | left | text | right |
2663 +---------+-----------------------------+------------+
2665 Left and right marginal areas are optional. This function adds
2666 spaces to areas so that there are no empty holes between areas.
2667 In other words: If the right area is not empty, the text area
2668 is filled up with spaces up to the right area. If the text area
2669 is not empty, the left area is filled up.
2671 To be called for frame-based redisplay, only. */
2674 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2676 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2677 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2678 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2682 /* Fill area AREA of glyph row ROW with spaces. To be called for
2683 frame-based redisplay only. */
2686 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2688 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2690 struct glyph
*end
= row
->glyphs
[area
+ 1];
2691 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2694 *text
++ = space_glyph
;
2695 row
->used
[area
] = text
- row
->glyphs
[area
];
2700 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2701 reached. In frame matrices only one area, TEXT_AREA, is used. */
2704 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2706 int i
= row
->used
[TEXT_AREA
];
2707 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2710 glyph
[i
++] = space_glyph
;
2712 row
->used
[TEXT_AREA
] = i
;
2717 /**********************************************************************
2718 Mirroring operations on frame matrices in window matrices
2719 **********************************************************************/
2721 /* Set frame being updated via frame-based redisplay to F. This
2722 function must be called before updates to make explicit that we are
2723 working on frame matrices or not. */
2726 set_frame_matrix_frame (struct frame
*f
)
2728 frame_matrix_frame
= f
;
2732 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2733 DESIRED_MATRIX is the desired matrix corresponding to
2734 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2735 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2736 frame_matrix_frame is non-null, this indicates that the exchange is
2737 done in frame matrices, and that we have to perform analogous
2738 operations in window matrices of frame_matrix_frame. */
2741 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2743 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2744 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2745 int mouse_face_p
= current_row
->mouse_face_p
;
2747 /* Do current_row = desired_row. This exchanges glyph pointers
2748 between both rows, and does a structure assignment otherwise. */
2749 assign_row (current_row
, desired_row
);
2751 /* Enable current_row to mark it as valid. */
2752 current_row
->enabled_p
= 1;
2753 current_row
->mouse_face_p
= mouse_face_p
;
2755 /* If we are called on frame matrices, perform analogous operations
2756 for window matrices. */
2757 if (frame_matrix_frame
)
2758 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2762 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2763 W's frame which has been made current (by swapping pointers between
2764 current and desired matrix). Perform analogous operations in the
2765 matrices of leaf windows in the window tree rooted at W. */
2768 mirror_make_current (struct window
*w
, int frame_row
)
2772 if (!NILP (w
->hchild
))
2773 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2774 else if (!NILP (w
->vchild
))
2775 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2778 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2779 here because the checks performed in debug mode there
2780 will not allow the conversion. */
2781 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2783 /* If FRAME_ROW is within W, assign the desired row to the
2784 current row (exchanging glyph pointers). */
2785 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2787 struct glyph_row
*current_row
2788 = MATRIX_ROW (w
->current_matrix
, row
);
2789 struct glyph_row
*desired_row
2790 = MATRIX_ROW (w
->desired_matrix
, row
);
2792 if (desired_row
->enabled_p
)
2793 assign_row (current_row
, desired_row
);
2795 swap_glyph_pointers (desired_row
, current_row
);
2796 current_row
->enabled_p
= 1;
2798 /* Set the Y coordinate of the mode/header line's row.
2799 It is needed in draw_row_with_mouse_face to find the
2800 screen coordinates. (Window-based redisplay sets
2801 this in update_window, but no one seems to do that
2802 for frame-based redisplay.) */
2803 if (current_row
->mode_line_p
)
2804 current_row
->y
= row
;
2808 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2813 /* Perform row dance after scrolling. We are working on the range of
2814 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2815 including) in MATRIX. COPY_FROM is a vector containing, for each
2816 row I in the range 0 <= I < NLINES, the index of the original line
2817 to move to I. This index is relative to the row range, i.e. 0 <=
2818 index < NLINES. RETAINED_P is a vector containing zero for each
2819 row 0 <= I < NLINES which is empty.
2821 This function is called from do_scrolling and do_direct_scrolling. */
2824 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2825 int *copy_from
, char *retained_p
)
2827 /* A copy of original rows. */
2828 struct glyph_row
*old_rows
;
2830 /* Rows to assign to. */
2831 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2835 /* Make a copy of the original rows. */
2836 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2837 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2839 /* Assign new rows, maybe clear lines. */
2840 for (i
= 0; i
< nlines
; ++i
)
2842 int enabled_before_p
= new_rows
[i
].enabled_p
;
2844 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2845 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2846 new_rows
[i
] = old_rows
[copy_from
[i
]];
2847 new_rows
[i
].enabled_p
= enabled_before_p
;
2849 /* RETAINED_P is zero for empty lines. */
2850 if (!retained_p
[copy_from
[i
]])
2851 new_rows
[i
].enabled_p
= 0;
2854 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2855 if (frame_matrix_frame
)
2856 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2857 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2861 /* Synchronize glyph pointers in the current matrix of window W with
2862 the current frame matrix. */
2865 sync_window_with_frame_matrix_rows (struct window
*w
)
2867 struct frame
*f
= XFRAME (w
->frame
);
2868 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2869 int left
, right
, x
, width
;
2871 /* Preconditions: W must be a leaf window on a tty frame. */
2872 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2873 xassert (!FRAME_WINDOW_P (f
));
2875 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2876 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2877 x
= w
->current_matrix
->matrix_x
;
2878 width
= w
->current_matrix
->matrix_w
;
2880 window_row
= w
->current_matrix
->rows
;
2881 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2882 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2884 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2886 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2887 = frame_row
->glyphs
[0] + x
;
2888 window_row
->glyphs
[TEXT_AREA
]
2889 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2890 window_row
->glyphs
[LAST_AREA
]
2891 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2892 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2893 = window_row
->glyphs
[LAST_AREA
] - right
;
2898 /* Return the window in the window tree rooted in W containing frame
2899 row ROW. Value is null if none is found. */
2901 static struct window
*
2902 frame_row_to_window (struct window
*w
, int row
)
2904 struct window
*found
= NULL
;
2908 if (!NILP (w
->hchild
))
2909 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2910 else if (!NILP (w
->vchild
))
2911 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2912 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2913 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2916 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2923 /* Perform a line dance in the window tree rooted at W, after
2924 scrolling a frame matrix in mirrored_line_dance.
2926 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2927 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2928 COPY_FROM is a vector containing, for each row I in the range 0 <=
2929 I < NLINES, the index of the original line to move to I. This
2930 index is relative to the row range, i.e. 0 <= index < NLINES.
2931 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2935 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2939 if (!NILP (w
->hchild
))
2940 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2941 nlines
, copy_from
, retained_p
);
2942 else if (!NILP (w
->vchild
))
2943 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2944 nlines
, copy_from
, retained_p
);
2947 /* W is a leaf window, and we are working on its current
2949 struct glyph_matrix
*m
= w
->current_matrix
;
2951 struct glyph_row
*old_rows
;
2953 /* Make a copy of the original rows of matrix m. */
2954 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2955 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2957 for (i
= 0; i
< nlines
; ++i
)
2959 /* Frame relative line assigned to. */
2960 int frame_to
= i
+ unchanged_at_top
;
2962 /* Frame relative line assigned. */
2963 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2965 /* Window relative line assigned to. */
2966 int window_to
= frame_to
- m
->matrix_y
;
2968 /* Window relative line assigned. */
2969 int window_from
= frame_from
- m
->matrix_y
;
2971 /* Is assigned line inside window? */
2972 int from_inside_window_p
2973 = window_from
>= 0 && window_from
< m
->matrix_h
;
2975 /* Is assigned to line inside window? */
2976 int to_inside_window_p
2977 = window_to
>= 0 && window_to
< m
->matrix_h
;
2979 if (from_inside_window_p
&& to_inside_window_p
)
2981 /* Enabled setting before assignment. */
2982 int enabled_before_p
;
2984 /* Do the assignment. The enabled_p flag is saved
2985 over the assignment because the old redisplay did
2987 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2988 m
->rows
[window_to
] = old_rows
[window_from
];
2989 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2991 /* If frame line is empty, window line is empty, too. */
2992 if (!retained_p
[copy_from
[i
]])
2993 m
->rows
[window_to
].enabled_p
= 0;
2995 else if (to_inside_window_p
)
2997 /* A copy between windows. This is an infrequent
2998 case not worth optimizing. */
2999 struct frame
*f
= XFRAME (w
->frame
);
3000 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3002 struct glyph_matrix
*m2
;
3005 w2
= frame_row_to_window (root
, frame_from
);
3006 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3007 -nw', FROM_FRAME sometimes has no associated window.
3008 This check avoids a segfault if W2 is null. */
3011 m2
= w2
->current_matrix
;
3012 m2_from
= frame_from
- m2
->matrix_y
;
3013 copy_row_except_pointers (m
->rows
+ window_to
,
3014 m2
->rows
+ m2_from
);
3016 /* If frame line is empty, window line is empty, too. */
3017 if (!retained_p
[copy_from
[i
]])
3018 m
->rows
[window_to
].enabled_p
= 0;
3022 else if (from_inside_window_p
)
3026 /* If there was a copy between windows, make sure glyph
3027 pointers are in sync with the frame matrix. */
3029 sync_window_with_frame_matrix_rows (w
);
3031 /* Check that no pointers are lost. */
3035 /* Next window on same level. */
3036 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3043 /* Check that window and frame matrices agree about their
3044 understanding where glyphs of the rows are to find. For each
3045 window in the window tree rooted at W, check that rows in the
3046 matrices of leaf window agree with their frame matrices about
3050 check_window_matrix_pointers (struct window
*w
)
3054 if (!NILP (w
->hchild
))
3055 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3056 else if (!NILP (w
->vchild
))
3057 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3060 struct frame
*f
= XFRAME (w
->frame
);
3061 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3062 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3065 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3070 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3071 a window and FRAME_MATRIX is the corresponding frame matrix. For
3072 each row in WINDOW_MATRIX check that it's a slice of the
3073 corresponding frame row. If it isn't, abort. */
3076 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3077 struct glyph_matrix
*frame_matrix
)
3079 /* Row number in WINDOW_MATRIX. */
3082 /* Row number corresponding to I in FRAME_MATRIX. */
3083 int j
= window_matrix
->matrix_y
;
3085 /* For all rows check that the row in the window matrix is a
3086 slice of the row in the frame matrix. If it isn't we didn't
3087 mirror an operation on the frame matrix correctly. */
3088 while (i
< window_matrix
->nrows
)
3090 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3091 frame_matrix
->rows
+ j
))
3097 #endif /* GLYPH_DEBUG != 0 */
3101 /**********************************************************************
3102 VPOS and HPOS translations
3103 **********************************************************************/
3107 /* Translate vertical position VPOS which is relative to window W to a
3108 vertical position relative to W's frame. */
3111 window_to_frame_vpos (struct window
*w
, int vpos
)
3113 struct frame
*f
= XFRAME (w
->frame
);
3115 xassert (!FRAME_WINDOW_P (f
));
3116 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3117 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3118 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (f
));
3123 /* Translate horizontal position HPOS which is relative to window W to
3124 a horizontal position relative to W's frame. */
3127 window_to_frame_hpos (struct window
*w
, int hpos
)
3129 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3130 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3134 #endif /* GLYPH_DEBUG */
3138 /**********************************************************************
3140 **********************************************************************/
3142 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3143 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3148 CHECK_LIVE_FRAME (frame
);
3151 /* Ignore redraw requests, if frame has no glyphs yet.
3152 (Implementation note: It still has to be checked why we are
3153 called so early here). */
3154 if (!glyphs_initialized_initially_p
)
3159 if (FRAME_MSDOS_P (f
))
3160 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3163 clear_current_matrices (f
);
3165 if (FRAME_TERMCAP_P (f
))
3166 fflush (FRAME_TTY (f
)->output
);
3167 windows_or_buffers_changed
++;
3168 /* Mark all windows as inaccurate, so that every window will have
3169 its redisplay done. */
3170 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3171 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3177 /* Redraw frame F. This is nothing more than a call to the Lisp
3178 function redraw-frame. */
3181 redraw_frame (struct frame
*f
)
3184 XSETFRAME (frame
, f
);
3185 Fredraw_frame (frame
);
3189 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3190 doc
: /* Clear and redisplay all visible frames. */)
3193 Lisp_Object tail
, frame
;
3195 FOR_EACH_FRAME (tail
, frame
)
3196 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3197 Fredraw_frame (frame
);
3203 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3204 visible frames marked as garbaged. */
3207 redraw_garbaged_frames (void)
3209 Lisp_Object tail
, frame
;
3211 FOR_EACH_FRAME (tail
, frame
)
3212 if (FRAME_VISIBLE_P (XFRAME (frame
))
3213 && FRAME_GARBAGED_P (XFRAME (frame
)))
3214 Fredraw_frame (frame
);
3219 /***********************************************************************
3221 ***********************************************************************/
3223 /* Update frame F based on the data in desired matrices.
3225 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3226 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3229 Value is non-zero if redisplay was stopped due to pending input. */
3232 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3234 /* 1 means display has been paused because of pending input. */
3236 struct window
*root_window
= XWINDOW (f
->root_window
);
3238 if (redisplay_dont_pause
)
3240 #if PERIODIC_PREEMPTION_CHECKING
3241 else if (NILP (Vredisplay_preemption_period
))
3243 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3246 double p
= XFLOATINT (Vredisplay_preemption_period
);
3249 if (detect_input_pending_ignore_squeezables ())
3256 usec
= (p
- sec
) * 1000000;
3258 EMACS_GET_TIME (tm
);
3259 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3260 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3264 if (FRAME_WINDOW_P (f
))
3266 /* We are working on window matrix basis. All windows whose
3267 flag must_be_updated_p is set have to be updated. */
3269 /* Record that we are not working on frame matrices. */
3270 set_frame_matrix_frame (NULL
);
3272 /* Update all windows in the window tree of F, maybe stopping
3273 when pending input is detected. */
3276 /* Update the menu bar on X frames that don't have toolkit
3278 if (WINDOWP (f
->menu_bar_window
))
3279 update_window (XWINDOW (f
->menu_bar_window
), 1);
3281 /* Update the tool-bar window, if present. */
3282 if (WINDOWP (f
->tool_bar_window
))
3284 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3286 /* Update tool-bar window. */
3287 if (w
->must_be_updated_p
)
3291 update_window (w
, 1);
3292 w
->must_be_updated_p
= 0;
3294 /* Swap tool-bar strings. We swap because we want to
3296 tem
= f
->current_tool_bar_string
;
3297 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3298 f
->desired_tool_bar_string
= tem
;
3303 /* Update windows. */
3304 paused_p
= update_window_tree (root_window
, force_p
);
3307 /* This flush is a performance bottleneck under X,
3308 and it doesn't seem to be necessary anyway (in general).
3309 It is necessary when resizing the window with the mouse, or
3310 at least the fringes are not redrawn in a timely manner. ++kfs */
3311 if (f
->force_flush_display_p
)
3313 FRAME_RIF (f
)->flush_display (f
);
3314 f
->force_flush_display_p
= 0;
3319 /* We are working on frame matrix basis. Set the frame on whose
3320 frame matrix we operate. */
3321 set_frame_matrix_frame (f
);
3323 /* Build F's desired matrix from window matrices. */
3324 build_frame_matrix (f
);
3326 /* Update the display */
3328 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3331 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3333 if (FRAME_TTY (f
)->termscript
)
3334 fflush (FRAME_TTY (f
)->termscript
);
3335 if (FRAME_TERMCAP_P (f
))
3336 fflush (FRAME_TTY (f
)->output
);
3339 /* Check window matrices for lost pointers. */
3341 check_window_matrix_pointers (root_window
);
3342 add_frame_display_history (f
, paused_p
);
3346 #if PERIODIC_PREEMPTION_CHECKING
3349 /* Reset flags indicating that a window should be updated. */
3350 set_window_update_flags (root_window
, 0);
3352 display_completed
= !paused_p
;
3358 /************************************************************************
3359 Window-based updates
3360 ************************************************************************/
3362 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3363 don't stop updating when input is pending. */
3366 update_window_tree (struct window
*w
, int force_p
)
3370 while (w
&& !paused_p
)
3372 if (!NILP (w
->hchild
))
3373 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3374 else if (!NILP (w
->vchild
))
3375 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3376 else if (w
->must_be_updated_p
)
3377 paused_p
|= update_window (w
, force_p
);
3379 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3386 /* Update window W if its flag must_be_updated_p is non-zero. If
3387 FORCE_P is non-zero, don't stop updating if input is pending. */
3390 update_single_window (struct window
*w
, int force_p
)
3392 if (w
->must_be_updated_p
)
3394 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3396 /* Record that this is not a frame-based redisplay. */
3397 set_frame_matrix_frame (NULL
);
3399 if (redisplay_dont_pause
)
3401 #if PERIODIC_PREEMPTION_CHECKING
3402 else if (NILP (Vredisplay_preemption_period
))
3404 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3407 double p
= XFLOATINT (Vredisplay_preemption_period
);
3411 usec
= (p
- sec
) * 1000000;
3413 EMACS_GET_TIME (tm
);
3414 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3415 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3421 update_window (w
, force_p
);
3424 /* Reset flag in W. */
3425 w
->must_be_updated_p
= 0;
3429 #ifdef HAVE_WINDOW_SYSTEM
3431 /* Redraw lines from the current matrix of window W that are
3432 overlapped by other rows. YB is bottom-most y-position in W. */
3435 redraw_overlapped_rows (struct window
*w
, int yb
)
3438 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3440 /* If rows overlapping others have been changed, the rows being
3441 overlapped have to be redrawn. This won't draw lines that have
3442 already been drawn in update_window_line because overlapped_p in
3443 desired rows is 0, so after row assignment overlapped_p in
3444 current rows is 0. */
3445 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3447 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3449 if (!row
->enabled_p
)
3451 else if (row
->mode_line_p
)
3454 if (row
->overlapped_p
)
3456 enum glyph_row_area area
;
3458 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3461 updated_area
= area
;
3462 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3463 area
== TEXT_AREA
? row
->x
: 0);
3464 if (row
->used
[area
])
3465 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3467 FRAME_RIF (f
)->clear_end_of_line (-1);
3470 row
->overlapped_p
= 0;
3473 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3479 /* Redraw lines from the current matrix of window W that overlap
3480 others. YB is bottom-most y-position in W. */
3483 redraw_overlapping_rows (struct window
*w
, int yb
)
3486 struct glyph_row
*row
;
3487 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3489 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3491 row
= w
->current_matrix
->rows
+ i
;
3493 if (!row
->enabled_p
)
3495 else if (row
->mode_line_p
)
3498 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3500 if (row
->overlapping_p
)
3504 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3505 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3506 overlaps
|= OVERLAPS_PRED
;
3507 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3508 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3509 overlaps
|= OVERLAPS_SUCC
;
3513 if (row
->used
[LEFT_MARGIN_AREA
])
3514 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3516 if (row
->used
[TEXT_AREA
])
3517 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3519 if (row
->used
[RIGHT_MARGIN_AREA
])
3520 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3522 /* Record in neighbour rows that ROW overwrites part of
3524 if (overlaps
& OVERLAPS_PRED
)
3525 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3526 if (overlaps
& OVERLAPS_SUCC
)
3527 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3536 #endif /* HAVE_WINDOW_SYSTEM */
3539 #if defined GLYPH_DEBUG && 0
3541 /* Check that no row in the current matrix of window W is enabled
3542 which is below what's displayed in the window. */
3545 check_current_matrix_flags (struct window
*w
)
3547 int last_seen_p
= 0;
3548 int i
, yb
= window_text_bottom_y (w
);
3550 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3552 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3553 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3555 else if (last_seen_p
&& row
->enabled_p
)
3560 #endif /* GLYPH_DEBUG */
3563 /* Update display of window W. FORCE_P non-zero means that we should
3564 not stop when detecting pending input. */
3567 update_window (struct window
*w
, int force_p
)
3569 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3571 #if !PERIODIC_PREEMPTION_CHECKING
3572 int preempt_count
= baud_rate
/ 2400 + 1;
3574 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3576 /* Check that W's frame doesn't have glyph matrices. */
3577 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3580 /* Check pending input the first time so that we can quickly return. */
3581 #if !PERIODIC_PREEMPTION_CHECKING
3583 detect_input_pending_ignore_squeezables ();
3586 /* If forced to complete the update, or if no input is pending, do
3588 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3590 struct glyph_row
*row
, *end
;
3591 struct glyph_row
*mode_line_row
;
3592 struct glyph_row
*header_line_row
;
3593 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0, n_updated
;
3595 rif
->update_window_begin_hook (w
);
3596 yb
= window_text_bottom_y (w
);
3598 /* If window has a header line, update it before everything else.
3599 Adjust y-positions of other rows by the header line height. */
3600 row
= desired_matrix
->rows
;
3601 end
= row
+ desired_matrix
->nrows
- 1;
3603 if (row
->mode_line_p
)
3605 header_line_row
= row
;
3609 header_line_row
= NULL
;
3611 /* Update the mode line, if necessary. */
3612 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3613 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3615 mode_line_row
->y
= yb
;
3616 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3618 &mouse_face_overwritten_p
);
3621 /* Find first enabled row. Optimizations in redisplay_internal
3622 may lead to an update with only one row enabled. There may
3623 be also completely empty matrices. */
3624 while (row
< end
&& !row
->enabled_p
)
3627 /* Try reusing part of the display by copying. */
3628 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3630 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3633 /* All rows were found to be equal. */
3639 /* We've scrolled the display. */
3645 /* Update the rest of the lines. */
3646 for (n_updated
= 0; row
< end
&& (force_p
|| !input_pending
); ++row
)
3649 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3652 /* We'll have to play a little bit with when to
3653 detect_input_pending. If it's done too often,
3654 scrolling large windows with repeated scroll-up
3655 commands will too quickly pause redisplay. */
3656 #if PERIODIC_PREEMPTION_CHECKING
3660 EMACS_GET_TIME (tm
);
3661 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3662 if (EMACS_TIME_NEG_P (dif
))
3664 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3665 if (detect_input_pending_ignore_squeezables ())
3670 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3671 detect_input_pending_ignore_squeezables ();
3673 changed_p
|= update_window_line (w
, vpos
,
3674 &mouse_face_overwritten_p
);
3676 /* Mark all rows below the last visible one in the current
3677 matrix as invalid. This is necessary because of
3678 variable line heights. Consider the case of three
3679 successive redisplays, where the first displays 5
3680 lines, the second 3 lines, and the third 5 lines again.
3681 If the second redisplay wouldn't mark rows in the
3682 current matrix invalid, the third redisplay might be
3683 tempted to optimize redisplay based on lines displayed
3684 in the first redisplay. */
3685 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3686 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3687 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3690 /* Was display preempted? */
3691 paused_p
= row
< end
;
3695 /* Update the header line after scrolling because a new header
3696 line would otherwise overwrite lines at the top of the window
3697 that can be scrolled. */
3698 if (header_line_row
&& header_line_row
->enabled_p
)
3700 header_line_row
->y
= 0;
3701 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3704 /* Fix the appearance of overlapping/overlapped rows. */
3705 if (!paused_p
&& !w
->pseudo_window_p
)
3707 #ifdef HAVE_WINDOW_SYSTEM
3708 if (changed_p
&& rif
->fix_overlapping_area
)
3710 redraw_overlapped_rows (w
, yb
);
3711 redraw_overlapping_rows (w
, yb
);
3715 /* Make cursor visible at cursor position of W. */
3716 set_window_cursor_after_update (w
);
3718 #if 0 /* Check that current matrix invariants are satisfied. This is
3719 for debugging only. See the comment of check_matrix_invariants. */
3720 IF_DEBUG (check_matrix_invariants (w
));
3725 /* Remember the redisplay method used to display the matrix. */
3726 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3729 #ifdef HAVE_WINDOW_SYSTEM
3730 update_window_fringes (w
, 0);
3733 /* End the update of window W. Don't set the cursor if we
3734 paused updating the display because in this case,
3735 set_window_cursor_after_update hasn't been called, and
3736 output_cursor doesn't contain the cursor location. */
3737 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3743 /* check_current_matrix_flags (w); */
3744 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3747 clear_glyph_matrix (desired_matrix
);
3753 /* Update the display of area AREA in window W, row number VPOS.
3754 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3757 update_marginal_area (struct window
*w
, int area
, int vpos
)
3759 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3760 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3762 /* Let functions in xterm.c know what area subsequent X positions
3763 will be relative to. */
3764 updated_area
= area
;
3766 /* Set cursor to start of glyphs, write them, and clear to the end
3767 of the area. I don't think that something more sophisticated is
3768 necessary here, since marginal areas will not be the default. */
3769 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3770 if (desired_row
->used
[area
])
3771 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3772 rif
->clear_end_of_line (-1);
3776 /* Update the display of the text area of row VPOS in window W.
3777 Value is non-zero if display has changed. */
3780 update_text_area (struct window
*w
, int vpos
)
3782 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3783 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3784 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3787 /* Let functions in xterm.c know what area subsequent X positions
3788 will be relative to. */
3789 updated_area
= TEXT_AREA
;
3791 /* If rows are at different X or Y, or rows have different height,
3792 or the current row is marked invalid, write the entire line. */
3793 if (!current_row
->enabled_p
3794 || desired_row
->y
!= current_row
->y
3795 || desired_row
->ascent
!= current_row
->ascent
3796 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3797 || desired_row
->phys_height
!= current_row
->phys_height
3798 || desired_row
->visible_height
!= current_row
->visible_height
3799 || current_row
->overlapped_p
3800 /* This next line is necessary for correctly redrawing
3801 mouse-face areas after scrolling and other operations.
3802 However, it causes excessive flickering when mouse is moved
3803 across the mode line. Luckily, turning it off for the mode
3804 line doesn't seem to hurt anything. -- cyd.
3805 But it is still needed for the header line. -- kfs. */
3806 || (current_row
->mouse_face_p
3807 && !(current_row
->mode_line_p
&& vpos
> 0))
3808 || current_row
->x
!= desired_row
->x
)
3810 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3812 if (desired_row
->used
[TEXT_AREA
])
3813 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3814 desired_row
->used
[TEXT_AREA
]);
3816 /* Clear to end of window. */
3817 rif
->clear_end_of_line (-1);
3820 /* This erases the cursor. We do this here because
3821 notice_overwritten_cursor cannot easily check this, which
3822 might indicate that the whole functionality of
3823 notice_overwritten_cursor would better be implemented here.
3824 On the other hand, we need notice_overwritten_cursor as long
3825 as mouse highlighting is done asynchronously outside of
3827 if (vpos
== w
->phys_cursor
.vpos
)
3828 w
->phys_cursor_on_p
= 0;
3833 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3834 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3835 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3836 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3837 int abort_skipping
= 0;
3839 /* If the desired row extends its face to the text area end, and
3840 unless the current row also does so at the same position,
3841 make sure we write at least one glyph, so that the face
3842 extension actually takes place. */
3843 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3844 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3845 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3846 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3849 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3853 /* Loop over glyphs that current and desired row may have
3857 int can_skip_p
= !abort_skipping
;
3859 /* Skip over glyphs that both rows have in common. These
3860 don't have to be written. We can't skip if the last
3861 current glyph overlaps the glyph to its right. For
3862 example, consider a current row of `if ' with the `f' in
3863 Courier bold so that it overlaps the ` ' to its right.
3864 If the desired row is ` ', we would skip over the space
3865 after the `if' and there would remain a pixel from the
3866 `f' on the screen. */
3867 if (overlapping_glyphs_p
&& i
> 0)
3869 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3872 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3874 can_skip_p
= (right
== 0 && !abort_skipping
);
3882 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3884 x
+= desired_glyph
->pixel_width
;
3885 ++desired_glyph
, ++current_glyph
, ++i
;
3888 /* Consider the case that the current row contains "xxx
3889 ppp ggg" in italic Courier font, and the desired row
3890 is "xxx ggg". The character `p' has lbearing, `g'
3891 has not. The loop above will stop in front of the
3892 first `p' in the current row. If we would start
3893 writing glyphs there, we wouldn't erase the lbearing
3894 of the `p'. The rest of the lbearing problem is then
3895 taken care of by draw_glyphs. */
3896 if (overlapping_glyphs_p
3898 && i
< current_row
->used
[TEXT_AREA
]
3899 && (current_row
->used
[TEXT_AREA
]
3900 != desired_row
->used
[TEXT_AREA
]))
3904 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3906 while (left
> 0 && i
> 0)
3908 --i
, --desired_glyph
, --current_glyph
;
3909 x
-= desired_glyph
->pixel_width
;
3910 left
-= desired_glyph
->pixel_width
;
3913 /* Abort the skipping algorithm if we end up before
3914 our starting point, to avoid looping (bug#1070).
3915 This can happen when the lbearing is larger than
3917 abort_skipping
= (i
< start_hpos
);
3921 /* Try to avoid writing the entire rest of the desired row
3922 by looking for a resync point. This mainly prevents
3923 mode line flickering in the case the mode line is in
3924 fixed-pitch font, which it usually will be. */
3925 if (i
< desired_row
->used
[TEXT_AREA
])
3927 int start_x
= x
, start_hpos
= i
;
3928 struct glyph
*start
= desired_glyph
;
3930 int skip_first_p
= !can_skip_p
;
3932 /* Find the next glyph that's equal again. */
3935 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3938 x
+= desired_glyph
->pixel_width
;
3939 current_x
+= current_glyph
->pixel_width
;
3940 ++desired_glyph
, ++current_glyph
, ++i
;
3944 if (i
== start_hpos
|| x
!= current_x
)
3948 desired_glyph
= start
;
3952 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3953 rif
->write_glyphs (start
, i
- start_hpos
);
3958 /* Write the rest. */
3959 if (i
< desired_row
->used
[TEXT_AREA
])
3961 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3962 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3966 /* Maybe clear to end of line. */
3967 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3969 /* If new row extends to the end of the text area, nothing
3970 has to be cleared, if and only if we did a write_glyphs
3971 above. This is made sure by setting desired_stop_pos
3972 appropriately above. */
3973 xassert (i
< desired_row
->used
[TEXT_AREA
]
3974 || ((desired_row
->used
[TEXT_AREA
]
3975 == current_row
->used
[TEXT_AREA
])
3976 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3978 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3980 /* If old row extends to the end of the text area, clear. */
3981 if (i
>= desired_row
->used
[TEXT_AREA
])
3982 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3983 desired_row
->pixel_width
);
3984 rif
->clear_end_of_line (-1);
3987 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3989 /* Otherwise clear to the end of the old row. Everything
3990 after that position should be clear already. */
3993 if (i
>= desired_row
->used
[TEXT_AREA
])
3994 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3995 desired_row
->pixel_width
);
3997 /* If cursor is displayed at the end of the line, make sure
3998 it's cleared. Nowadays we don't have a phys_cursor_glyph
3999 with which to erase the cursor (because this method
4000 doesn't work with lbearing/rbearing), so we must do it
4002 if (vpos
== w
->phys_cursor
.vpos
4003 && (desired_row
->reversed_p
4004 ? (w
->phys_cursor
.hpos
< 0)
4005 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
4007 w
->phys_cursor_on_p
= 0;
4011 xlim
= current_row
->pixel_width
;
4012 rif
->clear_end_of_line (xlim
);
4021 /* Update row VPOS in window W. Value is non-zero if display has been
4025 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
4027 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
4028 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
4029 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4032 /* Set the row being updated. This is important to let xterm.c
4033 know what line height values are in effect. */
4034 updated_row
= desired_row
;
4036 /* A row can be completely invisible in case a desired matrix was
4037 built with a vscroll and then make_cursor_line_fully_visible shifts
4038 the matrix. Make sure to make such rows current anyway, since
4039 we need the correct y-position, for example, in the current matrix. */
4040 if (desired_row
->mode_line_p
4041 || desired_row
->visible_height
> 0)
4043 xassert (desired_row
->enabled_p
);
4045 /* Update display of the left margin area, if there is one. */
4046 if (!desired_row
->full_width_p
4047 && !NILP (w
->left_margin_cols
))
4050 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4053 /* Update the display of the text area. */
4054 if (update_text_area (w
, vpos
))
4057 if (current_row
->mouse_face_p
)
4058 *mouse_face_overwritten_p
= 1;
4061 /* Update display of the right margin area, if there is one. */
4062 if (!desired_row
->full_width_p
4063 && !NILP (w
->right_margin_cols
))
4066 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4069 /* Draw truncation marks etc. */
4070 if (!current_row
->enabled_p
4071 || desired_row
->y
!= current_row
->y
4072 || desired_row
->visible_height
!= current_row
->visible_height
4073 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4074 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4075 || current_row
->redraw_fringe_bitmaps_p
4076 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4077 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4078 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4079 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4080 rif
->after_update_window_line_hook (desired_row
);
4083 /* Update current_row from desired_row. */
4084 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4090 /* Set the cursor after an update of window W. This function may only
4091 be called from update_window. */
4094 set_window_cursor_after_update (struct window
*w
)
4096 struct frame
*f
= XFRAME (w
->frame
);
4097 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4098 int cx
, cy
, vpos
, hpos
;
4100 /* Not intended for frame matrix updates. */
4101 xassert (FRAME_WINDOW_P (f
));
4103 if (cursor_in_echo_area
4104 && !NILP (echo_area_buffer
[0])
4105 /* If we are showing a message instead of the mini-buffer,
4106 show the cursor for the message instead. */
4107 && XWINDOW (minibuf_window
) == w
4108 && EQ (minibuf_window
, echo_area_window
)
4109 /* These cases apply only to the frame that contains
4110 the active mini-buffer window. */
4111 && FRAME_HAS_MINIBUF_P (f
)
4112 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4114 cx
= cy
= vpos
= hpos
= 0;
4116 if (cursor_in_echo_area
>= 0)
4118 /* If the mini-buffer is several lines high, find the last
4119 line that has any text on it. Note: either all lines
4120 are enabled or none. Otherwise we wouldn't be able to
4122 struct glyph_row
*row
, *last_row
;
4123 struct glyph
*glyph
;
4124 int yb
= window_text_bottom_y (w
);
4127 row
= w
->current_matrix
->rows
;
4128 while (row
->enabled_p
4129 && (last_row
== NULL
4130 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4132 if (row
->used
[TEXT_AREA
]
4133 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4140 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4141 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4143 while (last
> start
&& last
->charpos
< 0)
4146 for (glyph
= start
; glyph
< last
; ++glyph
)
4148 cx
+= glyph
->pixel_width
;
4153 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4161 hpos
= w
->cursor
.hpos
;
4162 vpos
= w
->cursor
.vpos
;
4165 /* Window cursor can be out of sync for horizontally split windows. */
4166 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4167 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4168 vpos
= max (0, vpos
);
4169 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4170 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4174 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4175 tree rooted at W. */
4178 set_window_update_flags (struct window
*w
, int on_p
)
4182 if (!NILP (w
->hchild
))
4183 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4184 else if (!NILP (w
->vchild
))
4185 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4187 w
->must_be_updated_p
= on_p
;
4189 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4195 /***********************************************************************
4196 Window-Based Scrolling
4197 ***********************************************************************/
4199 /* Structure describing rows in scrolling_window. */
4203 /* Number of occurrences of this row in desired and current matrix. */
4204 int old_uses
, new_uses
;
4206 /* Vpos of row in new matrix. */
4207 int new_line_number
;
4209 /* Bucket index of this row_entry in the hash table row_table. */
4212 /* The row described by this entry. */
4213 struct glyph_row
*row
;
4215 /* Hash collision chain. */
4216 struct row_entry
*next
;
4219 /* A pool to allocate row_entry structures from, and the size of the
4220 pool. The pool is reallocated in scrolling_window when we find
4221 that we need a larger one. */
4223 static struct row_entry
*row_entry_pool
;
4224 static int row_entry_pool_size
;
4226 /* Index of next free entry in row_entry_pool. */
4228 static int row_entry_idx
;
4230 /* The hash table used during scrolling, and the table's size. This
4231 table is used to quickly identify equal rows in the desired and
4234 static struct row_entry
**row_table
;
4235 static int row_table_size
;
4237 /* Vectors of pointers to row_entry structures belonging to the
4238 current and desired matrix, and the size of the vectors. */
4240 static struct row_entry
**old_lines
, **new_lines
;
4241 static int old_lines_size
, new_lines_size
;
4243 /* A pool to allocate run structures from, and its size. */
4245 static struct run
*run_pool
;
4246 static int runs_size
;
4248 /* A vector of runs of lines found during scrolling. */
4250 static struct run
**runs
;
4252 /* Add glyph row ROW to the scrolling hash table. */
4254 static INLINE
struct row_entry
*
4255 add_row_entry (struct glyph_row
*row
)
4257 struct row_entry
*entry
;
4258 int i
= row
->hash
% row_table_size
;
4260 entry
= row_table
[i
];
4261 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4262 entry
= entry
->next
;
4266 entry
= row_entry_pool
+ row_entry_idx
++;
4268 entry
->old_uses
= entry
->new_uses
= 0;
4269 entry
->new_line_number
= 0;
4271 entry
->next
= row_table
[i
];
4272 row_table
[i
] = entry
;
4279 /* Try to reuse part of the current display of W by scrolling lines.
4280 HEADER_LINE_P non-zero means W has a header line.
4282 The algorithm is taken from Communications of the ACM, Apr78 "A
4283 Technique for Isolating Differences Between Files." It should take
4286 A short outline of the steps of the algorithm
4288 1. Skip lines equal at the start and end of both matrices.
4290 2. Enter rows in the current and desired matrix into a symbol
4291 table, counting how often they appear in both matrices.
4293 3. Rows that appear exactly once in both matrices serve as anchors,
4294 i.e. we assume that such lines are likely to have been moved.
4296 4. Starting from anchor lines, extend regions to be scrolled both
4297 forward and backward.
4301 -1 if all rows were found to be equal.
4302 0 to indicate that we did not scroll the display, or
4303 1 if we did scroll. */
4306 scrolling_window (struct window
*w
, int header_line_p
)
4308 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4309 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4310 int yb
= window_text_bottom_y (w
);
4311 int i
, j
, first_old
, first_new
, last_old
, last_new
;
4312 int nruns
, nbytes
, n
, run_idx
;
4313 struct row_entry
*entry
;
4314 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4316 /* Skip over rows equal at the start. */
4317 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4319 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4320 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4324 && !d
->redraw_fringe_bitmaps_p
4326 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4327 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4328 && row_equal_p (c
, d
, 1))
4337 /* Give up if some rows in the desired matrix are not enabled. */
4338 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4341 first_old
= first_new
= i
;
4343 /* Set last_new to the index + 1 of the last enabled row in the
4346 while (i
< desired_matrix
->nrows
- 1
4347 && MATRIX_ROW (desired_matrix
, i
)->enabled_p
4348 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
)) <= yb
)
4351 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4356 /* Set last_old to the index + 1 of the last enabled row in the
4357 current matrix. We don't look at the enabled flag here because
4358 we plan to reuse part of the display even if other parts are
4361 while (i
< current_matrix
->nrows
- 1)
4363 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4372 /* Skip over rows equal at the bottom. */
4375 while (i
- 1 > first_new
4376 && j
- 1 > first_old
4377 && MATRIX_ROW (current_matrix
, i
- 1)->enabled_p
4378 && (MATRIX_ROW (current_matrix
, i
- 1)->y
4379 == MATRIX_ROW (desired_matrix
, j
- 1)->y
)
4380 && !MATRIX_ROW (desired_matrix
, j
- 1)->redraw_fringe_bitmaps_p
4381 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4382 MATRIX_ROW (current_matrix
, j
- 1), 1))
4387 /* Nothing to do if all rows are equal. */
4388 if (last_new
== first_new
)
4391 /* Reallocate vectors, tables etc. if necessary. */
4393 if (current_matrix
->nrows
> old_lines_size
)
4395 old_lines_size
= current_matrix
->nrows
;
4396 nbytes
= old_lines_size
* sizeof *old_lines
;
4397 old_lines
= (struct row_entry
**) xrealloc (old_lines
, nbytes
);
4400 if (desired_matrix
->nrows
> new_lines_size
)
4402 new_lines_size
= desired_matrix
->nrows
;
4403 nbytes
= new_lines_size
* sizeof *new_lines
;
4404 new_lines
= (struct row_entry
**) xrealloc (new_lines
, nbytes
);
4407 n
= desired_matrix
->nrows
+ current_matrix
->nrows
;
4408 if (3 * n
> row_table_size
)
4410 row_table_size
= next_almost_prime (3 * n
);
4411 nbytes
= row_table_size
* sizeof *row_table
;
4412 row_table
= (struct row_entry
**) xrealloc (row_table
, nbytes
);
4413 memset (row_table
, 0, nbytes
);
4416 if (n
> row_entry_pool_size
)
4418 row_entry_pool_size
= n
;
4419 nbytes
= row_entry_pool_size
* sizeof *row_entry_pool
;
4420 row_entry_pool
= (struct row_entry
*) xrealloc (row_entry_pool
, nbytes
);
4423 if (desired_matrix
->nrows
> runs_size
)
4425 runs_size
= desired_matrix
->nrows
;
4426 nbytes
= runs_size
* sizeof *runs
;
4427 runs
= (struct run
**) xrealloc (runs
, nbytes
);
4428 nbytes
= runs_size
* sizeof *run_pool
;
4429 run_pool
= (struct run
*) xrealloc (run_pool
, nbytes
);
4432 nruns
= run_idx
= 0;
4435 /* Add rows from the current and desired matrix to the hash table
4436 row_hash_table to be able to find equal ones quickly. */
4438 for (i
= first_old
; i
< last_old
; ++i
)
4440 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4442 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4443 old_lines
[i
] = entry
;
4447 old_lines
[i
] = NULL
;
4450 for (i
= first_new
; i
< last_new
; ++i
)
4452 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4453 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4455 entry
->new_line_number
= i
;
4456 new_lines
[i
] = entry
;
4459 /* Identify moves based on lines that are unique and equal
4460 in both matrices. */
4461 for (i
= first_old
; i
< last_old
;)
4463 && old_lines
[i
]->old_uses
== 1
4464 && old_lines
[i
]->new_uses
== 1)
4467 int new_line
= old_lines
[i
]->new_line_number
;
4468 struct run
*run
= run_pool
+ run_idx
++;
4471 run
->current_vpos
= i
;
4472 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4473 run
->desired_vpos
= new_line
;
4474 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4476 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4478 /* Extend backward. */
4481 while (p
> first_old
4483 && old_lines
[p
] == new_lines
[q
])
4485 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4486 --run
->current_vpos
;
4487 --run
->desired_vpos
;
4490 run
->desired_y
-= h
;
4491 run
->current_y
-= h
;
4495 /* Extend forward. */
4500 && old_lines
[p
] == new_lines
[q
])
4502 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4508 /* Insert run into list of all runs. Order runs by copied
4509 pixel lines. Note that we record runs that don't have to
4510 be copied because they are already in place. This is done
4511 because we can avoid calling update_window_line in this
4513 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4515 for (q
= nruns
; q
> p
; --q
)
4516 runs
[q
] = runs
[q
- 1];
4525 /* Do the moves. Do it in a way that we don't overwrite something
4526 we want to copy later on. This is not solvable in general
4527 because there is only one display and we don't have a way to
4528 exchange areas on this display. Example:
4530 +-----------+ +-----------+
4532 +-----------+ --> +-----------+
4534 +-----------+ +-----------+
4536 Instead, prefer bigger moves, and invalidate moves that would
4537 copy from where we copied to. */
4539 for (i
= 0; i
< nruns
; ++i
)
4540 if (runs
[i
]->nrows
> 0)
4542 struct run
*r
= runs
[i
];
4544 /* Copy on the display. */
4545 if (r
->current_y
!= r
->desired_y
)
4547 rif
->scroll_run_hook (w
, r
);
4549 /* Invalidate runs that copy from where we copied to. */
4550 for (j
= i
+ 1; j
< nruns
; ++j
)
4552 struct run
*p
= runs
[j
];
4554 if ((p
->current_y
>= r
->desired_y
4555 && p
->current_y
< r
->desired_y
+ r
->height
)
4556 || (p
->current_y
+ p
->height
>= r
->desired_y
4557 && (p
->current_y
+ p
->height
4558 < r
->desired_y
+ r
->height
)))
4563 /* Assign matrix rows. */
4564 for (j
= 0; j
< r
->nrows
; ++j
)
4566 struct glyph_row
*from
, *to
;
4567 int to_overlapped_p
;
4569 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4570 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4571 to_overlapped_p
= to
->overlapped_p
;
4572 if (!from
->mode_line_p
&& !w
->pseudo_window_p
4573 && (to
->left_fringe_bitmap
!= from
->left_fringe_bitmap
4574 || to
->right_fringe_bitmap
!= from
->right_fringe_bitmap
4575 || to
->left_fringe_face_id
!= from
->left_fringe_face_id
4576 || to
->right_fringe_face_id
!= from
->right_fringe_face_id
4577 || to
->overlay_arrow_bitmap
!= from
->overlay_arrow_bitmap
))
4578 from
->redraw_fringe_bitmaps_p
= 1;
4579 assign_row (to
, from
);
4580 to
->enabled_p
= 1, from
->enabled_p
= 0;
4581 to
->overlapped_p
= to_overlapped_p
;
4585 /* Clear the hash table, for the next time. */
4586 for (i
= 0; i
< row_entry_idx
; ++i
)
4587 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4589 /* Value is > 0 to indicate that we scrolled the display. */
4595 /************************************************************************
4597 ************************************************************************/
4599 /* Update the desired frame matrix of frame F.
4601 FORCE_P non-zero means that the update should not be stopped by
4602 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4603 should not be tried.
4605 Value is non-zero if update was stopped due to pending input. */
4608 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4610 /* Frame matrices to work on. */
4611 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4612 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4615 int preempt_count
= baud_rate
/ 2400 + 1;
4617 xassert (current_matrix
&& desired_matrix
);
4619 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4620 calculate_costs (f
);
4622 if (preempt_count
<= 0)
4625 #if !PERIODIC_PREEMPTION_CHECKING
4626 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4633 /* If we cannot insert/delete lines, it's no use trying it. */
4634 if (!FRAME_LINE_INS_DEL_OK (f
))
4637 /* See if any of the desired lines are enabled; don't compute for
4638 i/d line if just want cursor motion. */
4639 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4640 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4643 /* Try doing i/d line, if not yet inhibited. */
4644 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4645 force_p
|= scrolling (f
);
4647 /* Update the individual lines as needed. Do bottom line first. */
4648 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4649 update_frame_line (f
, desired_matrix
->nrows
- 1);
4651 /* Now update the rest of the lines. */
4652 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4654 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4656 if (FRAME_TERMCAP_P (f
))
4658 /* Flush out every so many lines.
4659 Also flush out if likely to have more than 1k buffered
4660 otherwise. I'm told that some telnet connections get
4661 really screwed by more than 1k output at once. */
4662 FILE *display_output
= FRAME_TTY (f
)->output
;
4665 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4667 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4669 fflush (display_output
);
4670 if (preempt_count
== 1)
4672 #ifdef EMACS_OUTQSIZE
4673 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4674 /* Probably not a tty. Ignore the error and reset
4676 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4679 if (baud_rate
<= outq
&& baud_rate
> 0)
4680 sleep (outq
/ baud_rate
);
4686 #if PERIODIC_PREEMPTION_CHECKING
4690 EMACS_GET_TIME (tm
);
4691 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4692 if (EMACS_TIME_NEG_P (dif
))
4694 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4695 if (detect_input_pending_ignore_squeezables ())
4700 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4701 detect_input_pending_ignore_squeezables ();
4704 update_frame_line (f
, i
);
4708 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4710 /* Now just clean up termcap drivers and set cursor, etc. */
4713 if ((cursor_in_echo_area
4714 /* If we are showing a message instead of the mini-buffer,
4715 show the cursor for the message instead of for the
4716 (now hidden) mini-buffer contents. */
4717 || (EQ (minibuf_window
, selected_window
)
4718 && EQ (minibuf_window
, echo_area_window
)
4719 && !NILP (echo_area_buffer
[0])))
4720 /* These cases apply only to the frame that contains
4721 the active mini-buffer window. */
4722 && FRAME_HAS_MINIBUF_P (f
)
4723 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4725 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4728 if (cursor_in_echo_area
< 0)
4730 /* Negative value of cursor_in_echo_area means put
4731 cursor at beginning of line. */
4737 /* Positive value of cursor_in_echo_area means put
4738 cursor at the end of the prompt. If the mini-buffer
4739 is several lines high, find the last line that has
4741 row
= FRAME_LINES (f
);
4747 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4749 /* Frame rows are filled up with spaces that
4750 must be ignored here. */
4751 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4753 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4754 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4757 && (last
- 1)->charpos
< 0)
4763 while (row
> top
&& col
== 0);
4765 /* Make sure COL is not out of range. */
4766 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4768 /* If we have another row, advance cursor into it. */
4769 if (row
< FRAME_LINES (f
) - 1)
4771 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4774 /* Otherwise move it back in range. */
4776 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4780 cursor_to (f
, row
, col
);
4784 /* We have only one cursor on terminal frames. Use it to
4785 display the cursor of the selected window. */
4786 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4787 if (w
->cursor
.vpos
>= 0
4788 /* The cursor vpos may be temporarily out of bounds
4789 in the following situation: There is one window,
4790 with the cursor in the lower half of it. The window
4791 is split, and a message causes a redisplay before
4792 a new cursor position has been computed. */
4793 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4795 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4796 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4798 if (INTEGERP (w
->left_margin_cols
))
4799 x
+= XFASTINT (w
->left_margin_cols
);
4801 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4802 cursor_to (f
, y
, x
);
4807 #if !PERIODIC_PREEMPTION_CHECKING
4811 clear_desired_matrices (f
);
4816 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4819 scrolling (struct frame
*frame
)
4821 int unchanged_at_top
, unchanged_at_bottom
;
4824 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4825 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4826 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4827 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4829 int free_at_end_vpos
= FRAME_LINES (frame
);
4830 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4831 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4833 if (!current_matrix
)
4836 /* Compute hash codes of all the lines. Also calculate number of
4837 changed lines, number of unchanged lines at the beginning, and
4838 number of unchanged lines at the end. */
4840 unchanged_at_top
= 0;
4841 unchanged_at_bottom
= FRAME_LINES (frame
);
4842 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4844 /* Give up on this scrolling if some old lines are not enabled. */
4845 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4847 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4848 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4850 /* This line cannot be redrawn, so don't let scrolling mess it. */
4851 new_hash
[i
] = old_hash
[i
];
4852 #define INFINITY 1000000 /* Taken from scroll.c */
4853 draw_cost
[i
] = INFINITY
;
4857 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4858 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4861 if (old_hash
[i
] != new_hash
[i
])
4864 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4866 else if (i
== unchanged_at_top
)
4868 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4871 /* If changed lines are few, don't allow preemption, don't scroll. */
4872 if ((!FRAME_SCROLL_REGION_OK (frame
)
4873 && changed_lines
< baud_rate
/ 2400)
4874 || unchanged_at_bottom
== FRAME_LINES (frame
))
4877 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4878 - unchanged_at_bottom
);
4880 if (FRAME_SCROLL_REGION_OK (frame
))
4881 free_at_end_vpos
-= unchanged_at_bottom
;
4882 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4883 free_at_end_vpos
= -1;
4885 /* If large window, fast terminal and few lines in common between
4886 current frame and desired frame, don't bother with i/d calc. */
4887 if (!FRAME_SCROLL_REGION_OK (frame
)
4888 && window_size
>= 18 && baud_rate
> 2400
4890 10 * scrolling_max_lines_saved (unchanged_at_top
,
4891 FRAME_LINES (frame
) - unchanged_at_bottom
,
4892 old_hash
, new_hash
, draw_cost
)))
4895 if (window_size
< 2)
4898 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4899 draw_cost
+ unchanged_at_top
- 1,
4900 old_draw_cost
+ unchanged_at_top
- 1,
4901 old_hash
+ unchanged_at_top
- 1,
4902 new_hash
+ unchanged_at_top
- 1,
4903 free_at_end_vpos
- unchanged_at_top
);
4909 /* Count the number of blanks at the start of the vector of glyphs R
4910 which is LEN glyphs long. */
4913 count_blanks (struct glyph
*r
, int len
)
4917 for (i
= 0; i
< len
; ++i
)
4918 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4925 /* Count the number of glyphs in common at the start of the glyph
4926 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4927 of STR2. Value is the number of equal glyphs equal at the start. */
4930 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4932 struct glyph
*p1
= str1
;
4933 struct glyph
*p2
= str2
;
4937 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4944 /* Char insertion/deletion cost vector, from term.c */
4946 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
4949 /* Perform a frame-based update on line VPOS in frame FRAME. */
4952 update_frame_line (struct frame
*f
, int vpos
)
4954 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4956 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4957 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4958 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4959 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4960 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4961 int must_write_whole_line_p
;
4962 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4963 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4964 != FACE_TTY_DEFAULT_BG_COLOR
);
4966 if (colored_spaces_p
)
4969 /* Current row not enabled means it has unknown contents. We must
4970 write the whole desired line in that case. */
4971 must_write_whole_line_p
= !current_row
->enabled_p
;
4972 if (must_write_whole_line_p
)
4979 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4980 olen
= current_row
->used
[TEXT_AREA
];
4982 /* Ignore trailing spaces, if we can. */
4983 if (!write_spaces_p
)
4984 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4988 current_row
->enabled_p
= 1;
4989 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4991 /* If desired line is empty, just clear the line. */
4992 if (!desired_row
->enabled_p
)
4998 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4999 nlen
= desired_row
->used
[TEXT_AREA
];
5000 nend
= nbody
+ nlen
;
5002 /* If display line has unknown contents, write the whole line. */
5003 if (must_write_whole_line_p
)
5005 /* Ignore spaces at the end, if we can. */
5006 if (!write_spaces_p
)
5007 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5010 /* Write the contents of the desired line. */
5013 cursor_to (f
, vpos
, 0);
5014 write_glyphs (f
, nbody
, nlen
);
5017 /* Don't call clear_end_of_line if we already wrote the whole
5018 line. The cursor will not be at the right margin in that
5019 case but in the line below. */
5020 if (nlen
< FRAME_TOTAL_COLS (f
))
5022 cursor_to (f
, vpos
, nlen
);
5023 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5026 /* Make sure we are in the right row, otherwise cursor movement
5027 with cmgoto might use `ch' in the wrong row. */
5028 cursor_to (f
, vpos
, 0);
5030 make_current (desired_matrix
, current_matrix
, vpos
);
5034 /* Pretend trailing spaces are not there at all,
5035 unless for one reason or another we must write all spaces. */
5036 if (!write_spaces_p
)
5037 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5040 /* If there's no i/d char, quickly do the best we can without it. */
5041 if (!FRAME_CHAR_INS_DEL_OK (f
))
5045 /* Find the first glyph in desired row that doesn't agree with
5046 a glyph in the current row, and write the rest from there on. */
5047 for (i
= 0; i
< nlen
; i
++)
5049 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5051 /* Find the end of the run of different glyphs. */
5055 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5056 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5059 /* Output this run of non-matching chars. */
5060 cursor_to (f
, vpos
, i
);
5061 write_glyphs (f
, nbody
+ i
, j
- i
);
5064 /* Now find the next non-match. */
5068 /* Clear the rest of the line, or the non-clear part of it. */
5071 cursor_to (f
, vpos
, nlen
);
5072 clear_end_of_line (f
, olen
);
5075 /* Make current row = desired row. */
5076 make_current (desired_matrix
, current_matrix
, vpos
);
5080 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5081 characters in a row. */
5085 /* If current line is blank, skip over initial spaces, if
5086 possible, and write the rest. */
5090 nsp
= count_blanks (nbody
, nlen
);
5094 cursor_to (f
, vpos
, nsp
);
5095 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5098 /* Exchange contents between current_frame and new_frame. */
5099 make_current (desired_matrix
, current_matrix
, vpos
);
5103 /* Compute number of leading blanks in old and new contents. */
5104 osp
= count_blanks (obody
, olen
);
5105 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5107 /* Compute number of matching chars starting with first non-blank. */
5108 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5109 nbody
+ nsp
, nbody
+ nlen
);
5111 /* Spaces in new match implicit space past the end of old. */
5112 /* A bug causing this to be a no-op was fixed in 18.29. */
5113 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5116 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5120 /* Avoid doing insert/delete char
5121 just cause number of leading spaces differs
5122 when the following text does not match. */
5123 if (begmatch
== 0 && osp
!= nsp
)
5124 osp
= nsp
= min (osp
, nsp
);
5126 /* Find matching characters at end of line */
5129 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5131 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5136 endmatch
= obody
+ olen
- op1
;
5138 /* tem gets the distance to insert or delete.
5139 endmatch is how many characters we save by doing so.
5142 tem
= (nlen
- nsp
) - (olen
- osp
);
5144 && (!FRAME_CHAR_INS_DEL_OK (f
)
5145 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5148 /* nsp - osp is the distance to insert or delete.
5149 If that is nonzero, begmatch is known to be nonzero also.
5150 begmatch + endmatch is how much we save by doing the ins/del.
5154 && (!FRAME_CHAR_INS_DEL_OK (f
)
5155 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5159 osp
= nsp
= min (osp
, nsp
);
5162 /* Now go through the line, inserting, writing and
5163 deleting as appropriate. */
5167 cursor_to (f
, vpos
, nsp
);
5168 delete_glyphs (f
, osp
- nsp
);
5172 /* If going to delete chars later in line
5173 and insert earlier in the line,
5174 must delete first to avoid losing data in the insert */
5175 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5177 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5178 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5179 olen
= nlen
- (nsp
- osp
);
5181 cursor_to (f
, vpos
, osp
);
5182 insert_glyphs (f
, 0, nsp
- osp
);
5186 tem
= nsp
+ begmatch
+ endmatch
;
5187 if (nlen
!= tem
|| olen
!= tem
)
5189 if (!endmatch
|| nlen
== olen
)
5191 /* If new text being written reaches right margin, there is
5192 no need to do clear-to-eol at the end of this function
5193 (and it would not be safe, since cursor is not going to
5194 be "at the margin" after the text is done). */
5195 if (nlen
== FRAME_TOTAL_COLS (f
))
5198 /* Function write_glyphs is prepared to do nothing
5199 if passed a length <= 0. Check it here to avoid
5200 unnecessary cursor movement. */
5203 cursor_to (f
, vpos
, nsp
+ begmatch
);
5204 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5207 else if (nlen
> olen
)
5209 /* Here, we used to have the following simple code:
5210 ----------------------------------------
5211 write_glyphs (nbody + nsp + begmatch, olen - tem);
5212 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5213 ----------------------------------------
5214 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5215 is a padding glyph. */
5216 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5219 cursor_to (f
, vpos
, nsp
+ begmatch
);
5221 /* Calculate columns we can actually overwrite. */
5222 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5224 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5226 /* If we left columns to be overwritten, we must delete them. */
5227 del
= olen
- tem
- out
;
5229 delete_glyphs (f
, del
);
5231 /* At last, we insert columns not yet written out. */
5232 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5235 else if (olen
> nlen
)
5237 cursor_to (f
, vpos
, nsp
+ begmatch
);
5238 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5239 delete_glyphs (f
, olen
- nlen
);
5245 /* If any unerased characters remain after the new line, erase them. */
5248 cursor_to (f
, vpos
, nlen
);
5249 clear_end_of_line (f
, olen
);
5252 /* Exchange contents between current_frame and new_frame. */
5253 make_current (desired_matrix
, current_matrix
, vpos
);
5258 /***********************************************************************
5259 X/Y Position -> Buffer Position
5260 ***********************************************************************/
5262 /* Determine what's under window-relative pixel position (*X, *Y).
5263 Return the OBJECT (string or buffer) that's there.
5264 Return in *POS the position in that object.
5265 Adjust *X and *Y to character positions.
5266 Return in *DX and *DY the pixel coordinates of the click,
5267 relative to the top left corner of OBJECT, or relative to
5268 the top left corner of the character glyph at (*X, *Y)
5270 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5271 if the coordinates point to an empty area of the display. */
5274 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
)
5277 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5278 struct text_pos startp
;
5280 struct glyph_row
*row
;
5281 #ifdef HAVE_WINDOW_SYSTEM
5282 struct image
*img
= 0;
5286 /* We used to set current_buffer directly here, but that does the
5287 wrong thing with `face-remapping-alist' (bug#2044). */
5288 Fset_buffer (w
->buffer
);
5289 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5290 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5291 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5292 start_display (&it
, w
, startp
);
5296 /* First, move to the beginning of the row corresponding to *Y. We
5297 need to be in that row to get the correct value of base paragraph
5298 direction for the text at (*X, *Y). */
5299 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5301 /* TO_X is the pixel position that the iterator will compute for the
5302 glyph at *X. We add it.first_visible_x because iterator
5303 positions include the hscroll. */
5304 to_x
= x0
+ it
.first_visible_x
;
5305 if (it
.bidi_it
.paragraph_dir
== R2L
)
5306 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5307 text area. This is because the iterator, even in R2L
5308 paragraphs, delivers glyphs as if they started at the left
5309 margin of the window. (When we actually produce glyphs for
5310 display, we reverse their order in PRODUCE_GLYPHS, but the
5311 iterator doesn't know about that.) The following line adjusts
5312 the pixel position to the iterator geometry, which is what
5313 move_it_* routines use. (The -1 is because in a window whose
5314 text-area width is W, the rightmost pixel position is W-1, and
5315 it should be mirrored into zero pixel position.) */
5316 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5318 /* Now move horizontally in the row to the glyph under *X. Second
5319 argument is ZV to prevent move_it_in_display_line from matching
5320 based on buffer positions. */
5321 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5323 Fset_buffer (old_current_buffer
);
5325 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5326 *dy
= *y
- it
.current_y
;
5329 if (STRINGP (it
.string
))
5332 if (it
.what
== IT_COMPOSITION
5333 && it
.cmp_it
.nchars
> 1
5334 && it
.cmp_it
.reversed_p
)
5336 /* The current display element is a grapheme cluster in a
5337 composition. In that case, we need the position of the first
5338 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5339 it.current points to the last character of the cluster, thus
5340 we must move back to the first character of the same
5342 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5343 if (STRINGP (it
.string
))
5344 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5346 BYTEPOS (pos
->pos
) = CHAR_TO_BYTE (CHARPOS (pos
->pos
));
5349 #ifdef HAVE_WINDOW_SYSTEM
5350 if (it
.what
== IT_IMAGE
)
5352 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5353 && !NILP (img
->spec
))
5354 *object
= img
->spec
;
5358 if (it
.vpos
< w
->current_matrix
->nrows
5359 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5362 if (it
.hpos
< row
->used
[TEXT_AREA
])
5364 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5365 #ifdef HAVE_WINDOW_SYSTEM
5368 *dy
-= row
->ascent
- glyph
->ascent
;
5369 *dx
+= glyph
->slice
.img
.x
;
5370 *dy
+= glyph
->slice
.img
.y
;
5371 /* Image slices positions are still relative to the entire image */
5372 *width
= img
->width
;
5373 *height
= img
->height
;
5378 *width
= glyph
->pixel_width
;
5379 *height
= glyph
->ascent
+ glyph
->descent
;
5385 *height
= row
->height
;
5390 *width
= *height
= 0;
5393 /* Add extra (default width) columns if clicked after EOL. */
5394 x1
= max(0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5396 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5405 /* Value is the string under window-relative coordinates X/Y in the
5406 mode line or header line (PART says which) of window W, or nil if none.
5407 *CHARPOS is set to the position in the string returned. */
5410 mode_line_string (struct window
*w
, enum window_part part
,
5411 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5412 int *dx
, int *dy
, int *width
, int *height
)
5414 struct glyph_row
*row
;
5415 struct glyph
*glyph
, *end
;
5417 Lisp_Object string
= Qnil
;
5419 if (part
== ON_MODE_LINE
)
5420 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5422 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5424 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5426 if (row
->mode_line_p
&& row
->enabled_p
)
5428 /* Find the glyph under X. If we find one with a string object,
5429 it's the one we were looking for. */
5430 glyph
= row
->glyphs
[TEXT_AREA
];
5431 end
= glyph
+ row
->used
[TEXT_AREA
];
5432 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5433 x0
-= glyph
->pixel_width
;
5434 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5437 string
= glyph
->object
;
5438 *charpos
= glyph
->charpos
;
5439 *width
= glyph
->pixel_width
;
5440 *height
= glyph
->ascent
+ glyph
->descent
;
5441 #ifdef HAVE_WINDOW_SYSTEM
5442 if (glyph
->type
== IMAGE_GLYPH
)
5445 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5447 *object
= img
->spec
;
5448 y0
-= row
->ascent
- glyph
->ascent
;
5454 /* Add extra (default width) columns if clicked after EOL. */
5455 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5457 *height
= row
->height
;
5464 *width
= *height
= 0;
5474 /* Value is the string under window-relative coordinates X/Y in either
5475 marginal area, or nil if none. *CHARPOS is set to the position in
5476 the string returned. */
5479 marginal_area_string (struct window
*w
, enum window_part part
,
5480 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5481 int *dx
, int *dy
, int *width
, int *height
)
5483 struct glyph_row
*row
= w
->current_matrix
->rows
;
5484 struct glyph
*glyph
, *end
;
5485 int x0
, y0
, i
, wy
= *y
;
5487 Lisp_Object string
= Qnil
;
5489 if (part
== ON_LEFT_MARGIN
)
5490 area
= LEFT_MARGIN_AREA
;
5491 else if (part
== ON_RIGHT_MARGIN
)
5492 area
= RIGHT_MARGIN_AREA
;
5496 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5497 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5500 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5504 /* Find the glyph under X. If we find one with a string object,
5505 it's the one we were looking for. */
5506 if (area
== RIGHT_MARGIN_AREA
)
5507 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5508 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5509 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5510 + window_box_width (w
, LEFT_MARGIN_AREA
)
5511 + window_box_width (w
, TEXT_AREA
));
5513 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5514 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5517 glyph
= row
->glyphs
[area
];
5518 end
= glyph
+ row
->used
[area
];
5519 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5520 x0
-= glyph
->pixel_width
;
5521 *x
= glyph
- row
->glyphs
[area
];
5524 string
= glyph
->object
;
5525 *charpos
= glyph
->charpos
;
5526 *width
= glyph
->pixel_width
;
5527 *height
= glyph
->ascent
+ glyph
->descent
;
5528 #ifdef HAVE_WINDOW_SYSTEM
5529 if (glyph
->type
== IMAGE_GLYPH
)
5532 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5534 *object
= img
->spec
;
5535 y0
-= row
->ascent
- glyph
->ascent
;
5536 x0
+= glyph
->slice
.img
.x
;
5537 y0
+= glyph
->slice
.img
.y
;
5543 /* Add extra (default width) columns if clicked after EOL. */
5544 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5546 *height
= row
->height
;
5553 *width
= *height
= 0;
5563 /***********************************************************************
5564 Changing Frame Sizes
5565 ***********************************************************************/
5570 window_change_signal (int signalnum
) /* If we don't have an argument, */
5571 /* some compilers complain in signal calls. */
5574 int old_errno
= errno
;
5576 struct tty_display_info
*tty
;
5578 signal (SIGWINCH
, window_change_signal
);
5579 SIGNAL_THREAD_CHECK (signalnum
);
5581 /* The frame size change obviously applies to a single
5582 termcap-controlled terminal, but we can't decide which.
5583 Therefore, we resize the frames corresponding to each tty.
5585 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5587 if (! tty
->term_initted
)
5590 /* Suspended tty frames have tty->input == NULL avoid trying to
5595 get_tty_size (fileno (tty
->input
), &width
, &height
);
5597 if (width
> 5 && height
> 2) {
5598 Lisp_Object tail
, frame
;
5600 FOR_EACH_FRAME (tail
, frame
)
5601 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5602 /* Record the new sizes, but don't reallocate the data
5603 structures now. Let that be done later outside of the
5605 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5611 #endif /* SIGWINCH */
5614 /* Do any change in frame size that was requested by a signal. SAFE
5615 non-zero means this function is called from a place where it is
5616 safe to change frame sizes while a redisplay is in progress. */
5619 do_pending_window_change (int safe
)
5621 /* If window_change_signal should have run before, run it now. */
5622 if (redisplaying_p
&& !safe
)
5625 while (delayed_size_change
)
5627 Lisp_Object tail
, frame
;
5629 delayed_size_change
= 0;
5631 FOR_EACH_FRAME (tail
, frame
)
5633 struct frame
*f
= XFRAME (frame
);
5635 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5636 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5643 /* Change the frame height and/or width. Values may be given as zero to
5644 indicate no change is to take place.
5646 If DELAY is non-zero, then assume we're being called from a signal
5647 handler, and queue the change for later - perhaps the next
5648 redisplay. Since this tries to resize windows, we can't call it
5649 from a signal handler.
5651 SAFE non-zero means this function is called from a place where it's
5652 safe to change frame sizes while a redisplay is in progress. */
5655 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5657 Lisp_Object tail
, frame
;
5659 if (FRAME_MSDOS_P (f
))
5661 /* On MS-DOS, all frames use the same screen, so a change in
5662 size affects all frames. Termcap now supports multiple
5664 FOR_EACH_FRAME (tail
, frame
)
5665 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5666 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5667 pretend
, delay
, safe
);
5670 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5674 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5676 int new_frame_total_cols
;
5677 int count
= SPECPDL_INDEX ();
5679 /* If we can't deal with the change now, queue it for later. */
5680 if (delay
|| (redisplaying_p
&& !safe
))
5682 f
->new_text_lines
= newheight
;
5683 f
->new_text_cols
= newwidth
;
5684 delayed_size_change
= 1;
5688 /* This size-change overrides any pending one for this frame. */
5689 f
->new_text_lines
= 0;
5690 f
->new_text_cols
= 0;
5692 /* If an argument is zero, set it to the current value. */
5694 newheight
= FRAME_LINES (f
);
5696 newwidth
= FRAME_COLS (f
);
5698 /* Compute width of windows in F.
5699 This is the width of the frame without vertical scroll bars. */
5700 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5702 /* Round up to the smallest acceptable size. */
5703 check_frame_size (f
, &newheight
, &newwidth
);
5705 /* If we're not changing the frame size, quit now. */
5706 /* Frame width may be unchanged but the text portion may change, for example,
5707 fullscreen and remove/add scroll bar. */
5708 if (newheight
== FRAME_LINES (f
)
5709 && newwidth
== FRAME_COLS (f
) // text portion unchanged
5710 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
)) // frame width unchanged
5716 /* We only can set screen dimensions to certain values supported
5717 by our video hardware. Try to find the smallest size greater
5718 or equal to the requested dimensions. */
5719 dos_set_window_size (&newheight
, &newwidth
);
5722 if (newheight
!= FRAME_LINES (f
))
5724 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
5726 /* Frame has both root and mini-buffer. */
5727 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f
))->top_line
,
5728 FRAME_TOP_MARGIN (f
));
5729 set_window_height (FRAME_ROOT_WINDOW (f
),
5732 - FRAME_TOP_MARGIN (f
)),
5734 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f
))->top_line
,
5736 set_window_height (FRAME_MINIBUF_WINDOW (f
), 1, 0);
5739 /* Frame has just one top-level window. */
5740 set_window_height (FRAME_ROOT_WINDOW (f
),
5741 newheight
- FRAME_TOP_MARGIN (f
), 2);
5743 /* MSDOS frames cannot PRETEND, as they change frame size by
5744 manipulating video hardware. */
5745 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5746 FrameRows (FRAME_TTY (f
)) = newheight
;
5749 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5751 set_window_width (FRAME_ROOT_WINDOW (f
), new_frame_total_cols
, 2);
5752 if (FRAME_HAS_MINIBUF_P (f
))
5753 set_window_width (FRAME_MINIBUF_WINDOW (f
), new_frame_total_cols
, 0);
5755 /* MSDOS frames cannot PRETEND, as they change frame size by
5756 manipulating video hardware. */
5757 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5758 FrameCols (FRAME_TTY (f
)) = newwidth
;
5760 if (WINDOWP (f
->tool_bar_window
))
5761 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5764 FRAME_LINES (f
) = newheight
;
5765 SET_FRAME_COLS (f
, newwidth
);
5768 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5769 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5771 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5773 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5774 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5775 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5776 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5780 calculate_costs (f
);
5781 SET_FRAME_GARBAGED (f
);
5786 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5788 run_window_configuration_change_hook (f
);
5790 unbind_to (count
, Qnil
);
5795 /***********************************************************************
5796 Terminal Related Lisp Functions
5797 ***********************************************************************/
5799 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5800 1, 1, "FOpen termscript file: ",
5801 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5802 FILE = nil means just close any termscript file currently open. */)
5805 struct tty_display_info
*tty
;
5807 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5808 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5809 error ("Current frame is not on a tty device");
5813 if (tty
->termscript
!= 0)
5816 fclose (tty
->termscript
);
5819 tty
->termscript
= 0;
5823 file
= Fexpand_file_name (file
, Qnil
);
5824 tty
->termscript
= fopen (SSDATA (file
), "w");
5825 if (tty
->termscript
== 0)
5826 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5832 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5833 Ssend_string_to_terminal
, 1, 2, 0,
5834 doc
: /* Send STRING to the terminal without alteration.
5835 Control characters in STRING will have terminal-dependent effects.
5837 Optional parameter TERMINAL specifies the tty terminal device to use.
5838 It may be a terminal object, a frame, or nil for the terminal used by
5839 the currently selected frame. In batch mode, STRING is sent to stdout
5840 when TERMINAL is nil. */)
5841 (Lisp_Object string
, Lisp_Object terminal
)
5843 struct terminal
*t
= get_terminal (terminal
, 1);
5846 /* ??? Perhaps we should do something special for multibyte strings here. */
5847 CHECK_STRING (string
);
5851 error ("Unknown terminal device");
5853 if (t
->type
== output_initial
)
5855 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5856 error ("Device %d is not a termcap terminal device", t
->id
);
5859 struct tty_display_info
*tty
= t
->display_info
.tty
;
5862 error ("Terminal is currently suspended");
5864 if (tty
->termscript
)
5866 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5867 fflush (tty
->termscript
);
5871 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5878 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5879 doc
: /* Beep, or flash the screen.
5880 Also, unless an argument is given,
5881 terminate any keyboard macro currently executing. */)
5889 ring_bell (XFRAME (selected_frame
));
5898 bitch_at_user (void)
5902 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5903 error ("Keyboard macro terminated by a command ringing the bell");
5905 ring_bell (XFRAME (selected_frame
));
5910 /***********************************************************************
5912 ***********************************************************************/
5914 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5915 doc
: /* Pause, without updating display, for SECONDS seconds.
5916 SECONDS may be a floating-point value, meaning that you can wait for a
5917 fraction of a second. Optional second arg MILLISECONDS specifies an
5918 additional wait period, in milliseconds; this may be useful if your
5919 Emacs was built without floating point support.
5920 \(Not all operating systems support waiting for a fraction of a second.) */)
5921 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5925 if (NILP (milliseconds
))
5926 XSETINT (milliseconds
, 0);
5928 CHECK_NUMBER (milliseconds
);
5929 usec
= XINT (milliseconds
) * 1000;
5932 double duration
= extract_float (seconds
);
5933 sec
= (int) duration
;
5934 usec
+= (duration
- sec
) * 1000000;
5937 #ifndef EMACS_HAS_USECS
5938 if (sec
== 0 && usec
!= 0)
5939 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
5942 /* Assure that 0 <= usec < 1000000. */
5945 /* We can't rely on the rounding being correct if usec is negative. */
5946 if (-1000000 < usec
)
5947 sec
--, usec
+= 1000000;
5949 sec
-= -usec
/ 1000000, usec
= 1000000 - (-usec
% 1000000);
5952 sec
+= usec
/ 1000000, usec
%= 1000000;
5954 if (sec
< 0 || (sec
== 0 && usec
== 0))
5957 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
5963 /* This is just like wait_reading_process_output, except that
5966 TIMEOUT is number of seconds to wait (float or integer),
5967 or t to wait forever.
5968 READING is 1 if reading input.
5969 If DO_DISPLAY is >0 display process output while waiting.
5970 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5974 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5978 swallow_events (do_display
);
5980 if ((detect_input_pending_run_timers (do_display
))
5981 || !NILP (Vexecuting_kbd_macro
))
5984 if (do_display
>= 2)
5985 redisplay_preserve_echo_area (2);
5987 if (INTEGERP (timeout
))
5989 sec
= XINT (timeout
);
5992 else if (FLOATP (timeout
))
5994 double seconds
= XFLOAT_DATA (timeout
);
5995 sec
= (int) seconds
;
5996 usec
= (int) ((seconds
- sec
) * 1000000);
5998 else if (EQ (timeout
, Qt
))
6004 wrong_type_argument (Qnumberp
, timeout
);
6006 if (sec
== 0 && usec
== 0 && !EQ (timeout
, Qt
))
6013 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
6016 return detect_input_pending () ? Qnil
: Qt
;
6020 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
6021 doc
: /* Perform redisplay if no input is available.
6022 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
6023 perform a full redisplay even if input is available.
6024 Return t if redisplay was performed, nil otherwise. */)
6030 if ((detect_input_pending_run_timers (1)
6031 && NILP (force
) && !redisplay_dont_pause
)
6032 || !NILP (Vexecuting_kbd_macro
))
6035 count
= SPECPDL_INDEX ();
6036 if (!NILP (force
) && !redisplay_dont_pause
)
6037 specbind (Qredisplay_dont_pause
, Qt
);
6038 redisplay_preserve_echo_area (2);
6039 unbind_to (count
, Qnil
);
6045 /***********************************************************************
6046 Other Lisp Functions
6047 ***********************************************************************/
6049 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6050 session's frames, frame names, buffers, buffer-read-only flags, and
6051 buffer-modified-flags. */
6053 static Lisp_Object frame_and_buffer_state
;
6056 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6057 Sframe_or_buffer_changed_p
, 0, 1, 0,
6058 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6059 VARIABLE is a variable name whose value is either nil or a state vector
6060 that will be updated to contain all frames and buffers,
6061 aside from buffers whose names start with space,
6062 along with the buffers' read-only and modified flags. This allows a fast
6063 check to see whether buffer menus might need to be recomputed.
6064 If this function returns non-nil, it updates the internal vector to reflect
6067 If VARIABLE is nil, an internal variable is used. Users should not
6068 pass nil for VARIABLE. */)
6069 (Lisp_Object variable
)
6071 Lisp_Object state
, tail
, frame
, buf
;
6072 Lisp_Object
*vecp
, *end
;
6075 if (! NILP (variable
))
6077 CHECK_SYMBOL (variable
);
6078 state
= Fsymbol_value (variable
);
6079 if (! VECTORP (state
))
6083 state
= frame_and_buffer_state
;
6085 vecp
= XVECTOR (state
)->contents
;
6086 end
= vecp
+ XVECTOR (state
)->size
;
6088 FOR_EACH_FRAME (tail
, frame
)
6092 if (!EQ (*vecp
++, frame
))
6096 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6099 /* Check that the buffer info matches. */
6100 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6102 buf
= XCDR (XCAR (tail
));
6103 /* Ignore buffers that aren't included in buffer lists. */
6104 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6108 if (!EQ (*vecp
++, buf
))
6112 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6116 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6121 /* Detect deletion of a buffer at the end of the list. */
6122 if (EQ (*vecp
, Qlambda
))
6125 /* Come here if we decide the data has changed. */
6127 /* Count the size we will need.
6128 Start with 1 so there is room for at least one lambda at the end. */
6130 FOR_EACH_FRAME (tail
, frame
)
6132 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6134 /* Reallocate the vector if data has grown to need it,
6135 or if it has shrunk a lot. */
6136 if (! VECTORP (state
)
6137 || n
> XVECTOR (state
)->size
6138 || n
+ 20 < XVECTOR (state
)->size
/ 2)
6139 /* Add 20 extra so we grow it less often. */
6141 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6142 if (! NILP (variable
))
6143 Fset (variable
, state
);
6145 frame_and_buffer_state
= state
;
6148 /* Record the new data in the (possibly reallocated) vector. */
6149 vecp
= XVECTOR (state
)->contents
;
6150 FOR_EACH_FRAME (tail
, frame
)
6153 *vecp
++ = XFRAME (frame
)->name
;
6155 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6157 buf
= XCDR (XCAR (tail
));
6158 /* Ignore buffers that aren't included in buffer lists. */
6159 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6162 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6163 *vecp
++ = Fbuffer_modified_p (buf
);
6165 /* Fill up the vector with lambdas (always at least one). */
6167 while (vecp
- XVECTOR (state
)->contents
6168 < XVECTOR (state
)->size
)
6170 /* Make sure we didn't overflow the vector. */
6171 if (vecp
- XVECTOR (state
)->contents
6172 > XVECTOR (state
)->size
)
6179 /***********************************************************************
6181 ***********************************************************************/
6183 /* Initialization done when Emacs fork is started, before doing stty.
6184 Determine terminal type and set terminal_driver. Then invoke its
6185 decoding routine to set up variables in the terminal package. */
6190 char *terminal_type
;
6192 /* Construct the space glyph. */
6193 space_glyph
.type
= CHAR_GLYPH
;
6194 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6195 space_glyph
.charpos
= -1;
6198 cursor_in_echo_area
= 0;
6199 terminal_type
= (char *) 0;
6201 /* Now is the time to initialize this; it's used by init_sys_modes
6203 Vinitial_window_system
= Qnil
;
6205 /* SIGWINCH needs to be handled no matter what display we start
6206 with. Otherwise newly opened tty frames will not resize
6211 #endif /* CANNOT_DUMP */
6212 signal (SIGWINCH
, window_change_signal
);
6213 #endif /* SIGWINCH */
6215 /* If running as a daemon, no need to initialize any frames/terminal. */
6219 /* If the user wants to use a window system, we shouldn't bother
6220 initializing the terminal. This is especially important when the
6221 terminal is so dumb that emacs gives up before and doesn't bother
6222 using the window system.
6224 If the DISPLAY environment variable is set and nonempty,
6225 try to use X, and die with an error message if that doesn't work. */
6227 #ifdef HAVE_X_WINDOWS
6228 if (! inhibit_window_system
&& ! display_arg
)
6231 display
= getenv ("DISPLAY");
6232 display_arg
= (display
!= 0 && *display
!= 0);
6234 if (display_arg
&& !x_display_ok (display
))
6236 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6238 inhibit_window_system
= 1;
6242 if (!inhibit_window_system
&& display_arg
6248 Vinitial_window_system
= Qx
;
6250 Vwindow_system_version
= make_number (11);
6252 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6253 /* In some versions of ncurses,
6254 tputs crashes if we have not called tgetent.
6256 { char b
[2044]; tgetent (b
, "xterm");}
6258 adjust_frame_glyphs_initially ();
6261 #endif /* HAVE_X_WINDOWS */
6264 if (!inhibit_window_system
)
6266 Vinitial_window_system
= Qw32
;
6267 Vwindow_system_version
= make_number (1);
6268 adjust_frame_glyphs_initially ();
6271 #endif /* HAVE_NTGUI */
6274 if (!inhibit_window_system
6280 Vinitial_window_system
= Qns
;
6281 Vwindow_system_version
= make_number(10);
6282 adjust_frame_glyphs_initially ();
6287 /* If no window system has been specified, try to use the terminal. */
6290 fatal ("standard input is not a tty");
6295 terminal_type
= "w32console";
6297 /* Look at the TERM variable. */
6298 terminal_type
= (char *) getenv ("TERM");
6302 #ifdef HAVE_WINDOW_SYSTEM
6303 if (! inhibit_window_system
)
6304 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6306 #endif /* HAVE_WINDOW_SYSTEM */
6307 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6313 struct frame
*f
= XFRAME (selected_frame
);
6315 /* Open a display on the controlling tty. */
6316 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6318 /* Convert the initial frame to use the new display. */
6319 if (f
->output_method
!= output_initial
)
6321 f
->output_method
= t
->type
;
6324 t
->reference_count
++;
6326 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6328 if (f
->output_method
== output_termcap
)
6329 create_tty_output (f
);
6331 t
->display_info
.tty
->top_frame
= selected_frame
;
6332 change_frame_size (XFRAME (selected_frame
),
6333 FrameRows (t
->display_info
.tty
),
6334 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6336 /* Delete the initial terminal. */
6337 if (--initial_terminal
->reference_count
== 0
6338 && initial_terminal
->delete_terminal_hook
)
6339 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6341 /* Update frame parameters to reflect the new type. */
6342 Fmodify_frame_parameters
6343 (selected_frame
, Fcons (Fcons (Qtty_type
,
6344 Ftty_type (selected_frame
)), Qnil
));
6345 if (t
->display_info
.tty
->name
)
6346 Fmodify_frame_parameters (selected_frame
,
6347 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6350 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6355 struct frame
*sf
= SELECTED_FRAME ();
6356 int width
= FRAME_TOTAL_COLS (sf
);
6357 int height
= FRAME_LINES (sf
);
6359 unsigned int total_glyphs
= height
* (width
+ 2) * sizeof (struct glyph
);
6361 /* If these sizes are so big they cause overflow, just ignore the
6362 change. It's not clear what better we could do. */
6363 if (total_glyphs
/ sizeof (struct glyph
) / height
!= width
+ 2)
6364 fatal ("screen size %dx%d too big", width
, height
);
6367 adjust_frame_glyphs_initially ();
6368 calculate_costs (XFRAME (selected_frame
));
6370 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6373 && NILP (Vinitial_window_system
))
6375 /* For the initial frame, we don't have any way of knowing what
6376 are the foreground and background colors of the terminal. */
6377 struct frame
*sf
= SELECTED_FRAME();
6379 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6380 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6381 call0 (intern ("tty-set-up-initial-frame-faces"));
6387 /***********************************************************************
6389 ***********************************************************************/
6391 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6392 Sinternal_show_cursor
, 2, 2, 0,
6393 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6394 WINDOW nil means use the selected window. SHOW non-nil means
6395 show a cursor in WINDOW in the next redisplay. SHOW nil means
6396 don't show a cursor. */)
6397 (Lisp_Object window
, Lisp_Object show
)
6399 /* Don't change cursor state while redisplaying. This could confuse
6401 if (!redisplaying_p
)
6404 window
= selected_window
;
6406 CHECK_WINDOW (window
);
6408 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6415 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6416 Sinternal_show_cursor_p
, 0, 1, 0,
6417 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6418 WINDOW nil or omitted means report on the selected window. */)
6419 (Lisp_Object window
)
6424 window
= selected_window
;
6426 CHECK_WINDOW (window
);
6428 w
= XWINDOW (window
);
6429 return w
->cursor_off_p
? Qnil
: Qt
;
6432 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6433 Slast_nonminibuf_frame
, 0, 0, 0,
6434 doc
: /* Value is last nonminibuffer frame. */)
6437 Lisp_Object frame
= Qnil
;
6439 if (last_nonminibuf_frame
)
6440 XSETFRAME (frame
, last_nonminibuf_frame
);
6445 /***********************************************************************
6447 ***********************************************************************/
6450 syms_of_display (void)
6452 defsubr (&Sredraw_frame
);
6453 defsubr (&Sredraw_display
);
6454 defsubr (&Sframe_or_buffer_changed_p
);
6455 defsubr (&Sopen_termscript
);
6457 defsubr (&Sredisplay
);
6458 defsubr (&Ssleep_for
);
6459 defsubr (&Ssend_string_to_terminal
);
6460 defsubr (&Sinternal_show_cursor
);
6461 defsubr (&Sinternal_show_cursor_p
);
6462 defsubr (&Slast_nonminibuf_frame
);
6465 defsubr (&Sdump_redisplay_history
);
6468 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6469 staticpro (&frame_and_buffer_state
);
6471 Qdisplay_table
= intern_c_string ("display-table");
6472 staticpro (&Qdisplay_table
);
6473 Qredisplay_dont_pause
= intern_c_string ("redisplay-dont-pause");
6474 staticpro (&Qredisplay_dont_pause
);
6476 DEFVAR_INT ("baud-rate", baud_rate
,
6477 doc
: /* *The output baud rate of the terminal.
6478 On most systems, changing this value will affect the amount of padding
6479 and the other strategic decisions made during redisplay. */);
6481 DEFVAR_BOOL ("inverse-video", inverse_video
,
6482 doc
: /* *Non-nil means invert the entire frame display.
6483 This means everything is in inverse video which otherwise would not be. */);
6485 DEFVAR_BOOL ("visible-bell", visible_bell
,
6486 doc
: /* *Non-nil means try to flash the frame to represent a bell.
6488 See also `ring-bell-function'. */);
6490 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6491 doc
: /* *Non-nil means no need to redraw entire frame after suspending.
6492 A non-nil value is useful if the terminal can automatically preserve
6493 Emacs's frame display when you reenter Emacs.
6494 It is up to you to set this variable if your terminal can do that. */);
6496 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6497 doc
: /* Name of the window system that Emacs uses for the first frame.
6498 The value is a symbol:
6499 nil for a termcap frame (a character-only terminal),
6500 'x' for an Emacs frame that is really an X window,
6501 'w32' for an Emacs frame that is a window on MS-Windows display,
6502 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6503 'pc' for a direct-write MS-DOS frame.
6505 Use of this variable as a boolean is deprecated. Instead,
6506 use `display-graphic-p' or any of the other `display-*-p'
6507 predicates which report frame's specific UI-related capabilities. */);
6509 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6510 doc
: /* Name of window system through which the selected frame is displayed.
6511 The value is a symbol:
6512 nil for a termcap frame (a character-only terminal),
6513 'x' for an Emacs frame that is really an X window,
6514 'w32' for an Emacs frame that is a window on MS-Windows display,
6515 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6516 'pc' for a direct-write MS-DOS frame.
6518 Use of this variable as a boolean is deprecated. Instead,
6519 use `display-graphic-p' or any of the other `display-*-p'
6520 predicates which report frame's specific UI-related capabilities. */);
6522 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6523 doc
: /* The version number of the window system in use.
6524 For X windows, this is 11. */);
6526 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6527 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6529 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6530 doc
: /* Table defining how to output a glyph code to the frame.
6531 If not nil, this is a vector indexed by glyph code to define the glyph.
6532 Each element can be:
6533 integer: a glyph code which this glyph is an alias for.
6534 string: output this glyph using that string (not impl. in X windows).
6535 nil: this glyph mod 524288 is the code of a character to output,
6536 and this glyph / 524288 is the face number (see `face-id') to use
6537 while outputting it. */);
6538 Vglyph_table
= Qnil
;
6540 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6541 doc
: /* Display table to use for buffers that specify none.
6542 See `buffer-display-table' for more information. */);
6543 Vstandard_display_table
= Qnil
;
6545 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6546 doc
: /* *Non-nil means update isn't paused when input is detected. */);
6547 redisplay_dont_pause
= 0;
6549 #if PERIODIC_PREEMPTION_CHECKING
6550 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6551 doc
: /* *The period in seconds between checking for input during redisplay.
6552 If input is detected, redisplay is pre-empted, and the input is processed.
6553 If nil, never pre-empt redisplay. */);
6554 Vredisplay_preemption_period
= make_float (0.10);
6561 Vinitial_window_system
= Qnil
;
6562 Vwindow_system_version
= Qnil
;