1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 /* cm.h must come after dispextern.h on Windows. */
31 #include "dispextern.h"
33 #include "character.h"
37 #include "termhooks.h"
42 #include "intervals.h"
43 #include "blockinput.h"
46 #include "syssignal.h"
50 #endif /* HAVE_X_WINDOWS */
54 #endif /* HAVE_NTGUI */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Get number of chars of output now in the buffer of a stdio stream.
66 This ought to be built in stdio, but it isn't. Some s- files
67 override this because their stdio internals differ. */
69 #ifdef __GNU_LIBRARY__
71 /* The s- file might have overridden the definition with one that
72 works for the system's C library. But we are using the GNU C
73 library, so this is the right definition for every system. */
75 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
76 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
78 #undef PENDING_OUTPUT_COUNT
79 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
81 #else /* not __GNU_LIBRARY__ */
82 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
83 #include <stdio_ext.h>
84 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
86 #ifndef PENDING_OUTPUT_COUNT
87 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
89 #endif /* not __GNU_LIBRARY__ */
91 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
92 #include <term.h> /* for tgetent */
95 /* Structure to pass dimensions around. Used for character bounding
96 boxes, glyph matrix dimensions and alike. */
105 /* Function prototypes. */
107 static void update_frame_line (struct frame
*, int);
108 static int required_matrix_height (struct window
*);
109 static int required_matrix_width (struct window
*);
110 static void adjust_frame_glyphs (struct frame
*);
111 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
112 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
113 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
114 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
116 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
118 static void adjust_frame_message_buffer (struct frame
*);
119 static void adjust_decode_mode_spec_buffer (struct frame
*);
120 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
121 static void clear_window_matrices (struct window
*, int);
122 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
123 static int scrolling_window (struct window
*, int);
124 static int update_window_line (struct window
*, int, int *);
125 static void mirror_make_current (struct window
*, int);
127 static void check_matrix_pointers (struct glyph_matrix
*,
128 struct glyph_matrix
*);
130 static void mirror_line_dance (struct window
*, int, int, int *, char *);
131 static int update_window_tree (struct window
*, int);
132 static int update_window (struct window
*, int);
133 static int update_frame_1 (struct frame
*, int, int);
134 static int scrolling (struct frame
*);
135 static void set_window_cursor_after_update (struct window
*);
136 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
137 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
140 /* Redisplay preemption timers. */
142 static EMACS_TIME preemption_period
;
143 static EMACS_TIME preemption_next_check
;
145 /* Nonzero upon entry to redisplay means do not assume anything about
146 current contents of actual terminal frame; clear and redraw it. */
150 /* Nonzero means last display completed. Zero means it was preempted. */
152 int display_completed
;
154 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
157 /* The currently selected frame. In a single-frame version, this
158 variable always equals the_only_frame. */
160 Lisp_Object selected_frame
;
162 /* A frame which is not just a mini-buffer, or 0 if there are no such
163 frames. This is usually the most recent such frame that was
164 selected. In a single-frame version, this variable always holds
165 the address of the_only_frame. */
167 struct frame
*last_nonminibuf_frame
;
169 /* 1 means SIGWINCH happened when not safe. */
171 static int delayed_size_change
;
173 /* 1 means glyph initialization has been completed at startup. */
175 static int glyphs_initialized_initially_p
;
177 /* Updated window if != 0. Set by update_window. */
179 struct window
*updated_window
;
181 /* Glyph row updated in update_window_line, and area that is updated. */
183 struct glyph_row
*updated_row
;
186 /* A glyph for a space. */
188 struct glyph space_glyph
;
190 /* Counts of allocated structures. These counts serve to diagnose
191 memory leaks and double frees. */
193 static int glyph_matrix_count
;
194 static int glyph_pool_count
;
196 /* If non-null, the frame whose frame matrices are manipulated. If
197 null, window matrices are worked on. */
199 static struct frame
*frame_matrix_frame
;
201 /* Non-zero means that fonts have been loaded since the last glyph
202 matrix adjustments. Redisplay must stop, and glyph matrices must
203 be adjusted when this flag becomes non-zero during display. The
204 reason fonts can be loaded so late is that fonts of fontsets are
205 loaded on demand. Another reason is that a line contains many
206 characters displayed by zero width or very narrow glyphs of
207 variable-width fonts. */
211 /* Convert vpos and hpos from frame to window and vice versa.
212 This may only be used for terminal frames. */
216 static int window_to_frame_vpos (struct window
*, int);
217 static int window_to_frame_hpos (struct window
*, int);
218 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
219 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
221 /* One element of the ring buffer containing redisplay history
224 struct redisplay_history
226 char trace
[512 + 100];
229 /* The size of the history buffer. */
231 #define REDISPLAY_HISTORY_SIZE 30
233 /* The redisplay history buffer. */
235 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
237 /* Next free entry in redisplay_history. */
239 static int history_idx
;
241 /* A tick that's incremented each time something is added to the
244 static uprintmax_t history_tick
;
246 static void add_frame_display_history (struct frame
*, int);
248 /* Add to the redisplay history how window W has been displayed.
249 MSG is a trace containing the information how W's glyph matrix
250 has been constructed. PAUSED_P non-zero means that the update
251 has been interrupted for pending input. */
254 add_window_display_history (struct window
*w
, const char *msg
, int paused_p
)
258 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
260 buf
= redisplay_history
[history_idx
].trace
;
263 snprintf (buf
, sizeof redisplay_history
[0].trace
,
264 "%"pMu
": window %p (`%s')%s\n%s",
267 ((BUFFERP (w
->buffer
)
268 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
269 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
271 paused_p
? " ***paused***" : "",
276 /* Add to the redisplay history that frame F has been displayed.
277 PAUSED_P non-zero means that the update has been interrupted for
281 add_frame_display_history (struct frame
*f
, int paused_p
)
285 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
287 buf
= redisplay_history
[history_idx
].trace
;
290 sprintf (buf
, "%"pMu
": update frame %p%s",
292 f
, paused_p
? " ***paused***" : "");
296 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
297 Sdump_redisplay_history
, 0, 0, "",
298 doc
: /* Dump redisplay history to stderr. */)
303 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
306 i
= REDISPLAY_HISTORY_SIZE
- 1;
307 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
314 #else /* not GLYPH_DEBUG */
316 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
317 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
319 #endif /* GLYPH_DEBUG */
322 #if (defined PROFILING \
323 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
324 && !HAVE___EXECUTABLE_START)
325 /* This function comes first in the Emacs executable and is used only
326 to estimate the text start for profiling. */
328 __executable_start (void)
334 /***********************************************************************
336 ***********************************************************************/
338 /* Allocate and return a glyph_matrix structure. POOL is the glyph
339 pool from which memory for the matrix should be allocated, or null
340 for window-based redisplay where no glyph pools are used. The
341 member `pool' of the glyph matrix structure returned is set to
342 POOL, the structure is otherwise zeroed. */
344 static struct glyph_matrix
*
345 new_glyph_matrix (struct glyph_pool
*pool
)
347 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
349 /* Increment number of allocated matrices. This count is used
350 to detect memory leaks. */
351 ++glyph_matrix_count
;
353 /* Set pool and return. */
359 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
361 The global counter glyph_matrix_count is decremented when a matrix
362 is freed. If the count gets negative, more structures were freed
363 than allocated, i.e. one matrix was freed more than once or a bogus
364 pointer was passed to this function.
366 If MATRIX->pool is null, this means that the matrix manages its own
367 glyph memory---this is done for matrices on X frames. Freeing the
368 matrix also frees the glyph memory in this case. */
371 free_glyph_matrix (struct glyph_matrix
*matrix
)
377 /* Detect the case that more matrices are freed than were
379 if (--glyph_matrix_count
< 0)
382 /* Free glyph memory if MATRIX owns it. */
383 if (matrix
->pool
== NULL
)
384 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
385 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
387 /* Free row structures and the matrix itself. */
388 xfree (matrix
->rows
);
394 /* Return the number of glyphs to reserve for a marginal area of
395 window W. TOTAL_GLYPHS is the number of glyphs in a complete
396 display line of window W. MARGIN gives the width of the marginal
397 area in canonical character units. MARGIN should be an integer
401 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
405 if (NUMBERP (margin
))
407 int width
= XFASTINT (w
->total_cols
);
408 double d
= max (0, XFLOATINT (margin
));
409 d
= min (width
/ 2 - 1, d
);
410 n
= (int) ((double) total_glyphs
/ width
* d
);
418 /* Return non-zero if ROW's hash value is correct, zero if not.
419 Optimized away if ENABLE_CHECKING is not defined. */
422 verify_row_hash (struct glyph_row
*row
)
424 return row
->hash
== row_hash (row
);
427 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
430 W is null if the function is called for a frame glyph matrix.
431 Otherwise it is the window MATRIX is a member of. X and Y are the
432 indices of the first column and row of MATRIX within the frame
433 matrix, if such a matrix exists. They are zero for purely
434 window-based redisplay. DIM is the needed size of the matrix.
436 In window-based redisplay, where no frame matrices exist, glyph
437 matrices manage their own glyph storage. Otherwise, they allocate
438 storage from a common frame glyph pool which can be found in
441 The reason for this memory management strategy is to avoid complete
442 frame redraws if possible. When we allocate from a common pool, a
443 change of the location or size of a sub-matrix within the pool
444 requires a complete redisplay of the frame because we cannot easily
445 make sure that the current matrices of all windows still agree with
446 what is displayed on the screen. While this is usually fast, it
447 leads to screen flickering. */
450 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
454 int marginal_areas_changed_p
= 0;
455 int header_line_changed_p
= 0;
456 int header_line_p
= 0;
457 int left
= -1, right
= -1;
458 int window_width
= -1, window_height
= -1;
460 /* See if W had a header line that has disappeared now, or vice versa.
464 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
466 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
467 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
469 matrix
->header_line_p
= header_line_p
;
471 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
472 Do nothing if MATRIX' size, position, vscroll, and marginal areas
473 haven't changed. This optimization is important because preserving
474 the matrix means preventing redisplay. */
475 if (matrix
->pool
== NULL
)
477 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
478 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
479 eassert (left
>= 0 && right
>= 0);
480 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
481 || right
!= matrix
->right_margin_glyphs
);
483 if (!marginal_areas_changed_p
485 && !header_line_changed_p
486 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
487 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
488 && matrix
->window_height
== window_height
489 && matrix
->window_vscroll
== w
->vscroll
490 && matrix
->window_width
== window_width
)
494 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
495 if (matrix
->rows_allocated
< dim
.height
)
497 int old_alloc
= matrix
->rows_allocated
;
498 new_rows
= dim
.height
- matrix
->rows_allocated
;
499 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
500 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
501 memset (matrix
->rows
+ old_alloc
, 0,
502 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
507 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
508 on a frame not using window-based redisplay. Set up pointers for
509 each row into the glyph pool. */
512 eassert (matrix
->pool
->glyphs
);
516 left
= margin_glyphs_to_reserve (w
, dim
.width
,
517 w
->left_margin_cols
);
518 right
= margin_glyphs_to_reserve (w
, dim
.width
,
519 w
->right_margin_cols
);
524 for (i
= 0; i
< dim
.height
; ++i
)
526 struct glyph_row
*row
= &matrix
->rows
[i
];
528 row
->glyphs
[LEFT_MARGIN_AREA
]
529 = (matrix
->pool
->glyphs
530 + (y
+ i
) * matrix
->pool
->ncolumns
534 || row
== matrix
->rows
+ dim
.height
- 1
535 || (row
== matrix
->rows
&& matrix
->header_line_p
))
537 row
->glyphs
[TEXT_AREA
]
538 = row
->glyphs
[LEFT_MARGIN_AREA
];
539 row
->glyphs
[RIGHT_MARGIN_AREA
]
540 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
541 row
->glyphs
[LAST_AREA
]
542 = row
->glyphs
[RIGHT_MARGIN_AREA
];
546 row
->glyphs
[TEXT_AREA
]
547 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
548 row
->glyphs
[RIGHT_MARGIN_AREA
]
549 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
550 row
->glyphs
[LAST_AREA
]
551 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
555 matrix
->left_margin_glyphs
= left
;
556 matrix
->right_margin_glyphs
= right
;
560 /* If MATRIX->pool is null, MATRIX is responsible for managing
561 its own memory. It is a window matrix for window-based redisplay.
562 Allocate glyph memory from the heap. */
563 if (dim
.width
> matrix
->matrix_w
565 || header_line_changed_p
566 || marginal_areas_changed_p
)
568 struct glyph_row
*row
= matrix
->rows
;
569 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
573 row
->glyphs
[LEFT_MARGIN_AREA
]
574 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
575 dim
.width
, sizeof (struct glyph
));
577 /* The mode line never has marginal areas. */
578 if (row
== matrix
->rows
+ dim
.height
- 1
579 || (row
== matrix
->rows
&& matrix
->header_line_p
))
581 row
->glyphs
[TEXT_AREA
]
582 = row
->glyphs
[LEFT_MARGIN_AREA
];
583 row
->glyphs
[RIGHT_MARGIN_AREA
]
584 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
585 row
->glyphs
[LAST_AREA
]
586 = row
->glyphs
[RIGHT_MARGIN_AREA
];
590 row
->glyphs
[TEXT_AREA
]
591 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
592 row
->glyphs
[RIGHT_MARGIN_AREA
]
593 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
594 row
->glyphs
[LAST_AREA
]
595 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
601 eassert (left
>= 0 && right
>= 0);
602 matrix
->left_margin_glyphs
= left
;
603 matrix
->right_margin_glyphs
= right
;
606 /* Number of rows to be used by MATRIX. */
607 matrix
->nrows
= dim
.height
;
608 eassert (matrix
->nrows
>= 0);
612 if (matrix
== w
->current_matrix
)
614 /* Mark rows in a current matrix of a window as not having
615 valid contents. It's important to not do this for
616 desired matrices. When Emacs starts, it may already be
617 building desired matrices when this function runs. */
618 if (window_width
< 0)
619 window_width
= window_box_width (w
, -1);
621 /* Optimize the case that only the height has changed (C-x 2,
622 upper window). Invalidate all rows that are no longer part
624 if (!marginal_areas_changed_p
625 && !header_line_changed_p
627 && dim
.width
== matrix
->matrix_w
628 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
629 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
630 && matrix
->window_width
== window_width
)
632 /* Find the last row in the window. */
633 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
634 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
640 /* Window end is invalid, if inside of the rows that
641 are invalidated below. */
642 if (INTEGERP (w
->window_end_vpos
)
643 && XFASTINT (w
->window_end_vpos
) >= i
)
644 w
->window_end_valid
= Qnil
;
646 while (i
< matrix
->nrows
)
647 matrix
->rows
[i
++].enabled_p
= 0;
651 for (i
= 0; i
< matrix
->nrows
; ++i
)
652 matrix
->rows
[i
].enabled_p
= 0;
655 else if (matrix
== w
->desired_matrix
)
657 /* Rows in desired matrices always have to be cleared;
658 redisplay expects this is the case when it runs, so it
659 had better be the case when we adjust matrices between
661 for (i
= 0; i
< matrix
->nrows
; ++i
)
662 matrix
->rows
[i
].enabled_p
= 0;
667 /* Remember last values to be able to optimize frame redraws. */
668 matrix
->matrix_x
= x
;
669 matrix
->matrix_y
= y
;
670 matrix
->matrix_w
= dim
.width
;
671 matrix
->matrix_h
= dim
.height
;
673 /* Record the top y location and height of W at the time the matrix
674 was last adjusted. This is used to optimize redisplay above. */
677 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
678 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
679 matrix
->window_height
= window_height
;
680 matrix
->window_width
= window_width
;
681 matrix
->window_vscroll
= w
->vscroll
;
686 /* Reverse the contents of rows in MATRIX between START and END. The
687 contents of the row at END - 1 end up at START, END - 2 at START +
688 1 etc. This is part of the implementation of rotate_matrix (see
692 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
696 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
698 /* Non-ISO HP/UX compiler doesn't like auto struct
700 struct glyph_row temp
;
701 temp
= matrix
->rows
[i
];
702 matrix
->rows
[i
] = matrix
->rows
[j
];
703 matrix
->rows
[j
] = temp
;
708 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
709 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
710 indices. (Note: this does not copy glyphs, only glyph pointers in
711 row structures are moved around).
713 The algorithm used for rotating the vector was, I believe, first
714 described by Kernighan. See the vector R as consisting of two
715 sub-vectors AB, where A has length BY for BY >= 0. The result
716 after rotating is then BA. Reverse both sub-vectors to get ArBr
717 and reverse the result to get (ArBr)r which is BA. Similar for
721 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
725 /* Up (rotate left, i.e. towards lower indices). */
727 reverse_rows (matrix
, first
, first
+ by
);
728 reverse_rows (matrix
, first
+ by
, last
);
729 reverse_rows (matrix
, first
, last
);
733 /* Down (rotate right, i.e. towards higher indices). */
734 reverse_rows (matrix
, last
- by
, last
);
735 reverse_rows (matrix
, first
, last
- by
);
736 reverse_rows (matrix
, first
, last
);
741 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
742 with indices START <= index < END. Increment positions by DELTA/
746 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
747 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
749 /* Check that START and END are reasonable values. */
750 eassert (start
>= 0 && start
<= matrix
->nrows
);
751 eassert (end
>= 0 && end
<= matrix
->nrows
);
752 eassert (start
<= end
);
754 for (; start
< end
; ++start
)
755 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
759 /* Enable a range of rows in glyph matrix MATRIX. START and END are
760 the row indices of the first and last + 1 row to enable. If
761 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
764 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
766 eassert (start
<= end
);
767 eassert (start
>= 0 && start
< matrix
->nrows
);
768 eassert (end
>= 0 && end
<= matrix
->nrows
);
770 for (; start
< end
; ++start
)
771 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
777 This empties all rows in MATRIX by setting the enabled_p flag for
778 all rows of the matrix to zero. The function prepare_desired_row
779 will eventually really clear a row when it sees one with a zero
782 Resets update hints to defaults value. The only update hint
783 currently present is the flag MATRIX->no_scrolling_p. */
786 clear_glyph_matrix (struct glyph_matrix
*matrix
)
790 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
791 matrix
->no_scrolling_p
= 0;
796 /* Shift part of the glyph matrix MATRIX of window W up or down.
797 Increment y-positions in glyph rows between START and END by DY,
798 and recompute their visible height. */
801 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
805 eassert (start
<= end
);
806 eassert (start
>= 0 && start
< matrix
->nrows
);
807 eassert (end
>= 0 && end
<= matrix
->nrows
);
809 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
810 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
812 for (; start
< end
; ++start
)
814 struct glyph_row
*row
= &matrix
->rows
[start
];
817 row
->visible_height
= row
->height
;
820 row
->visible_height
-= min_y
- row
->y
;
821 if (row
->y
+ row
->height
> max_y
)
822 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
823 if (row
->fringe_bitmap_periodic_p
)
824 row
->redraw_fringe_bitmaps_p
= 1;
829 /* Mark all rows in current matrices of frame F as invalid. Marking
830 invalid is done by setting enabled_p to zero for all rows in a
834 clear_current_matrices (register struct frame
*f
)
836 /* Clear frame current matrix, if we have one. */
837 if (f
->current_matrix
)
838 clear_glyph_matrix (f
->current_matrix
);
840 /* Clear the matrix of the menu bar window, if such a window exists.
841 The menu bar window is currently used to display menus on X when
842 no toolkit support is compiled in. */
843 if (WINDOWP (f
->menu_bar_window
))
844 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
846 /* Clear the matrix of the tool-bar window, if any. */
847 if (WINDOWP (f
->tool_bar_window
))
848 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
850 /* Clear current window matrices. */
851 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
852 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
856 /* Clear out all display lines of F for a coming redisplay. */
859 clear_desired_matrices (register struct frame
*f
)
861 if (f
->desired_matrix
)
862 clear_glyph_matrix (f
->desired_matrix
);
864 if (WINDOWP (f
->menu_bar_window
))
865 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
867 if (WINDOWP (f
->tool_bar_window
))
868 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
870 /* Do it for window matrices. */
871 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
872 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
876 /* Clear matrices in window tree rooted in W. If DESIRED_P is
877 non-zero clear desired matrices, otherwise clear current matrices. */
880 clear_window_matrices (struct window
*w
, int desired_p
)
884 if (!NILP (w
->hchild
))
886 eassert (WINDOWP (w
->hchild
));
887 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
889 else if (!NILP (w
->vchild
))
891 eassert (WINDOWP (w
->vchild
));
892 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
897 clear_glyph_matrix (w
->desired_matrix
);
900 clear_glyph_matrix (w
->current_matrix
);
901 w
->window_end_valid
= Qnil
;
905 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
911 /***********************************************************************
914 See dispextern.h for an overall explanation of glyph rows.
915 ***********************************************************************/
917 /* Clear glyph row ROW. Do it in a way that makes it robust against
918 changes in the glyph_row structure, i.e. addition or removal of
919 structure members. */
921 static struct glyph_row null_row
;
924 clear_glyph_row (struct glyph_row
*row
)
926 struct glyph
*p
[1 + LAST_AREA
];
929 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
930 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
931 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
932 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
937 /* Restore pointers. */
938 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
939 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
940 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
941 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
943 #if 0 /* At some point, some bit-fields of struct glyph were not set,
944 which made glyphs unequal when compared with GLYPH_EQUAL_P.
945 Redisplay outputs such glyphs, and flickering effects were
946 the result. This also depended on the contents of memory
947 returned by xmalloc. If flickering happens again, activate
948 the code below. If the flickering is gone with that, chances
949 are that the flickering has the same reason as here. */
950 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
955 /* Make ROW an empty, enabled row of canonical character height,
956 in window W starting at y-position Y. */
959 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
963 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
964 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
966 clear_glyph_row (row
);
968 row
->ascent
= row
->phys_ascent
= 0;
969 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
970 row
->visible_height
= row
->height
;
973 row
->visible_height
-= min_y
- row
->y
;
974 if (row
->y
+ row
->height
> max_y
)
975 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
981 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
982 are the amounts by which to change positions. Note that the first
983 glyph of the text area of a row can have a buffer position even if
984 the used count of the text area is zero. Such rows display line
988 increment_row_positions (struct glyph_row
*row
,
989 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
993 /* Increment start and end positions. */
994 MATRIX_ROW_START_CHARPOS (row
) += delta
;
995 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
996 MATRIX_ROW_END_CHARPOS (row
) += delta
;
997 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
998 CHARPOS (row
->start
.pos
) += delta
;
999 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1000 CHARPOS (row
->end
.pos
) += delta
;
1001 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1003 if (!row
->enabled_p
)
1006 /* Increment positions in glyphs. */
1007 for (area
= 0; area
< LAST_AREA
; ++area
)
1008 for (i
= 0; i
< row
->used
[area
]; ++i
)
1009 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1010 && row
->glyphs
[area
][i
].charpos
> 0)
1011 row
->glyphs
[area
][i
].charpos
+= delta
;
1013 /* Capture the case of rows displaying a line end. */
1014 if (row
->used
[TEXT_AREA
] == 0
1015 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1016 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1021 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1022 contents, i.e. glyph structure contents are exchanged between A and
1023 B without changing glyph pointers in A and B. */
1026 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1030 for (area
= 0; area
< LAST_AREA
; ++area
)
1032 /* Number of glyphs to swap. */
1033 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1035 /* Start of glyphs in area of row A. */
1036 struct glyph
*glyph_a
= a
->glyphs
[area
];
1038 /* End + 1 of glyphs in area of row A. */
1039 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1041 /* Start of glyphs in area of row B. */
1042 struct glyph
*glyph_b
= b
->glyphs
[area
];
1044 while (glyph_a
< glyph_a_end
)
1046 /* Non-ISO HP/UX compiler doesn't like auto struct
1050 *glyph_a
= *glyph_b
;
1060 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1061 exchange the used[] array and the hash values of the rows, because
1062 these should all go together for the row's hash value to be
1066 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1069 unsigned hash_tem
= a
->hash
;
1071 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1073 struct glyph
*temp
= a
->glyphs
[i
];
1075 a
->glyphs
[i
] = b
->glyphs
[i
];
1076 b
->glyphs
[i
] = temp
;
1079 short used_tem
= a
->used
[i
];
1081 a
->used
[i
] = b
->used
[i
];
1082 b
->used
[i
] = used_tem
;
1090 /* Copy glyph row structure FROM to glyph row structure TO, except
1091 that glyph pointers, the `used' counts, and the hash values in the
1092 structures are left unchanged. */
1095 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1097 struct glyph
*pointers
[1 + LAST_AREA
];
1098 short used
[LAST_AREA
];
1101 /* Save glyph pointers of TO. */
1102 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1103 memcpy (used
, to
->used
, sizeof to
->used
);
1106 /* Do a structure assignment. */
1109 /* Restore original pointers of TO. */
1110 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1111 memcpy (to
->used
, used
, sizeof to
->used
);
1116 /* Assign glyph row FROM to glyph row TO. This works like a structure
1117 assignment TO = FROM, except that glyph pointers are not copied but
1118 exchanged between TO and FROM. Pointers must be exchanged to avoid
1122 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1124 swap_glyph_pointers (to
, from
);
1125 copy_row_except_pointers (to
, from
);
1129 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1130 a row in a window matrix, is a slice of the glyph memory of the
1131 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1132 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1133 memory of FRAME_ROW. */
1138 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1140 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1141 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1142 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1144 return (frame_glyph_start
<= window_glyph_start
1145 && window_glyph_start
< frame_glyph_end
);
1148 #endif /* GLYPH_DEBUG */
1152 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1153 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1154 in WINDOW_MATRIX is found satisfying the condition. */
1156 static struct glyph_row
*
1157 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1158 struct glyph_matrix
*frame_matrix
, int row
)
1162 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1164 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1165 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1166 frame_matrix
->rows
+ row
))
1169 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1174 /* Prepare ROW for display. Desired rows are cleared lazily,
1175 i.e. they are only marked as to be cleared by setting their
1176 enabled_p flag to zero. When a row is to be displayed, a prior
1177 call to this function really clears it. */
1180 prepare_desired_row (struct glyph_row
*row
)
1182 if (!row
->enabled_p
)
1184 int rp
= row
->reversed_p
;
1186 clear_glyph_row (row
);
1188 row
->reversed_p
= rp
;
1193 /* Return a hash code for glyph row ROW. */
1196 line_hash_code (struct glyph_row
*row
)
1202 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1203 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1207 int c
= glyph
->u
.ch
;
1208 int face_id
= glyph
->face_id
;
1209 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1211 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1212 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1224 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1225 the number of characters in the line. If must_write_spaces is
1226 zero, leading and trailing spaces are ignored. */
1229 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1231 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1232 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1233 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1235 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1236 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1238 /* Ignore trailing and leading spaces if we can. */
1239 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1241 /* Skip from the end over trailing spaces. */
1242 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1245 /* All blank line. */
1249 /* Skip over leading spaces. */
1250 while (CHAR_GLYPH_SPACE_P (*beg
))
1254 /* If we don't have a glyph-table, each glyph is one character,
1255 so return the number of glyphs. */
1256 if (glyph_table_base
== 0)
1260 /* Otherwise, scan the glyphs and accumulate their total length
1267 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1269 if (GLYPH_INVALID_P (g
)
1270 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1273 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1283 /* Test two glyph rows A and B for equality. Value is non-zero if A
1284 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1285 mouse_face_p flags of A and B, too. */
1288 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1290 eassert (verify_row_hash (a
));
1291 eassert (verify_row_hash (b
));
1295 else if (a
->hash
!= b
->hash
)
1299 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1302 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1305 /* Compare glyphs. */
1306 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1308 if (a
->used
[area
] != b
->used
[area
])
1311 a_glyph
= a
->glyphs
[area
];
1312 a_end
= a_glyph
+ a
->used
[area
];
1313 b_glyph
= b
->glyphs
[area
];
1315 while (a_glyph
< a_end
1316 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1317 ++a_glyph
, ++b_glyph
;
1319 if (a_glyph
!= a_end
)
1323 if (a
->fill_line_p
!= b
->fill_line_p
1324 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1325 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1326 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1327 || a
->left_fringe_offset
!= b
->left_fringe_offset
1328 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1329 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1330 || a
->right_fringe_offset
!= b
->right_fringe_offset
1331 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1332 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1333 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1334 || a
->overlapped_p
!= b
->overlapped_p
1335 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1336 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1337 || a
->reversed_p
!= b
->reversed_p
1338 /* Different partially visible characters on left margin. */
1340 /* Different height. */
1341 || a
->ascent
!= b
->ascent
1342 || a
->phys_ascent
!= b
->phys_ascent
1343 || a
->phys_height
!= b
->phys_height
1344 || a
->visible_height
!= b
->visible_height
)
1353 /***********************************************************************
1356 See dispextern.h for an overall explanation of glyph pools.
1357 ***********************************************************************/
1359 /* Allocate a glyph_pool structure. The structure returned is
1360 initialized with zeros. The global variable glyph_pool_count is
1361 incremented for each pool allocated. */
1363 static struct glyph_pool
*
1364 new_glyph_pool (void)
1366 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1368 /* For memory leak and double deletion checking. */
1375 /* Free a glyph_pool structure POOL. The function may be called with
1376 a null POOL pointer. The global variable glyph_pool_count is
1377 decremented with every pool structure freed. If this count gets
1378 negative, more structures were freed than allocated, i.e. one
1379 structure must have been freed more than once or a bogus pointer
1380 was passed to free_glyph_pool. */
1383 free_glyph_pool (struct glyph_pool
*pool
)
1387 /* More freed than allocated? */
1389 eassert (glyph_pool_count
>= 0);
1391 xfree (pool
->glyphs
);
1397 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1398 columns we need. This function never shrinks a pool. The only
1399 case in which this would make sense, would be when a frame's size
1400 is changed from a large value to a smaller one. But, if someone
1401 does it once, we can expect that he will do it again.
1403 Value is non-zero if the pool changed in a way which makes
1404 re-adjusting window glyph matrices necessary. */
1407 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1412 changed_p
= (pool
->glyphs
== 0
1413 || matrix_dim
.height
!= pool
->nrows
1414 || matrix_dim
.width
!= pool
->ncolumns
);
1416 /* Enlarge the glyph pool. */
1417 needed
= matrix_dim
.width
;
1418 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1419 memory_full (SIZE_MAX
);
1420 needed
*= matrix_dim
.height
;
1421 if (needed
> pool
->nglyphs
)
1423 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1424 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1425 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1426 memset (pool
->glyphs
+ old_nglyphs
, 0,
1427 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1430 /* Remember the number of rows and columns because (a) we use them
1431 to do sanity checks, and (b) the number of columns determines
1432 where rows in the frame matrix start---this must be available to
1433 determine pointers to rows of window sub-matrices. */
1434 pool
->nrows
= matrix_dim
.height
;
1435 pool
->ncolumns
= matrix_dim
.width
;
1442 /***********************************************************************
1444 ***********************************************************************/
1449 /* Flush standard output. This is sometimes useful to call from the debugger.
1450 XXX Maybe this should be changed to flush the current terminal instead of
1454 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1463 /* Check that no glyph pointers have been lost in MATRIX. If a
1464 pointer has been lost, e.g. by using a structure assignment between
1465 rows, at least one pointer must occur more than once in the rows of
1469 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1473 for (i
= 0; i
< matrix
->nrows
; ++i
)
1474 for (j
= 0; j
< matrix
->nrows
; ++j
)
1476 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1477 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1481 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1484 matrix_row (struct glyph_matrix
*matrix
, int row
)
1486 eassert (matrix
&& matrix
->rows
);
1487 eassert (row
>= 0 && row
< matrix
->nrows
);
1489 /* That's really too slow for normal testing because this function
1490 is called almost everywhere. Although---it's still astonishingly
1491 fast, so it is valuable to have for debugging purposes. */
1493 check_matrix_pointer_lossage (matrix
);
1496 return matrix
->rows
+ row
;
1500 #if 0 /* This function makes invalid assumptions when text is
1501 partially invisible. But it might come handy for debugging
1504 /* Check invariants that must hold for an up to date current matrix of
1508 check_matrix_invariants (struct window
*w
)
1510 struct glyph_matrix
*matrix
= w
->current_matrix
;
1511 int yb
= window_text_bottom_y (w
);
1512 struct glyph_row
*row
= matrix
->rows
;
1513 struct glyph_row
*last_text_row
= NULL
;
1514 struct buffer
*saved
= current_buffer
;
1515 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1518 /* This can sometimes happen for a fresh window. */
1519 if (matrix
->nrows
< 2)
1522 set_buffer_temp (buffer
);
1524 /* Note: last row is always reserved for the mode line. */
1525 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1526 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1528 struct glyph_row
*next
= row
+ 1;
1530 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1531 last_text_row
= row
;
1533 /* Check that character and byte positions are in sync. */
1534 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1535 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1536 eassert (BYTEPOS (row
->start
.pos
)
1537 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1539 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1540 have such a position temporarily in case of a minibuffer
1541 displaying something like `[Sole completion]' at its end. */
1542 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1544 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1545 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1546 eassert (BYTEPOS (row
->end
.pos
)
1547 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1550 /* Check that end position of `row' is equal to start position
1552 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1554 eassert (MATRIX_ROW_END_CHARPOS (row
)
1555 == MATRIX_ROW_START_CHARPOS (next
));
1556 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1557 == MATRIX_ROW_START_BYTEPOS (next
));
1558 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1559 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1564 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1565 eassert (w
->desired_matrix
->rows
!= NULL
);
1566 set_buffer_temp (saved
);
1571 #endif /* GLYPH_DEBUG */
1575 /**********************************************************************
1576 Allocating/ Adjusting Glyph Matrices
1577 **********************************************************************/
1579 /* Allocate glyph matrices over a window tree for a frame-based
1582 X and Y are column/row within the frame glyph matrix where
1583 sub-matrices for the window tree rooted at WINDOW must be
1584 allocated. DIM_ONLY_P non-zero means that the caller of this
1585 function is only interested in the result matrix dimension, and
1586 matrix adjustments should not be performed.
1588 The function returns the total width/height of the sub-matrices of
1589 the window tree. If called on a frame root window, the computation
1590 will take the mini-buffer window into account.
1592 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1594 NEW_LEAF_MATRIX set if any window in the tree did not have a
1595 glyph matrices yet, and
1597 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1598 any window in the tree will be changed or have been changed (see
1601 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1604 Windows are arranged into chains of windows on the same level
1605 through the next fields of window structures. Such a level can be
1606 either a sequence of horizontally adjacent windows from left to
1607 right, or a sequence of vertically adjacent windows from top to
1608 bottom. Each window in a horizontal sequence can be either a leaf
1609 window or a vertical sequence; a window in a vertical sequence can
1610 be either a leaf or a horizontal sequence. All windows in a
1611 horizontal sequence have the same height, and all windows in a
1612 vertical sequence have the same width.
1614 This function uses, for historical reasons, a more general
1615 algorithm to determine glyph matrix dimensions that would be
1618 The matrix height of a horizontal sequence is determined by the
1619 maximum height of any matrix in the sequence. The matrix width of
1620 a horizontal sequence is computed by adding up matrix widths of
1621 windows in the sequence.
1623 |<------- result width ------->|
1624 +---------+----------+---------+ ---
1627 +---------+ | | result height
1632 The matrix width of a vertical sequence is the maximum matrix width
1633 of any window in the sequence. Its height is computed by adding up
1634 matrix heights of windows in the sequence.
1636 |<---- result width -->|
1644 +------------+---------+ |
1647 +------------+---------+ --- */
1649 /* Bit indicating that a new matrix will be allocated or has been
1652 #define NEW_LEAF_MATRIX (1 << 0)
1654 /* Bit indicating that a matrix will or has changed its location or
1657 #define CHANGED_LEAF_MATRIX (1 << 1)
1660 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1661 int dim_only_p
, int *window_change_flags
)
1663 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1665 int wmax
= 0, hmax
= 0;
1669 int in_horz_combination_p
;
1671 /* What combination is WINDOW part of? Compute this once since the
1672 result is the same for all windows in the `next' chain. The
1673 special case of a root window (parent equal to nil) is treated
1674 like a vertical combination because a root window's `next'
1675 points to the mini-buffer window, if any, which is arranged
1676 vertically below other windows. */
1677 in_horz_combination_p
1678 = (!NILP (XWINDOW (window
)->parent
)
1679 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1681 /* For WINDOW and all windows on the same level. */
1684 w
= XWINDOW (window
);
1686 /* Get the dimension of the window sub-matrix for W, depending
1687 on whether this is a combination or a leaf window. */
1688 if (!NILP (w
->hchild
))
1689 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1691 window_change_flags
);
1692 else if (!NILP (w
->vchild
))
1693 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1695 window_change_flags
);
1698 /* If not already done, allocate sub-matrix structures. */
1699 if (w
->desired_matrix
== NULL
)
1701 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1702 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1703 *window_change_flags
|= NEW_LEAF_MATRIX
;
1706 /* Width and height MUST be chosen so that there are no
1707 holes in the frame matrix. */
1708 dim
.width
= required_matrix_width (w
);
1709 dim
.height
= required_matrix_height (w
);
1711 /* Will matrix be re-allocated? */
1712 if (x
!= w
->desired_matrix
->matrix_x
1713 || y
!= w
->desired_matrix
->matrix_y
1714 || dim
.width
!= w
->desired_matrix
->matrix_w
1715 || dim
.height
!= w
->desired_matrix
->matrix_h
1716 || (margin_glyphs_to_reserve (w
, dim
.width
,
1717 w
->left_margin_cols
)
1718 != w
->desired_matrix
->left_margin_glyphs
)
1719 || (margin_glyphs_to_reserve (w
, dim
.width
,
1720 w
->right_margin_cols
)
1721 != w
->desired_matrix
->right_margin_glyphs
))
1722 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1724 /* Actually change matrices, if allowed. Do not consider
1725 CHANGED_LEAF_MATRIX computed above here because the pool
1726 may have been changed which we don't now here. We trust
1727 that we only will be called with DIM_ONLY_P != 0 when
1731 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1732 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1736 /* If we are part of a horizontal combination, advance x for
1737 windows to the right of W; otherwise advance y for windows
1739 if (in_horz_combination_p
)
1744 /* Remember maximum glyph matrix dimensions. */
1745 wmax
= max (wmax
, dim
.width
);
1746 hmax
= max (hmax
, dim
.height
);
1748 /* Next window on same level. */
1751 while (!NILP (window
));
1753 /* Set `total' to the total glyph matrix dimension of this window
1754 level. In a vertical combination, the width is the width of the
1755 widest window; the height is the y we finally reached, corrected
1756 by the y we started with. In a horizontal combination, the total
1757 height is the height of the tallest window, and the width is the
1758 x we finally reached, corrected by the x we started with. */
1759 if (in_horz_combination_p
)
1761 total
.width
= x
- x0
;
1762 total
.height
= hmax
;
1767 total
.height
= y
- y0
;
1774 /* Return the required height of glyph matrices for window W. */
1777 required_matrix_height (struct window
*w
)
1779 #ifdef HAVE_WINDOW_SYSTEM
1780 struct frame
*f
= XFRAME (w
->frame
);
1782 if (FRAME_WINDOW_P (f
))
1784 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1785 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1786 return (((window_pixel_height
+ ch_height
- 1)
1787 / ch_height
) * w
->nrows_scale_factor
1788 /* One partially visible line at the top and
1789 bottom of the window. */
1791 /* 2 for header and mode line. */
1794 #endif /* HAVE_WINDOW_SYSTEM */
1796 return WINDOW_TOTAL_LINES (w
);
1800 /* Return the required width of glyph matrices for window W. */
1803 required_matrix_width (struct window
*w
)
1805 #ifdef HAVE_WINDOW_SYSTEM
1806 struct frame
*f
= XFRAME (w
->frame
);
1807 if (FRAME_WINDOW_P (f
))
1809 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1810 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1812 /* Compute number of glyphs needed in a glyph row. */
1813 return (((window_pixel_width
+ ch_width
- 1)
1814 / ch_width
) * w
->ncols_scale_factor
1815 /* 2 partially visible columns in the text area. */
1817 /* One partially visible column at the right
1818 edge of each marginal area. */
1821 #endif /* HAVE_WINDOW_SYSTEM */
1823 return XINT (w
->total_cols
);
1827 /* Allocate window matrices for window-based redisplay. W is the
1828 window whose matrices must be allocated/reallocated. */
1831 allocate_matrices_for_window_redisplay (struct window
*w
)
1835 if (!NILP (w
->vchild
))
1836 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1837 else if (!NILP (w
->hchild
))
1838 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1841 /* W is a leaf window. */
1844 /* If matrices are not yet allocated, allocate them now. */
1845 if (w
->desired_matrix
== NULL
)
1847 w
->desired_matrix
= new_glyph_matrix (NULL
);
1848 w
->current_matrix
= new_glyph_matrix (NULL
);
1851 dim
.width
= required_matrix_width (w
);
1852 dim
.height
= required_matrix_height (w
);
1853 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1854 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1857 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1862 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1863 do it for all frames; otherwise do it just for the given frame.
1864 This function must be called when a new frame is created, its size
1865 changes, or its window configuration changes. */
1868 adjust_glyphs (struct frame
*f
)
1870 /* Block input so that expose events and other events that access
1871 glyph matrices are not processed while we are changing them. */
1875 adjust_frame_glyphs (f
);
1878 Lisp_Object tail
, lisp_frame
;
1880 FOR_EACH_FRAME (tail
, lisp_frame
)
1881 adjust_frame_glyphs (XFRAME (lisp_frame
));
1888 /* Adjust frame glyphs when Emacs is initialized.
1890 To be called from init_display.
1892 We need a glyph matrix because redraw will happen soon.
1893 Unfortunately, window sizes on selected_frame are not yet set to
1894 meaningful values. I believe we can assume that there are only two
1895 windows on the frame---the mini-buffer and the root window. Frame
1896 height and width seem to be correct so far. So, set the sizes of
1897 windows to estimated values. */
1900 adjust_frame_glyphs_initially (void)
1902 struct frame
*sf
= SELECTED_FRAME ();
1903 struct window
*root
= XWINDOW (sf
->root_window
);
1904 struct window
*mini
= XWINDOW (root
->next
);
1905 int frame_lines
= FRAME_LINES (sf
);
1906 int frame_cols
= FRAME_COLS (sf
);
1907 int top_margin
= FRAME_TOP_MARGIN (sf
);
1909 /* Do it for the root window. */
1910 XSETFASTINT (root
->top_line
, top_margin
);
1911 XSETFASTINT (root
->total_lines
, frame_lines
- 1 - top_margin
);
1912 XSETFASTINT (root
->total_cols
, frame_cols
);
1914 /* Do it for the mini-buffer window. */
1915 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1916 XSETFASTINT (mini
->total_lines
, 1);
1917 XSETFASTINT (mini
->total_cols
, frame_cols
);
1919 adjust_frame_glyphs (sf
);
1920 glyphs_initialized_initially_p
= 1;
1924 /* Allocate/reallocate glyph matrices of a single frame F. */
1927 adjust_frame_glyphs (struct frame
*f
)
1929 if (FRAME_WINDOW_P (f
))
1930 adjust_frame_glyphs_for_window_redisplay (f
);
1932 adjust_frame_glyphs_for_frame_redisplay (f
);
1934 /* Don't forget the message buffer and the buffer for
1935 decode_mode_spec. */
1936 adjust_frame_message_buffer (f
);
1937 adjust_decode_mode_spec_buffer (f
);
1939 f
->glyphs_initialized_p
= 1;
1942 /* Return 1 if any window in the tree has nonzero window margins. See
1943 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1945 showing_window_margins_p (struct window
*w
)
1949 if (!NILP (w
->hchild
))
1951 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1954 else if (!NILP (w
->vchild
))
1956 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1959 else if (!NILP (w
->left_margin_cols
)
1960 || !NILP (w
->right_margin_cols
))
1963 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1969 /* In the window tree with root W, build current matrices of leaf
1970 windows from the frame's current matrix. */
1973 fake_current_matrices (Lisp_Object window
)
1977 for (; !NILP (window
); window
= w
->next
)
1979 w
= XWINDOW (window
);
1981 if (!NILP (w
->hchild
))
1982 fake_current_matrices (w
->hchild
);
1983 else if (!NILP (w
->vchild
))
1984 fake_current_matrices (w
->vchild
);
1988 struct frame
*f
= XFRAME (w
->frame
);
1989 struct glyph_matrix
*m
= w
->current_matrix
;
1990 struct glyph_matrix
*fm
= f
->current_matrix
;
1992 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1993 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1995 for (i
= 0; i
< m
->matrix_h
; ++i
)
1997 struct glyph_row
*r
= m
->rows
+ i
;
1998 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2000 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2001 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2003 r
->enabled_p
= fr
->enabled_p
;
2006 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2007 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2008 r
->used
[TEXT_AREA
] = (m
->matrix_w
2009 - r
->used
[LEFT_MARGIN_AREA
]
2010 - r
->used
[RIGHT_MARGIN_AREA
]);
2019 /* Save away the contents of frame F's current frame matrix. Value is
2020 a glyph matrix holding the contents of F's current frame matrix. */
2022 static struct glyph_matrix
*
2023 save_current_matrix (struct frame
*f
)
2026 struct glyph_matrix
*saved
;
2028 saved
= xzalloc (sizeof *saved
);
2029 saved
->nrows
= f
->current_matrix
->nrows
;
2030 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
2032 for (i
= 0; i
< saved
->nrows
; ++i
)
2034 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2035 struct glyph_row
*to
= saved
->rows
+ i
;
2036 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2037 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
2038 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2039 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2046 /* Restore the contents of frame F's current frame matrix from SAVED,
2047 and free memory associated with SAVED. */
2050 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2054 for (i
= 0; i
< saved
->nrows
; ++i
)
2056 struct glyph_row
*from
= saved
->rows
+ i
;
2057 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2058 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2059 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2060 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2061 xfree (from
->glyphs
[TEXT_AREA
]);
2064 xfree (saved
->rows
);
2070 /* Allocate/reallocate glyph matrices of a single frame F for
2071 frame-based redisplay. */
2074 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2076 struct dim matrix_dim
;
2078 int window_change_flags
;
2081 if (!FRAME_LIVE_P (f
))
2084 top_window_y
= FRAME_TOP_MARGIN (f
);
2086 /* Allocate glyph pool structures if not already done. */
2087 if (f
->desired_pool
== NULL
)
2089 f
->desired_pool
= new_glyph_pool ();
2090 f
->current_pool
= new_glyph_pool ();
2093 /* Allocate frames matrix structures if needed. */
2094 if (f
->desired_matrix
== NULL
)
2096 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2097 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2100 /* Compute window glyph matrices. (This takes the mini-buffer
2101 window into account). The result is the size of the frame glyph
2102 matrix needed. The variable window_change_flags is set to a bit
2103 mask indicating whether new matrices will be allocated or
2104 existing matrices change their size or location within the frame
2106 window_change_flags
= 0;
2108 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2111 &window_change_flags
);
2113 /* Add in menu bar lines, if any. */
2114 matrix_dim
.height
+= top_window_y
;
2116 /* Enlarge pools as necessary. */
2117 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2118 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2120 /* Set up glyph pointers within window matrices. Do this only if
2121 absolutely necessary since it requires a frame redraw. */
2122 if (pool_changed_p
|| window_change_flags
)
2124 /* Do it for window matrices. */
2125 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2127 &window_change_flags
);
2129 /* Size of frame matrices must equal size of frame. Note
2130 that we are called for X frames with window widths NOT equal
2131 to the frame width (from CHANGE_FRAME_SIZE_1). */
2132 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2133 && matrix_dim
.height
== FRAME_LINES (f
));
2135 /* Pointers to glyph memory in glyph rows are exchanged during
2136 the update phase of redisplay, which means in general that a
2137 frame's current matrix consists of pointers into both the
2138 desired and current glyph pool of the frame. Adjusting a
2139 matrix sets the frame matrix up so that pointers are all into
2140 the same pool. If we want to preserve glyph contents of the
2141 current matrix over a call to adjust_glyph_matrix, we must
2142 make a copy of the current glyphs, and restore the current
2143 matrix' contents from that copy. */
2144 if (display_completed
2145 && !FRAME_GARBAGED_P (f
)
2146 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2147 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2148 /* For some reason, the frame glyph matrix gets corrupted if
2149 any of the windows contain margins. I haven't been able
2150 to hunt down the reason, but for the moment this prevents
2151 the problem from manifesting. -- cyd */
2152 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2154 struct glyph_matrix
*copy
= save_current_matrix (f
);
2155 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2156 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2157 restore_current_matrix (f
, copy
);
2158 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2162 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2163 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2164 SET_FRAME_GARBAGED (f
);
2170 /* Allocate/reallocate glyph matrices of a single frame F for
2171 window-based redisplay. */
2174 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2176 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2178 /* Allocate/reallocate window matrices. */
2179 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2181 #ifdef HAVE_X_WINDOWS
2182 /* Allocate/ reallocate matrices of the dummy window used to display
2183 the menu bar under X when no X toolkit support is available. */
2184 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2186 /* Allocate a dummy window if not already done. */
2188 if (NILP (f
->menu_bar_window
))
2190 f
->menu_bar_window
= make_window ();
2191 w
= XWINDOW (f
->menu_bar_window
);
2192 XSETFRAME (w
->frame
, f
);
2193 w
->pseudo_window_p
= 1;
2196 w
= XWINDOW (f
->menu_bar_window
);
2198 /* Set window dimensions to frame dimensions and allocate or
2199 adjust glyph matrices of W. */
2200 XSETFASTINT (w
->top_line
, 0);
2201 XSETFASTINT (w
->left_col
, 0);
2202 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2203 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2204 allocate_matrices_for_window_redisplay (w
);
2206 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2207 #endif /* HAVE_X_WINDOWS */
2211 /* Allocate/ reallocate matrices of the tool bar window. If we
2212 don't have a tool bar window yet, make one. */
2214 if (NILP (f
->tool_bar_window
))
2216 f
->tool_bar_window
= make_window ();
2217 w
= XWINDOW (f
->tool_bar_window
);
2218 XSETFRAME (w
->frame
, f
);
2219 w
->pseudo_window_p
= 1;
2222 w
= XWINDOW (f
->tool_bar_window
);
2224 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2225 XSETFASTINT (w
->left_col
, 0);
2226 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2227 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2228 allocate_matrices_for_window_redisplay (w
);
2234 /* Adjust/ allocate message buffer of frame F.
2236 Note that the message buffer is never freed. Since I could not
2237 find a free in 19.34, I assume that freeing it would be
2238 problematic in some way and don't do it either.
2240 (Implementation note: It should be checked if we can free it
2241 eventually without causing trouble). */
2244 adjust_frame_message_buffer (struct frame
*f
)
2246 ptrdiff_t size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2248 if (FRAME_MESSAGE_BUF (f
))
2250 char *buffer
= FRAME_MESSAGE_BUF (f
);
2251 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2252 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2255 FRAME_MESSAGE_BUF (f
) = xmalloc (size
);
2259 /* Re-allocate buffer for decode_mode_spec on frame F. */
2262 adjust_decode_mode_spec_buffer (struct frame
*f
)
2264 f
->decode_mode_spec_buffer
2265 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2266 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2271 /**********************************************************************
2272 Freeing Glyph Matrices
2273 **********************************************************************/
2275 /* Free glyph memory for a frame F. F may be null. This function can
2276 be called for the same frame more than once. The root window of
2277 F may be nil when this function is called. This is the case when
2278 the function is called when F is destroyed. */
2281 free_glyphs (struct frame
*f
)
2283 if (f
&& f
->glyphs_initialized_p
)
2285 /* Block interrupt input so that we don't get surprised by an X
2286 event while we're in an inconsistent state. */
2288 f
->glyphs_initialized_p
= 0;
2290 /* Release window sub-matrices. */
2291 if (!NILP (f
->root_window
))
2292 free_window_matrices (XWINDOW (f
->root_window
));
2294 /* Free the dummy window for menu bars without X toolkit and its
2296 if (!NILP (f
->menu_bar_window
))
2298 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2299 free_glyph_matrix (w
->desired_matrix
);
2300 free_glyph_matrix (w
->current_matrix
);
2301 w
->desired_matrix
= w
->current_matrix
= NULL
;
2302 f
->menu_bar_window
= Qnil
;
2305 /* Free the tool bar window and its glyph matrices. */
2306 if (!NILP (f
->tool_bar_window
))
2308 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2309 free_glyph_matrix (w
->desired_matrix
);
2310 free_glyph_matrix (w
->current_matrix
);
2311 w
->desired_matrix
= w
->current_matrix
= NULL
;
2312 f
->tool_bar_window
= Qnil
;
2315 /* Release frame glyph matrices. Reset fields to zero in
2316 case we are called a second time. */
2317 if (f
->desired_matrix
)
2319 free_glyph_matrix (f
->desired_matrix
);
2320 free_glyph_matrix (f
->current_matrix
);
2321 f
->desired_matrix
= f
->current_matrix
= NULL
;
2324 /* Release glyph pools. */
2325 if (f
->desired_pool
)
2327 free_glyph_pool (f
->desired_pool
);
2328 free_glyph_pool (f
->current_pool
);
2329 f
->desired_pool
= f
->current_pool
= NULL
;
2337 /* Free glyph sub-matrices in the window tree rooted at W. This
2338 function may be called with a null pointer, and it may be called on
2339 the same tree more than once. */
2342 free_window_matrices (struct window
*w
)
2346 if (!NILP (w
->hchild
))
2347 free_window_matrices (XWINDOW (w
->hchild
));
2348 else if (!NILP (w
->vchild
))
2349 free_window_matrices (XWINDOW (w
->vchild
));
2352 /* This is a leaf window. Free its memory and reset fields
2353 to zero in case this function is called a second time for
2355 free_glyph_matrix (w
->current_matrix
);
2356 free_glyph_matrix (w
->desired_matrix
);
2357 w
->current_matrix
= w
->desired_matrix
= NULL
;
2360 /* Next window on same level. */
2361 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2366 /* Check glyph memory leaks. This function is called from
2367 shut_down_emacs. Note that frames are not destroyed when Emacs
2368 exits. We therefore free all glyph memory for all active frames
2369 explicitly and check that nothing is left allocated. */
2372 check_glyph_memory (void)
2374 Lisp_Object tail
, frame
;
2376 /* Free glyph memory for all frames. */
2377 FOR_EACH_FRAME (tail
, frame
)
2378 free_glyphs (XFRAME (frame
));
2380 /* Check that nothing is left allocated. */
2381 if (glyph_matrix_count
)
2383 if (glyph_pool_count
)
2389 /**********************************************************************
2390 Building a Frame Matrix
2391 **********************************************************************/
2393 /* Most of the redisplay code works on glyph matrices attached to
2394 windows. This is a good solution most of the time, but it is not
2395 suitable for terminal code. Terminal output functions cannot rely
2396 on being able to set an arbitrary terminal window. Instead they
2397 must be provided with a view of the whole frame, i.e. the whole
2398 screen. We build such a view by constructing a frame matrix from
2399 window matrices in this section.
2401 Windows that must be updated have their must_be_update_p flag set.
2402 For all such windows, their desired matrix is made part of the
2403 desired frame matrix. For other windows, their current matrix is
2404 made part of the desired frame matrix.
2406 +-----------------+----------------+
2407 | desired | desired |
2409 +-----------------+----------------+
2412 +----------------------------------+
2414 Desired window matrices can be made part of the frame matrix in a
2415 cheap way: We exploit the fact that the desired frame matrix and
2416 desired window matrices share their glyph memory. This is not
2417 possible for current window matrices. Their glyphs are copied to
2418 the desired frame matrix. The latter is equivalent to
2419 preserve_other_columns in the old redisplay.
2421 Used glyphs counters for frame matrix rows are the result of adding
2422 up glyph lengths of the window matrices. A line in the frame
2423 matrix is enabled, if a corresponding line in a window matrix is
2426 After building the desired frame matrix, it will be passed to
2427 terminal code, which will manipulate both the desired and current
2428 frame matrix. Changes applied to the frame's current matrix have
2429 to be visible in current window matrices afterwards, of course.
2431 This problem is solved like this:
2433 1. Window and frame matrices share glyphs. Window matrices are
2434 constructed in a way that their glyph contents ARE the glyph
2435 contents needed in a frame matrix. Thus, any modification of
2436 glyphs done in terminal code will be reflected in window matrices
2439 2. Exchanges of rows in a frame matrix done by terminal code are
2440 intercepted by hook functions so that corresponding row operations
2441 on window matrices can be performed. This is necessary because we
2442 use pointers to glyphs in glyph row structures. To satisfy the
2443 assumption of point 1 above that glyphs are updated implicitly in
2444 window matrices when they are manipulated via the frame matrix,
2445 window and frame matrix must of course agree where to find the
2446 glyphs for their rows. Possible manipulations that must be
2447 mirrored are assignments of rows of the desired frame matrix to the
2448 current frame matrix and scrolling the current frame matrix. */
2450 /* Build frame F's desired matrix from window matrices. Only windows
2451 which have the flag must_be_updated_p set have to be updated. Menu
2452 bar lines of a frame are not covered by window matrices, so make
2453 sure not to touch them in this function. */
2456 build_frame_matrix (struct frame
*f
)
2460 /* F must have a frame matrix when this function is called. */
2461 eassert (!FRAME_WINDOW_P (f
));
2463 /* Clear all rows in the frame matrix covered by window matrices.
2464 Menu bar lines are not covered by windows. */
2465 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2466 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2468 /* Build the matrix by walking the window tree. */
2469 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2470 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2474 /* Walk a window tree, building a frame matrix MATRIX from window
2475 matrices. W is the root of a window tree. */
2478 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2482 if (!NILP (w
->hchild
))
2483 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2484 else if (!NILP (w
->vchild
))
2485 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2487 build_frame_matrix_from_leaf_window (matrix
, w
);
2489 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2494 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2495 desired frame matrix built. W is a leaf window whose desired or
2496 current matrix is to be added to FRAME_MATRIX. W's flag
2497 must_be_updated_p determines which matrix it contributes to
2498 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2499 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2500 Adding a desired matrix means setting up used counters and such in
2501 frame rows, while adding a current window matrix to FRAME_MATRIX
2502 means copying glyphs. The latter case corresponds to
2503 preserve_other_columns in the old redisplay. */
2506 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2508 struct glyph_matrix
*window_matrix
;
2509 int window_y
, frame_y
;
2510 /* If non-zero, a glyph to insert at the right border of W. */
2511 GLYPH right_border_glyph
;
2513 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2515 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2516 if (w
->must_be_updated_p
)
2518 window_matrix
= w
->desired_matrix
;
2520 /* Decide whether we want to add a vertical border glyph. */
2521 if (!WINDOW_RIGHTMOST_P (w
))
2523 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2526 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2528 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2530 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2531 spec_glyph_lookup_face (w
, &right_border_glyph
);
2534 if (GLYPH_FACE (right_border_glyph
) <= 0)
2535 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2539 window_matrix
= w
->current_matrix
;
2541 /* For all rows in the window matrix and corresponding rows in the
2544 frame_y
= window_matrix
->matrix_y
;
2545 while (window_y
< window_matrix
->nrows
)
2547 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2548 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2549 int current_row_p
= window_matrix
== w
->current_matrix
;
2551 /* Fill up the frame row with spaces up to the left margin of the
2553 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2555 /* Fill up areas in the window matrix row with spaces. */
2556 fill_up_glyph_row_with_spaces (window_row
);
2558 /* If only part of W's desired matrix has been built, and
2559 window_row wasn't displayed, use the corresponding current
2561 if (window_matrix
== w
->desired_matrix
2562 && !window_row
->enabled_p
)
2564 window_row
= w
->current_matrix
->rows
+ window_y
;
2570 /* Copy window row to frame row. */
2571 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2572 window_row
->glyphs
[0],
2573 window_matrix
->matrix_w
* sizeof (struct glyph
));
2577 eassert (window_row
->enabled_p
);
2579 /* Only when a desired row has been displayed, we want
2580 the corresponding frame row to be updated. */
2581 frame_row
->enabled_p
= 1;
2583 /* Maybe insert a vertical border between horizontally adjacent
2585 if (GLYPH_CHAR (right_border_glyph
) != 0)
2587 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2588 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2592 /* Window row window_y must be a slice of frame row
2594 eassert (glyph_row_slice_p (window_row
, frame_row
));
2596 /* If rows are in sync, we don't have to copy glyphs because
2597 frame and window share glyphs. */
2599 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2600 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2604 /* Set number of used glyphs in the frame matrix. Since we fill
2605 up with spaces, and visit leaf windows from left to right it
2606 can be done simply. */
2607 frame_row
->used
[TEXT_AREA
]
2608 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2616 /* Given a user-specified glyph, possibly including a Lisp-level face
2617 ID, return a glyph that has a realized face ID.
2618 This is used for glyphs displayed specially and not part of the text;
2619 for instance, vertical separators, truncation markers, etc. */
2622 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2624 int lface_id
= GLYPH_FACE (*glyph
);
2625 /* Convert the glyph's specified face to a realized (cache) face. */
2628 int face_id
= merge_faces (XFRAME (w
->frame
),
2629 Qt
, lface_id
, DEFAULT_FACE_ID
);
2630 SET_GLYPH_FACE (*glyph
, face_id
);
2634 /* Add spaces to a glyph row ROW in a window matrix.
2636 Each row has the form:
2638 +---------+-----------------------------+------------+
2639 | left | text | right |
2640 +---------+-----------------------------+------------+
2642 Left and right marginal areas are optional. This function adds
2643 spaces to areas so that there are no empty holes between areas.
2644 In other words: If the right area is not empty, the text area
2645 is filled up with spaces up to the right area. If the text area
2646 is not empty, the left area is filled up.
2648 To be called for frame-based redisplay, only. */
2651 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2653 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2654 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2655 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2659 /* Fill area AREA of glyph row ROW with spaces. To be called for
2660 frame-based redisplay only. */
2663 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2665 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2667 struct glyph
*end
= row
->glyphs
[area
+ 1];
2668 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2671 *text
++ = space_glyph
;
2672 row
->used
[area
] = text
- row
->glyphs
[area
];
2677 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2678 reached. In frame matrices only one area, TEXT_AREA, is used. */
2681 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2683 int i
= row
->used
[TEXT_AREA
];
2684 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2687 glyph
[i
++] = space_glyph
;
2689 row
->used
[TEXT_AREA
] = i
;
2694 /**********************************************************************
2695 Mirroring operations on frame matrices in window matrices
2696 **********************************************************************/
2698 /* Set frame being updated via frame-based redisplay to F. This
2699 function must be called before updates to make explicit that we are
2700 working on frame matrices or not. */
2703 set_frame_matrix_frame (struct frame
*f
)
2705 frame_matrix_frame
= f
;
2709 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2710 DESIRED_MATRIX is the desired matrix corresponding to
2711 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2712 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2713 frame_matrix_frame is non-null, this indicates that the exchange is
2714 done in frame matrices, and that we have to perform analogous
2715 operations in window matrices of frame_matrix_frame. */
2718 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2720 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2721 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2722 int mouse_face_p
= current_row
->mouse_face_p
;
2724 /* Do current_row = desired_row. This exchanges glyph pointers
2725 between both rows, and does a structure assignment otherwise. */
2726 assign_row (current_row
, desired_row
);
2728 /* Enable current_row to mark it as valid. */
2729 current_row
->enabled_p
= 1;
2730 current_row
->mouse_face_p
= mouse_face_p
;
2732 /* If we are called on frame matrices, perform analogous operations
2733 for window matrices. */
2734 if (frame_matrix_frame
)
2735 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2739 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2740 W's frame which has been made current (by swapping pointers between
2741 current and desired matrix). Perform analogous operations in the
2742 matrices of leaf windows in the window tree rooted at W. */
2745 mirror_make_current (struct window
*w
, int frame_row
)
2749 if (!NILP (w
->hchild
))
2750 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2751 else if (!NILP (w
->vchild
))
2752 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2755 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2756 here because the checks performed in debug mode there
2757 will not allow the conversion. */
2758 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2760 /* If FRAME_ROW is within W, assign the desired row to the
2761 current row (exchanging glyph pointers). */
2762 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2764 struct glyph_row
*current_row
2765 = MATRIX_ROW (w
->current_matrix
, row
);
2766 struct glyph_row
*desired_row
2767 = MATRIX_ROW (w
->desired_matrix
, row
);
2769 if (desired_row
->enabled_p
)
2770 assign_row (current_row
, desired_row
);
2772 swap_glyph_pointers (desired_row
, current_row
);
2773 current_row
->enabled_p
= 1;
2775 /* Set the Y coordinate of the mode/header line's row.
2776 It is needed in draw_row_with_mouse_face to find the
2777 screen coordinates. (Window-based redisplay sets
2778 this in update_window, but no one seems to do that
2779 for frame-based redisplay.) */
2780 if (current_row
->mode_line_p
)
2781 current_row
->y
= row
;
2785 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2790 /* Perform row dance after scrolling. We are working on the range of
2791 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2792 including) in MATRIX. COPY_FROM is a vector containing, for each
2793 row I in the range 0 <= I < NLINES, the index of the original line
2794 to move to I. This index is relative to the row range, i.e. 0 <=
2795 index < NLINES. RETAINED_P is a vector containing zero for each
2796 row 0 <= I < NLINES which is empty.
2798 This function is called from do_scrolling and do_direct_scrolling. */
2801 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2802 int *copy_from
, char *retained_p
)
2804 /* A copy of original rows. */
2805 struct glyph_row
*old_rows
;
2807 /* Rows to assign to. */
2808 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2812 /* Make a copy of the original rows. */
2813 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2814 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2816 /* Assign new rows, maybe clear lines. */
2817 for (i
= 0; i
< nlines
; ++i
)
2819 int enabled_before_p
= new_rows
[i
].enabled_p
;
2821 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2822 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2823 new_rows
[i
] = old_rows
[copy_from
[i
]];
2824 new_rows
[i
].enabled_p
= enabled_before_p
;
2826 /* RETAINED_P is zero for empty lines. */
2827 if (!retained_p
[copy_from
[i
]])
2828 new_rows
[i
].enabled_p
= 0;
2831 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2832 if (frame_matrix_frame
)
2833 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2834 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2838 /* Synchronize glyph pointers in the current matrix of window W with
2839 the current frame matrix. */
2842 sync_window_with_frame_matrix_rows (struct window
*w
)
2844 struct frame
*f
= XFRAME (w
->frame
);
2845 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2846 int left
, right
, x
, width
;
2848 /* Preconditions: W must be a leaf window on a tty frame. */
2849 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2850 eassert (!FRAME_WINDOW_P (f
));
2852 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2853 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2854 x
= w
->current_matrix
->matrix_x
;
2855 width
= w
->current_matrix
->matrix_w
;
2857 window_row
= w
->current_matrix
->rows
;
2858 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2859 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2861 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2863 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2864 = frame_row
->glyphs
[0] + x
;
2865 window_row
->glyphs
[TEXT_AREA
]
2866 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2867 window_row
->glyphs
[LAST_AREA
]
2868 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2869 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2870 = window_row
->glyphs
[LAST_AREA
] - right
;
2875 /* Return the window in the window tree rooted in W containing frame
2876 row ROW. Value is null if none is found. */
2878 static struct window
*
2879 frame_row_to_window (struct window
*w
, int row
)
2881 struct window
*found
= NULL
;
2885 if (!NILP (w
->hchild
))
2886 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2887 else if (!NILP (w
->vchild
))
2888 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2889 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2890 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2893 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2900 /* Perform a line dance in the window tree rooted at W, after
2901 scrolling a frame matrix in mirrored_line_dance.
2903 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2904 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2905 COPY_FROM is a vector containing, for each row I in the range 0 <=
2906 I < NLINES, the index of the original line to move to I. This
2907 index is relative to the row range, i.e. 0 <= index < NLINES.
2908 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2912 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2916 if (!NILP (w
->hchild
))
2917 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2918 nlines
, copy_from
, retained_p
);
2919 else if (!NILP (w
->vchild
))
2920 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2921 nlines
, copy_from
, retained_p
);
2924 /* W is a leaf window, and we are working on its current
2926 struct glyph_matrix
*m
= w
->current_matrix
;
2928 struct glyph_row
*old_rows
;
2930 /* Make a copy of the original rows of matrix m. */
2931 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2932 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2934 for (i
= 0; i
< nlines
; ++i
)
2936 /* Frame relative line assigned to. */
2937 int frame_to
= i
+ unchanged_at_top
;
2939 /* Frame relative line assigned. */
2940 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2942 /* Window relative line assigned to. */
2943 int window_to
= frame_to
- m
->matrix_y
;
2945 /* Window relative line assigned. */
2946 int window_from
= frame_from
- m
->matrix_y
;
2948 /* Is assigned line inside window? */
2949 int from_inside_window_p
2950 = window_from
>= 0 && window_from
< m
->matrix_h
;
2952 /* Is assigned to line inside window? */
2953 int to_inside_window_p
2954 = window_to
>= 0 && window_to
< m
->matrix_h
;
2956 if (from_inside_window_p
&& to_inside_window_p
)
2958 /* Enabled setting before assignment. */
2959 int enabled_before_p
;
2961 /* Do the assignment. The enabled_p flag is saved
2962 over the assignment because the old redisplay did
2964 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2965 m
->rows
[window_to
] = old_rows
[window_from
];
2966 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2968 /* If frame line is empty, window line is empty, too. */
2969 if (!retained_p
[copy_from
[i
]])
2970 m
->rows
[window_to
].enabled_p
= 0;
2972 else if (to_inside_window_p
)
2974 /* A copy between windows. This is an infrequent
2975 case not worth optimizing. */
2976 struct frame
*f
= XFRAME (w
->frame
);
2977 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2979 struct glyph_matrix
*m2
;
2982 w2
= frame_row_to_window (root
, frame_from
);
2983 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2984 -nw', FROM_FRAME sometimes has no associated window.
2985 This check avoids a segfault if W2 is null. */
2988 m2
= w2
->current_matrix
;
2989 m2_from
= frame_from
- m2
->matrix_y
;
2990 copy_row_except_pointers (m
->rows
+ window_to
,
2991 m2
->rows
+ m2_from
);
2993 /* If frame line is empty, window line is empty, too. */
2994 if (!retained_p
[copy_from
[i
]])
2995 m
->rows
[window_to
].enabled_p
= 0;
2999 else if (from_inside_window_p
)
3003 /* If there was a copy between windows, make sure glyph
3004 pointers are in sync with the frame matrix. */
3006 sync_window_with_frame_matrix_rows (w
);
3008 /* Check that no pointers are lost. */
3012 /* Next window on same level. */
3013 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3020 /* Check that window and frame matrices agree about their
3021 understanding where glyphs of the rows are to find. For each
3022 window in the window tree rooted at W, check that rows in the
3023 matrices of leaf window agree with their frame matrices about
3027 check_window_matrix_pointers (struct window
*w
)
3031 if (!NILP (w
->hchild
))
3032 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3033 else if (!NILP (w
->vchild
))
3034 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3037 struct frame
*f
= XFRAME (w
->frame
);
3038 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3039 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3042 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3047 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3048 a window and FRAME_MATRIX is the corresponding frame matrix. For
3049 each row in WINDOW_MATRIX check that it's a slice of the
3050 corresponding frame row. If it isn't, abort. */
3053 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3054 struct glyph_matrix
*frame_matrix
)
3056 /* Row number in WINDOW_MATRIX. */
3059 /* Row number corresponding to I in FRAME_MATRIX. */
3060 int j
= window_matrix
->matrix_y
;
3062 /* For all rows check that the row in the window matrix is a
3063 slice of the row in the frame matrix. If it isn't we didn't
3064 mirror an operation on the frame matrix correctly. */
3065 while (i
< window_matrix
->nrows
)
3067 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3068 frame_matrix
->rows
+ j
))
3074 #endif /* GLYPH_DEBUG */
3078 /**********************************************************************
3079 VPOS and HPOS translations
3080 **********************************************************************/
3084 /* Translate vertical position VPOS which is relative to window W to a
3085 vertical position relative to W's frame. */
3088 window_to_frame_vpos (struct window
*w
, int vpos
)
3090 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3091 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3092 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3093 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3098 /* Translate horizontal position HPOS which is relative to window W to
3099 a horizontal position relative to W's frame. */
3102 window_to_frame_hpos (struct window
*w
, int hpos
)
3104 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3105 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3109 #endif /* GLYPH_DEBUG */
3113 /**********************************************************************
3115 **********************************************************************/
3117 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3118 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3123 CHECK_LIVE_FRAME (frame
);
3126 /* Ignore redraw requests, if frame has no glyphs yet.
3127 (Implementation note: It still has to be checked why we are
3128 called so early here). */
3129 if (!glyphs_initialized_initially_p
)
3134 if (FRAME_MSDOS_P (f
))
3135 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3138 clear_current_matrices (f
);
3140 if (FRAME_TERMCAP_P (f
))
3141 fflush (FRAME_TTY (f
)->output
);
3142 windows_or_buffers_changed
++;
3143 /* Mark all windows as inaccurate, so that every window will have
3144 its redisplay done. */
3145 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3146 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3152 /* Redraw frame F. This is nothing more than a call to the Lisp
3153 function redraw-frame. */
3156 redraw_frame (struct frame
*f
)
3159 XSETFRAME (frame
, f
);
3160 Fredraw_frame (frame
);
3164 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3165 doc
: /* Clear and redisplay all visible frames. */)
3168 Lisp_Object tail
, frame
;
3170 FOR_EACH_FRAME (tail
, frame
)
3171 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3172 Fredraw_frame (frame
);
3179 /***********************************************************************
3181 ***********************************************************************/
3183 /* Update frame F based on the data in desired matrices.
3185 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3186 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3189 Value is non-zero if redisplay was stopped due to pending input. */
3192 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3194 /* 1 means display has been paused because of pending input. */
3196 struct window
*root_window
= XWINDOW (f
->root_window
);
3198 if (redisplay_dont_pause
)
3200 else if (NILP (Vredisplay_preemption_period
))
3202 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3205 double p
= XFLOATINT (Vredisplay_preemption_period
);
3207 if (detect_input_pending_ignore_squeezables ())
3213 EMACS_GET_TIME (tm
);
3214 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3215 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3218 if (FRAME_WINDOW_P (f
))
3220 /* We are working on window matrix basis. All windows whose
3221 flag must_be_updated_p is set have to be updated. */
3223 /* Record that we are not working on frame matrices. */
3224 set_frame_matrix_frame (NULL
);
3226 /* Update all windows in the window tree of F, maybe stopping
3227 when pending input is detected. */
3230 /* Update the menu bar on X frames that don't have toolkit
3232 if (WINDOWP (f
->menu_bar_window
))
3233 update_window (XWINDOW (f
->menu_bar_window
), 1);
3235 /* Update the tool-bar window, if present. */
3236 if (WINDOWP (f
->tool_bar_window
))
3238 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3240 /* Update tool-bar window. */
3241 if (w
->must_be_updated_p
)
3245 update_window (w
, 1);
3246 w
->must_be_updated_p
= 0;
3248 /* Swap tool-bar strings. We swap because we want to
3250 tem
= f
->current_tool_bar_string
;
3251 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3252 f
->desired_tool_bar_string
= tem
;
3257 /* Update windows. */
3258 paused_p
= update_window_tree (root_window
, force_p
);
3261 /* This flush is a performance bottleneck under X,
3262 and it doesn't seem to be necessary anyway (in general).
3263 It is necessary when resizing the window with the mouse, or
3264 at least the fringes are not redrawn in a timely manner. ++kfs */
3265 if (f
->force_flush_display_p
)
3267 FRAME_RIF (f
)->flush_display (f
);
3268 f
->force_flush_display_p
= 0;
3273 /* We are working on frame matrix basis. Set the frame on whose
3274 frame matrix we operate. */
3275 set_frame_matrix_frame (f
);
3277 /* Build F's desired matrix from window matrices. */
3278 build_frame_matrix (f
);
3280 /* Update the display */
3282 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3285 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3287 if (FRAME_TTY (f
)->termscript
)
3288 fflush (FRAME_TTY (f
)->termscript
);
3289 if (FRAME_TERMCAP_P (f
))
3290 fflush (FRAME_TTY (f
)->output
);
3293 /* Check window matrices for lost pointers. */
3295 check_window_matrix_pointers (root_window
);
3296 add_frame_display_history (f
, paused_p
);
3301 /* Reset flags indicating that a window should be updated. */
3302 set_window_update_flags (root_window
, 0);
3304 display_completed
= !paused_p
;
3310 /************************************************************************
3311 Window-based updates
3312 ************************************************************************/
3314 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3315 don't stop updating when input is pending. */
3318 update_window_tree (struct window
*w
, int force_p
)
3322 while (w
&& !paused_p
)
3324 if (!NILP (w
->hchild
))
3325 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3326 else if (!NILP (w
->vchild
))
3327 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3328 else if (w
->must_be_updated_p
)
3329 paused_p
|= update_window (w
, force_p
);
3331 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3338 /* Update window W if its flag must_be_updated_p is non-zero. If
3339 FORCE_P is non-zero, don't stop updating if input is pending. */
3342 update_single_window (struct window
*w
, int force_p
)
3344 if (w
->must_be_updated_p
)
3346 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3348 /* Record that this is not a frame-based redisplay. */
3349 set_frame_matrix_frame (NULL
);
3351 if (redisplay_dont_pause
)
3353 else if (NILP (Vredisplay_preemption_period
))
3355 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3358 double p
= XFLOATINT (Vredisplay_preemption_period
);
3360 EMACS_GET_TIME (tm
);
3361 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3362 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3367 update_window (w
, force_p
);
3370 /* Reset flag in W. */
3371 w
->must_be_updated_p
= 0;
3375 #ifdef HAVE_WINDOW_SYSTEM
3377 /* Redraw lines from the current matrix of window W that are
3378 overlapped by other rows. YB is bottom-most y-position in W. */
3381 redraw_overlapped_rows (struct window
*w
, int yb
)
3384 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3386 /* If rows overlapping others have been changed, the rows being
3387 overlapped have to be redrawn. This won't draw lines that have
3388 already been drawn in update_window_line because overlapped_p in
3389 desired rows is 0, so after row assignment overlapped_p in
3390 current rows is 0. */
3391 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3393 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3395 if (!row
->enabled_p
)
3397 else if (row
->mode_line_p
)
3400 if (row
->overlapped_p
)
3402 enum glyph_row_area area
;
3404 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3407 updated_area
= area
;
3408 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3409 area
== TEXT_AREA
? row
->x
: 0);
3410 if (row
->used
[area
])
3411 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3413 FRAME_RIF (f
)->clear_end_of_line (-1);
3416 row
->overlapped_p
= 0;
3419 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3425 /* Redraw lines from the current matrix of window W that overlap
3426 others. YB is bottom-most y-position in W. */
3429 redraw_overlapping_rows (struct window
*w
, int yb
)
3432 struct glyph_row
*row
;
3433 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3435 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3437 row
= w
->current_matrix
->rows
+ i
;
3439 if (!row
->enabled_p
)
3441 else if (row
->mode_line_p
)
3444 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3446 if (row
->overlapping_p
)
3450 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3451 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3452 overlaps
|= OVERLAPS_PRED
;
3453 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3454 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3455 overlaps
|= OVERLAPS_SUCC
;
3459 if (row
->used
[LEFT_MARGIN_AREA
])
3460 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3462 if (row
->used
[TEXT_AREA
])
3463 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3465 if (row
->used
[RIGHT_MARGIN_AREA
])
3466 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3468 /* Record in neighbor rows that ROW overwrites part of
3470 if (overlaps
& OVERLAPS_PRED
)
3471 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3472 if (overlaps
& OVERLAPS_SUCC
)
3473 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3482 #endif /* HAVE_WINDOW_SYSTEM */
3485 #if defined GLYPH_DEBUG && 0
3487 /* Check that no row in the current matrix of window W is enabled
3488 which is below what's displayed in the window. */
3491 check_current_matrix_flags (struct window
*w
)
3493 int last_seen_p
= 0;
3494 int i
, yb
= window_text_bottom_y (w
);
3496 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3498 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3499 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3501 else if (last_seen_p
&& row
->enabled_p
)
3506 #endif /* GLYPH_DEBUG */
3509 /* Update display of window W. FORCE_P non-zero means that we should
3510 not stop when detecting pending input. */
3513 update_window (struct window
*w
, int force_p
)
3515 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3517 #if !PERIODIC_PREEMPTION_CHECKING
3518 int preempt_count
= baud_rate
/ 2400 + 1;
3520 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3522 /* Check that W's frame doesn't have glyph matrices. */
3523 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3526 /* Check pending input the first time so that we can quickly return. */
3527 #if !PERIODIC_PREEMPTION_CHECKING
3529 detect_input_pending_ignore_squeezables ();
3532 /* If forced to complete the update, or if no input is pending, do
3534 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3536 struct glyph_row
*row
, *end
;
3537 struct glyph_row
*mode_line_row
;
3538 struct glyph_row
*header_line_row
;
3539 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3540 #if ! PERIODIC_PREEMPTION_CHECKING
3544 rif
->update_window_begin_hook (w
);
3545 yb
= window_text_bottom_y (w
);
3546 row
= desired_matrix
->rows
;
3547 end
= row
+ desired_matrix
->nrows
- 1;
3549 /* Take note of the header line, if there is one. We will
3550 update it below, after updating all of the window's lines. */
3551 if (row
->mode_line_p
)
3553 header_line_row
= row
;
3557 header_line_row
= NULL
;
3559 /* Update the mode line, if necessary. */
3560 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3561 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3563 mode_line_row
->y
= yb
;
3564 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3566 &mouse_face_overwritten_p
);
3569 /* Find first enabled row. Optimizations in redisplay_internal
3570 may lead to an update with only one row enabled. There may
3571 be also completely empty matrices. */
3572 while (row
< end
&& !row
->enabled_p
)
3575 /* Try reusing part of the display by copying. */
3576 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3578 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3581 /* All rows were found to be equal. */
3587 /* We've scrolled the display. */
3593 /* Update the rest of the lines. */
3594 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3595 /* scrolling_window resets the enabled_p flag of the rows it
3596 reuses from current_matrix. */
3599 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3602 /* We'll have to play a little bit with when to
3603 detect_input_pending. If it's done too often,
3604 scrolling large windows with repeated scroll-up
3605 commands will too quickly pause redisplay. */
3606 #if PERIODIC_PREEMPTION_CHECKING
3610 EMACS_GET_TIME (tm
);
3611 if (EMACS_TIME_LT (preemption_next_check
, tm
))
3613 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3614 if (detect_input_pending_ignore_squeezables ())
3619 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3620 detect_input_pending_ignore_squeezables ();
3622 changed_p
|= update_window_line (w
, vpos
,
3623 &mouse_face_overwritten_p
);
3625 /* Mark all rows below the last visible one in the current
3626 matrix as invalid. This is necessary because of
3627 variable line heights. Consider the case of three
3628 successive redisplays, where the first displays 5
3629 lines, the second 3 lines, and the third 5 lines again.
3630 If the second redisplay wouldn't mark rows in the
3631 current matrix invalid, the third redisplay might be
3632 tempted to optimize redisplay based on lines displayed
3633 in the first redisplay. */
3634 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3635 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3636 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3639 /* Was display preempted? */
3640 paused_p
= row
< end
;
3644 /* Update the header line after scrolling because a new header
3645 line would otherwise overwrite lines at the top of the window
3646 that can be scrolled. */
3647 if (header_line_row
&& header_line_row
->enabled_p
)
3649 header_line_row
->y
= 0;
3650 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3653 /* Fix the appearance of overlapping/overlapped rows. */
3654 if (!paused_p
&& !w
->pseudo_window_p
)
3656 #ifdef HAVE_WINDOW_SYSTEM
3657 if (changed_p
&& rif
->fix_overlapping_area
)
3659 redraw_overlapped_rows (w
, yb
);
3660 redraw_overlapping_rows (w
, yb
);
3664 /* Make cursor visible at cursor position of W. */
3665 set_window_cursor_after_update (w
);
3667 #if 0 /* Check that current matrix invariants are satisfied. This is
3668 for debugging only. See the comment of check_matrix_invariants. */
3669 IF_DEBUG (check_matrix_invariants (w
));
3674 /* Remember the redisplay method used to display the matrix. */
3675 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3678 #ifdef HAVE_WINDOW_SYSTEM
3679 update_window_fringes (w
, 0);
3682 /* End the update of window W. Don't set the cursor if we
3683 paused updating the display because in this case,
3684 set_window_cursor_after_update hasn't been called, and
3685 output_cursor doesn't contain the cursor location. */
3686 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3692 /* check_current_matrix_flags (w); */
3693 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3696 clear_glyph_matrix (desired_matrix
);
3702 /* Update the display of area AREA in window W, row number VPOS.
3703 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3706 update_marginal_area (struct window
*w
, int area
, int vpos
)
3708 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3709 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3711 /* Let functions in xterm.c know what area subsequent X positions
3712 will be relative to. */
3713 updated_area
= area
;
3715 /* Set cursor to start of glyphs, write them, and clear to the end
3716 of the area. I don't think that something more sophisticated is
3717 necessary here, since marginal areas will not be the default. */
3718 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3719 if (desired_row
->used
[area
])
3720 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3721 rif
->clear_end_of_line (-1);
3725 /* Update the display of the text area of row VPOS in window W.
3726 Value is non-zero if display has changed. */
3729 update_text_area (struct window
*w
, int vpos
)
3731 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3732 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3733 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3736 /* Let functions in xterm.c know what area subsequent X positions
3737 will be relative to. */
3738 updated_area
= TEXT_AREA
;
3740 /* If rows are at different X or Y, or rows have different height,
3741 or the current row is marked invalid, write the entire line. */
3742 if (!current_row
->enabled_p
3743 || desired_row
->y
!= current_row
->y
3744 || desired_row
->ascent
!= current_row
->ascent
3745 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3746 || desired_row
->phys_height
!= current_row
->phys_height
3747 || desired_row
->visible_height
!= current_row
->visible_height
3748 || current_row
->overlapped_p
3749 /* This next line is necessary for correctly redrawing
3750 mouse-face areas after scrolling and other operations.
3751 However, it causes excessive flickering when mouse is moved
3752 across the mode line. Luckily, turning it off for the mode
3753 line doesn't seem to hurt anything. -- cyd.
3754 But it is still needed for the header line. -- kfs. */
3755 || (current_row
->mouse_face_p
3756 && !(current_row
->mode_line_p
&& vpos
> 0))
3757 || current_row
->x
!= desired_row
->x
)
3759 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3761 if (desired_row
->used
[TEXT_AREA
])
3762 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3763 desired_row
->used
[TEXT_AREA
]);
3765 /* Clear to end of window. */
3766 rif
->clear_end_of_line (-1);
3769 /* This erases the cursor. We do this here because
3770 notice_overwritten_cursor cannot easily check this, which
3771 might indicate that the whole functionality of
3772 notice_overwritten_cursor would better be implemented here.
3773 On the other hand, we need notice_overwritten_cursor as long
3774 as mouse highlighting is done asynchronously outside of
3776 if (vpos
== w
->phys_cursor
.vpos
)
3777 w
->phys_cursor_on_p
= 0;
3782 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3783 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3784 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3785 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3786 int abort_skipping
= 0;
3788 /* If the desired row extends its face to the text area end, and
3789 unless the current row also does so at the same position,
3790 make sure we write at least one glyph, so that the face
3791 extension actually takes place. */
3792 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3793 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3794 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3795 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3798 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3802 /* Loop over glyphs that current and desired row may have
3806 int can_skip_p
= !abort_skipping
;
3808 /* Skip over glyphs that both rows have in common. These
3809 don't have to be written. We can't skip if the last
3810 current glyph overlaps the glyph to its right. For
3811 example, consider a current row of `if ' with the `f' in
3812 Courier bold so that it overlaps the ` ' to its right.
3813 If the desired row is ` ', we would skip over the space
3814 after the `if' and there would remain a pixel from the
3815 `f' on the screen. */
3816 if (overlapping_glyphs_p
&& i
> 0)
3818 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3821 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3823 can_skip_p
= (right
== 0 && !abort_skipping
);
3831 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3833 x
+= desired_glyph
->pixel_width
;
3834 ++desired_glyph
, ++current_glyph
, ++i
;
3837 /* Consider the case that the current row contains "xxx
3838 ppp ggg" in italic Courier font, and the desired row
3839 is "xxx ggg". The character `p' has lbearing, `g'
3840 has not. The loop above will stop in front of the
3841 first `p' in the current row. If we would start
3842 writing glyphs there, we wouldn't erase the lbearing
3843 of the `p'. The rest of the lbearing problem is then
3844 taken care of by draw_glyphs. */
3845 if (overlapping_glyphs_p
3847 && i
< current_row
->used
[TEXT_AREA
]
3848 && (current_row
->used
[TEXT_AREA
]
3849 != desired_row
->used
[TEXT_AREA
]))
3853 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3855 while (left
> 0 && i
> 0)
3857 --i
, --desired_glyph
, --current_glyph
;
3858 x
-= desired_glyph
->pixel_width
;
3859 left
-= desired_glyph
->pixel_width
;
3862 /* Abort the skipping algorithm if we end up before
3863 our starting point, to avoid looping (bug#1070).
3864 This can happen when the lbearing is larger than
3866 abort_skipping
= (i
< start_hpos
);
3870 /* Try to avoid writing the entire rest of the desired row
3871 by looking for a resync point. This mainly prevents
3872 mode line flickering in the case the mode line is in
3873 fixed-pitch font, which it usually will be. */
3874 if (i
< desired_row
->used
[TEXT_AREA
])
3876 int start_x
= x
, start_hpos
= i
;
3877 struct glyph
*start
= desired_glyph
;
3879 int skip_first_p
= !can_skip_p
;
3881 /* Find the next glyph that's equal again. */
3884 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3887 x
+= desired_glyph
->pixel_width
;
3888 current_x
+= current_glyph
->pixel_width
;
3889 ++desired_glyph
, ++current_glyph
, ++i
;
3893 if (i
== start_hpos
|| x
!= current_x
)
3897 desired_glyph
= start
;
3901 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3902 rif
->write_glyphs (start
, i
- start_hpos
);
3907 /* Write the rest. */
3908 if (i
< desired_row
->used
[TEXT_AREA
])
3910 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3911 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3915 /* Maybe clear to end of line. */
3916 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3918 /* If new row extends to the end of the text area, nothing
3919 has to be cleared, if and only if we did a write_glyphs
3920 above. This is made sure by setting desired_stop_pos
3921 appropriately above. */
3922 eassert (i
< desired_row
->used
[TEXT_AREA
]
3923 || ((desired_row
->used
[TEXT_AREA
]
3924 == current_row
->used
[TEXT_AREA
])
3925 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3927 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3929 /* If old row extends to the end of the text area, clear. */
3930 if (i
>= desired_row
->used
[TEXT_AREA
])
3931 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3932 desired_row
->pixel_width
);
3933 rif
->clear_end_of_line (-1);
3936 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3938 /* Otherwise clear to the end of the old row. Everything
3939 after that position should be clear already. */
3942 if (i
>= desired_row
->used
[TEXT_AREA
])
3943 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3944 desired_row
->pixel_width
);
3946 /* If cursor is displayed at the end of the line, make sure
3947 it's cleared. Nowadays we don't have a phys_cursor_glyph
3948 with which to erase the cursor (because this method
3949 doesn't work with lbearing/rbearing), so we must do it
3951 if (vpos
== w
->phys_cursor
.vpos
3952 && (desired_row
->reversed_p
3953 ? (w
->phys_cursor
.hpos
< 0)
3954 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3956 w
->phys_cursor_on_p
= 0;
3960 xlim
= current_row
->pixel_width
;
3961 rif
->clear_end_of_line (xlim
);
3970 /* Update row VPOS in window W. Value is non-zero if display has been
3974 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
3976 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3977 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3978 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3981 /* Set the row being updated. This is important to let xterm.c
3982 know what line height values are in effect. */
3983 updated_row
= desired_row
;
3985 /* A row can be completely invisible in case a desired matrix was
3986 built with a vscroll and then make_cursor_line_fully_visible shifts
3987 the matrix. Make sure to make such rows current anyway, since
3988 we need the correct y-position, for example, in the current matrix. */
3989 if (desired_row
->mode_line_p
3990 || desired_row
->visible_height
> 0)
3992 eassert (desired_row
->enabled_p
);
3994 /* Update display of the left margin area, if there is one. */
3995 if (!desired_row
->full_width_p
3996 && !NILP (w
->left_margin_cols
))
3999 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4002 /* Update the display of the text area. */
4003 if (update_text_area (w
, vpos
))
4006 if (current_row
->mouse_face_p
)
4007 *mouse_face_overwritten_p
= 1;
4010 /* Update display of the right margin area, if there is one. */
4011 if (!desired_row
->full_width_p
4012 && !NILP (w
->right_margin_cols
))
4015 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4018 /* Draw truncation marks etc. */
4019 if (!current_row
->enabled_p
4020 || desired_row
->y
!= current_row
->y
4021 || desired_row
->visible_height
!= current_row
->visible_height
4022 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4023 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4024 || current_row
->redraw_fringe_bitmaps_p
4025 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4026 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4027 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4028 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4029 rif
->after_update_window_line_hook (desired_row
);
4032 /* Update current_row from desired_row. */
4033 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4039 /* Set the cursor after an update of window W. This function may only
4040 be called from update_window. */
4043 set_window_cursor_after_update (struct window
*w
)
4045 struct frame
*f
= XFRAME (w
->frame
);
4046 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4047 int cx
, cy
, vpos
, hpos
;
4049 /* Not intended for frame matrix updates. */
4050 eassert (FRAME_WINDOW_P (f
));
4052 if (cursor_in_echo_area
4053 && !NILP (echo_area_buffer
[0])
4054 /* If we are showing a message instead of the mini-buffer,
4055 show the cursor for the message instead. */
4056 && XWINDOW (minibuf_window
) == w
4057 && EQ (minibuf_window
, echo_area_window
)
4058 /* These cases apply only to the frame that contains
4059 the active mini-buffer window. */
4060 && FRAME_HAS_MINIBUF_P (f
)
4061 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4063 cx
= cy
= vpos
= hpos
= 0;
4065 if (cursor_in_echo_area
>= 0)
4067 /* If the mini-buffer is several lines high, find the last
4068 line that has any text on it. Note: either all lines
4069 are enabled or none. Otherwise we wouldn't be able to
4071 struct glyph_row
*row
, *last_row
;
4072 struct glyph
*glyph
;
4073 int yb
= window_text_bottom_y (w
);
4076 row
= w
->current_matrix
->rows
;
4077 while (row
->enabled_p
4078 && (last_row
== NULL
4079 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4081 if (row
->used
[TEXT_AREA
]
4082 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4089 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4090 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4092 while (last
> start
&& last
->charpos
< 0)
4095 for (glyph
= start
; glyph
< last
; ++glyph
)
4097 cx
+= glyph
->pixel_width
;
4102 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4110 hpos
= w
->cursor
.hpos
;
4111 vpos
= w
->cursor
.vpos
;
4114 /* Window cursor can be out of sync for horizontally split windows. */
4115 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4116 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4117 vpos
= max (0, vpos
);
4118 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4119 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4123 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4124 tree rooted at W. */
4127 set_window_update_flags (struct window
*w
, int on_p
)
4131 if (!NILP (w
->hchild
))
4132 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4133 else if (!NILP (w
->vchild
))
4134 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4136 w
->must_be_updated_p
= on_p
;
4138 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4144 /***********************************************************************
4145 Window-Based Scrolling
4146 ***********************************************************************/
4148 /* Structure describing rows in scrolling_window. */
4152 /* Number of occurrences of this row in desired and current matrix. */
4153 int old_uses
, new_uses
;
4155 /* Vpos of row in new matrix. */
4156 int new_line_number
;
4158 /* Bucket index of this row_entry in the hash table row_table. */
4161 /* The row described by this entry. */
4162 struct glyph_row
*row
;
4164 /* Hash collision chain. */
4165 struct row_entry
*next
;
4168 /* A pool to allocate row_entry structures from, and the size of the
4169 pool. The pool is reallocated in scrolling_window when we find
4170 that we need a larger one. */
4172 static struct row_entry
*row_entry_pool
;
4173 static ptrdiff_t row_entry_pool_size
;
4175 /* Index of next free entry in row_entry_pool. */
4177 static ptrdiff_t row_entry_idx
;
4179 /* The hash table used during scrolling, and the table's size. This
4180 table is used to quickly identify equal rows in the desired and
4183 static struct row_entry
**row_table
;
4184 static ptrdiff_t row_table_size
;
4186 /* Vectors of pointers to row_entry structures belonging to the
4187 current and desired matrix, and the size of the vectors. */
4189 static struct row_entry
**old_lines
, **new_lines
;
4190 static ptrdiff_t old_lines_size
, new_lines_size
;
4192 /* A pool to allocate run structures from, and its size. */
4194 static struct run
*run_pool
;
4195 static ptrdiff_t runs_size
;
4197 /* A vector of runs of lines found during scrolling. */
4199 static struct run
**runs
;
4201 /* Add glyph row ROW to the scrolling hash table. */
4203 static inline struct row_entry
*
4204 add_row_entry (struct glyph_row
*row
)
4206 struct row_entry
*entry
;
4207 ptrdiff_t i
= row
->hash
% row_table_size
;
4209 entry
= row_table
[i
];
4210 eassert (entry
|| verify_row_hash (row
));
4211 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4212 entry
= entry
->next
;
4216 entry
= row_entry_pool
+ row_entry_idx
++;
4218 entry
->old_uses
= entry
->new_uses
= 0;
4219 entry
->new_line_number
= 0;
4221 entry
->next
= row_table
[i
];
4222 row_table
[i
] = entry
;
4229 /* Try to reuse part of the current display of W by scrolling lines.
4230 HEADER_LINE_P non-zero means W has a header line.
4232 The algorithm is taken from Communications of the ACM, Apr78 "A
4233 Technique for Isolating Differences Between Files." It should take
4236 A short outline of the steps of the algorithm
4238 1. Skip lines equal at the start and end of both matrices.
4240 2. Enter rows in the current and desired matrix into a symbol
4241 table, counting how often they appear in both matrices.
4243 3. Rows that appear exactly once in both matrices serve as anchors,
4244 i.e. we assume that such lines are likely to have been moved.
4246 4. Starting from anchor lines, extend regions to be scrolled both
4247 forward and backward.
4251 -1 if all rows were found to be equal.
4252 0 to indicate that we did not scroll the display, or
4253 1 if we did scroll. */
4256 scrolling_window (struct window
*w
, int header_line_p
)
4258 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4259 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4260 int yb
= window_text_bottom_y (w
);
4262 int j
, first_old
, first_new
, last_old
, last_new
;
4265 struct row_entry
*entry
;
4266 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4268 /* Skip over rows equal at the start. */
4269 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4271 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4272 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4276 && !d
->redraw_fringe_bitmaps_p
4278 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4279 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4280 && row_equal_p (c
, d
, 1))
4289 /* Give up if some rows in the desired matrix are not enabled. */
4290 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4293 first_old
= first_new
= i
;
4295 /* Set last_new to the index + 1 of the row that reaches the
4296 bottom boundary in the desired matrix. Give up if we find a
4297 disabled row before we reach the bottom boundary. */
4299 while (i
< desired_matrix
->nrows
- 1)
4303 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4305 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4314 /* Set last_old to the index + 1 of the row that reaches the bottom
4315 boundary in the current matrix. We don't look at the enabled
4316 flag here because we plan to reuse part of the display even if
4317 other parts are disabled. */
4319 while (i
< current_matrix
->nrows
- 1)
4321 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4330 /* Skip over rows equal at the bottom. */
4333 while (i
- 1 > first_new
4334 && j
- 1 > first_old
4335 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4336 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4337 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4338 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4339 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4340 MATRIX_ROW (current_matrix
, j
- 1), 1))
4345 /* Nothing to do if all rows are equal. */
4346 if (last_new
== first_new
)
4349 /* Check for integer overflow in size calculation.
4351 If next_almost_prime checks (N) for divisibility by 2..10, then
4352 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4353 So, set next_almost_prime_increment_max to 10.
4355 It's just a coincidence that next_almost_prime_increment_max ==
4356 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4357 13, then next_almost_prime_increment_max would be 14, e.g.,
4358 because next_almost_prime (113) would be 127. */
4360 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4361 enum { next_almost_prime_increment_max
= 10 };
4362 ptrdiff_t row_table_max
=
4363 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4364 - next_almost_prime_increment_max
);
4365 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4366 if (current_nrows_max
< current_matrix
->nrows
)
4367 memory_full (SIZE_MAX
);
4370 /* Reallocate vectors, tables etc. if necessary. */
4372 if (current_matrix
->nrows
> old_lines_size
)
4373 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4374 current_matrix
->nrows
- old_lines_size
,
4375 INT_MAX
, sizeof *old_lines
);
4377 if (desired_matrix
->nrows
> new_lines_size
)
4378 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4379 desired_matrix
->nrows
- new_lines_size
,
4380 INT_MAX
, sizeof *new_lines
);
4382 n
= desired_matrix
->nrows
;
4383 n
+= current_matrix
->nrows
;
4384 if (row_table_size
< 3 * n
)
4386 ptrdiff_t size
= next_almost_prime (3 * n
);
4387 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4388 row_table_size
= size
;
4389 memset (row_table
, 0, size
* sizeof *row_table
);
4392 if (n
> row_entry_pool_size
)
4393 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4394 n
- row_entry_pool_size
,
4395 -1, sizeof *row_entry_pool
);
4397 if (desired_matrix
->nrows
> runs_size
)
4399 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4400 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4401 runs_size
= desired_matrix
->nrows
;
4404 nruns
= run_idx
= 0;
4407 /* Add rows from the current and desired matrix to the hash table
4408 row_hash_table to be able to find equal ones quickly. */
4410 for (i
= first_old
; i
< last_old
; ++i
)
4412 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4414 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4415 old_lines
[i
] = entry
;
4419 old_lines
[i
] = NULL
;
4422 for (i
= first_new
; i
< last_new
; ++i
)
4424 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4425 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4427 entry
->new_line_number
= i
;
4428 new_lines
[i
] = entry
;
4431 /* Identify moves based on lines that are unique and equal
4432 in both matrices. */
4433 for (i
= first_old
; i
< last_old
;)
4435 && old_lines
[i
]->old_uses
== 1
4436 && old_lines
[i
]->new_uses
== 1)
4439 int new_line
= old_lines
[i
]->new_line_number
;
4440 struct run
*run
= run_pool
+ run_idx
++;
4443 run
->current_vpos
= i
;
4444 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4445 run
->desired_vpos
= new_line
;
4446 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4448 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4450 /* Extend backward. */
4453 while (p
> first_old
4455 && old_lines
[p
] == new_lines
[q
])
4457 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4458 --run
->current_vpos
;
4459 --run
->desired_vpos
;
4462 run
->desired_y
-= h
;
4463 run
->current_y
-= h
;
4467 /* Extend forward. */
4472 && old_lines
[p
] == new_lines
[q
])
4474 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4480 /* Insert run into list of all runs. Order runs by copied
4481 pixel lines. Note that we record runs that don't have to
4482 be copied because they are already in place. This is done
4483 because we can avoid calling update_window_line in this
4485 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4487 for (q
= nruns
; q
> p
; --q
)
4488 runs
[q
] = runs
[q
- 1];
4497 /* Do the moves. Do it in a way that we don't overwrite something
4498 we want to copy later on. This is not solvable in general
4499 because there is only one display and we don't have a way to
4500 exchange areas on this display. Example:
4502 +-----------+ +-----------+
4504 +-----------+ --> +-----------+
4506 +-----------+ +-----------+
4508 Instead, prefer bigger moves, and invalidate moves that would
4509 copy from where we copied to. */
4511 for (i
= 0; i
< nruns
; ++i
)
4512 if (runs
[i
]->nrows
> 0)
4514 struct run
*r
= runs
[i
];
4516 /* Copy on the display. */
4517 if (r
->current_y
!= r
->desired_y
)
4519 rif
->clear_window_mouse_face (w
);
4520 rif
->scroll_run_hook (w
, r
);
4523 /* Truncate runs that copy to where we copied to, and
4524 invalidate runs that copy from where we copied to. */
4525 for (j
= nruns
- 1; j
> i
; --j
)
4527 struct run
*p
= runs
[j
];
4528 int truncated_p
= 0;
4531 && p
->desired_y
< r
->desired_y
+ r
->height
4532 && p
->desired_y
+ p
->height
> r
->desired_y
)
4534 if (p
->desired_y
< r
->desired_y
)
4536 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4537 p
->height
= r
->desired_y
- p
->desired_y
;
4542 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4545 if (p
->nrows
<= nrows_copied
)
4549 int height_copied
= (r
->desired_y
+ r
->height
4552 p
->current_vpos
+= nrows_copied
;
4553 p
->desired_vpos
+= nrows_copied
;
4554 p
->nrows
-= nrows_copied
;
4555 p
->current_y
+= height_copied
;
4556 p
->desired_y
+= height_copied
;
4557 p
->height
-= height_copied
;
4563 if (r
->current_y
!= r
->desired_y
4564 /* The condition below is equivalent to
4565 ((p->current_y >= r->desired_y
4566 && p->current_y < r->desired_y + r->height)
4567 || (p->current_y + p->height > r->desired_y
4568 && (p->current_y + p->height
4569 <= r->desired_y + r->height)))
4570 because we have 0 < p->height <= r->height. */
4571 && p
->current_y
< r
->desired_y
+ r
->height
4572 && p
->current_y
+ p
->height
> r
->desired_y
)
4575 /* Reorder runs by copied pixel lines if truncated. */
4576 if (truncated_p
&& p
->nrows
> 0)
4580 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4582 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4587 /* Assign matrix rows. */
4588 for (j
= 0; j
< r
->nrows
; ++j
)
4590 struct glyph_row
*from
, *to
;
4591 int to_overlapped_p
;
4593 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4594 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4595 to_overlapped_p
= to
->overlapped_p
;
4596 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4597 assign_row (to
, from
);
4598 /* The above `assign_row' actually does swap, so if we had
4599 an overlap in the copy destination of two runs, then
4600 the second run would assign a previously disabled bogus
4601 row. But thanks to the truncation code in the
4602 preceding for-loop, we no longer have such an overlap,
4603 and thus the assigned row should always be enabled. */
4604 eassert (to
->enabled_p
);
4605 from
->enabled_p
= 0;
4606 to
->overlapped_p
= to_overlapped_p
;
4610 /* Clear the hash table, for the next time. */
4611 for (i
= 0; i
< row_entry_idx
; ++i
)
4612 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4614 /* Value is 1 to indicate that we scrolled the display. */
4620 /************************************************************************
4622 ************************************************************************/
4624 /* Update the desired frame matrix of frame F.
4626 FORCE_P non-zero means that the update should not be stopped by
4627 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4628 should not be tried.
4630 Value is non-zero if update was stopped due to pending input. */
4633 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4635 /* Frame matrices to work on. */
4636 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4637 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4640 int preempt_count
= baud_rate
/ 2400 + 1;
4642 eassert (current_matrix
&& desired_matrix
);
4644 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4645 calculate_costs (f
);
4647 if (preempt_count
<= 0)
4650 #if !PERIODIC_PREEMPTION_CHECKING
4651 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4658 /* If we cannot insert/delete lines, it's no use trying it. */
4659 if (!FRAME_LINE_INS_DEL_OK (f
))
4662 /* See if any of the desired lines are enabled; don't compute for
4663 i/d line if just want cursor motion. */
4664 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4665 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4668 /* Try doing i/d line, if not yet inhibited. */
4669 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4670 force_p
|= scrolling (f
);
4672 /* Update the individual lines as needed. Do bottom line first. */
4673 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4674 update_frame_line (f
, desired_matrix
->nrows
- 1);
4676 /* Now update the rest of the lines. */
4677 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4679 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4681 if (FRAME_TERMCAP_P (f
))
4683 /* Flush out every so many lines.
4684 Also flush out if likely to have more than 1k buffered
4685 otherwise. I'm told that some telnet connections get
4686 really screwed by more than 1k output at once. */
4687 FILE *display_output
= FRAME_TTY (f
)->output
;
4690 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4692 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4694 fflush (display_output
);
4695 if (preempt_count
== 1)
4697 #ifdef EMACS_OUTQSIZE
4698 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4699 /* Probably not a tty. Ignore the error and reset
4701 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4704 if (baud_rate
<= outq
&& baud_rate
> 0)
4705 sleep (outq
/ baud_rate
);
4711 #if PERIODIC_PREEMPTION_CHECKING
4715 EMACS_GET_TIME (tm
);
4716 if (EMACS_TIME_LT (preemption_next_check
, tm
))
4718 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4719 if (detect_input_pending_ignore_squeezables ())
4724 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4725 detect_input_pending_ignore_squeezables ();
4728 update_frame_line (f
, i
);
4732 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4734 /* Now just clean up termcap drivers and set cursor, etc. */
4737 if ((cursor_in_echo_area
4738 /* If we are showing a message instead of the mini-buffer,
4739 show the cursor for the message instead of for the
4740 (now hidden) mini-buffer contents. */
4741 || (EQ (minibuf_window
, selected_window
)
4742 && EQ (minibuf_window
, echo_area_window
)
4743 && !NILP (echo_area_buffer
[0])))
4744 /* These cases apply only to the frame that contains
4745 the active mini-buffer window. */
4746 && FRAME_HAS_MINIBUF_P (f
)
4747 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4749 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4752 if (cursor_in_echo_area
< 0)
4754 /* Negative value of cursor_in_echo_area means put
4755 cursor at beginning of line. */
4761 /* Positive value of cursor_in_echo_area means put
4762 cursor at the end of the prompt. If the mini-buffer
4763 is several lines high, find the last line that has
4765 row
= FRAME_LINES (f
);
4771 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4773 /* Frame rows are filled up with spaces that
4774 must be ignored here. */
4775 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4777 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4778 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4781 && (last
- 1)->charpos
< 0)
4787 while (row
> top
&& col
== 0);
4789 /* Make sure COL is not out of range. */
4790 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4792 /* If we have another row, advance cursor into it. */
4793 if (row
< FRAME_LINES (f
) - 1)
4795 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4798 /* Otherwise move it back in range. */
4800 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4804 cursor_to (f
, row
, col
);
4808 /* We have only one cursor on terminal frames. Use it to
4809 display the cursor of the selected window. */
4810 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4811 if (w
->cursor
.vpos
>= 0
4812 /* The cursor vpos may be temporarily out of bounds
4813 in the following situation: There is one window,
4814 with the cursor in the lower half of it. The window
4815 is split, and a message causes a redisplay before
4816 a new cursor position has been computed. */
4817 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4819 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4820 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4822 if (INTEGERP (w
->left_margin_cols
))
4823 x
+= XFASTINT (w
->left_margin_cols
);
4825 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4826 cursor_to (f
, y
, x
);
4831 #if !PERIODIC_PREEMPTION_CHECKING
4835 clear_desired_matrices (f
);
4840 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4843 scrolling (struct frame
*frame
)
4845 int unchanged_at_top
, unchanged_at_bottom
;
4848 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4849 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4850 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4851 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4853 int free_at_end_vpos
= FRAME_LINES (frame
);
4854 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4855 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4857 if (!current_matrix
)
4860 /* Compute hash codes of all the lines. Also calculate number of
4861 changed lines, number of unchanged lines at the beginning, and
4862 number of unchanged lines at the end. */
4864 unchanged_at_top
= 0;
4865 unchanged_at_bottom
= FRAME_LINES (frame
);
4866 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4868 /* Give up on this scrolling if some old lines are not enabled. */
4869 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4871 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4872 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4874 /* This line cannot be redrawn, so don't let scrolling mess it. */
4875 new_hash
[i
] = old_hash
[i
];
4876 #define INFINITY 1000000 /* Taken from scroll.c */
4877 draw_cost
[i
] = INFINITY
;
4881 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4882 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4885 if (old_hash
[i
] != new_hash
[i
])
4888 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4890 else if (i
== unchanged_at_top
)
4892 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4895 /* If changed lines are few, don't allow preemption, don't scroll. */
4896 if ((!FRAME_SCROLL_REGION_OK (frame
)
4897 && changed_lines
< baud_rate
/ 2400)
4898 || unchanged_at_bottom
== FRAME_LINES (frame
))
4901 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4902 - unchanged_at_bottom
);
4904 if (FRAME_SCROLL_REGION_OK (frame
))
4905 free_at_end_vpos
-= unchanged_at_bottom
;
4906 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4907 free_at_end_vpos
= -1;
4909 /* If large window, fast terminal and few lines in common between
4910 current frame and desired frame, don't bother with i/d calc. */
4911 if (!FRAME_SCROLL_REGION_OK (frame
)
4912 && window_size
>= 18 && baud_rate
> 2400
4914 10 * scrolling_max_lines_saved (unchanged_at_top
,
4915 FRAME_LINES (frame
) - unchanged_at_bottom
,
4916 old_hash
, new_hash
, draw_cost
)))
4919 if (window_size
< 2)
4922 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4923 draw_cost
+ unchanged_at_top
- 1,
4924 old_draw_cost
+ unchanged_at_top
- 1,
4925 old_hash
+ unchanged_at_top
- 1,
4926 new_hash
+ unchanged_at_top
- 1,
4927 free_at_end_vpos
- unchanged_at_top
);
4933 /* Count the number of blanks at the start of the vector of glyphs R
4934 which is LEN glyphs long. */
4937 count_blanks (struct glyph
*r
, int len
)
4941 for (i
= 0; i
< len
; ++i
)
4942 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4949 /* Count the number of glyphs in common at the start of the glyph
4950 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4951 of STR2. Value is the number of equal glyphs equal at the start. */
4954 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4956 struct glyph
*p1
= str1
;
4957 struct glyph
*p2
= str2
;
4961 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4968 /* Char insertion/deletion cost vector, from term.c */
4970 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4973 /* Perform a frame-based update on line VPOS in frame FRAME. */
4976 update_frame_line (struct frame
*f
, int vpos
)
4978 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4980 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4981 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4982 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4983 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4984 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4985 int must_write_whole_line_p
;
4986 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4987 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4988 != FACE_TTY_DEFAULT_BG_COLOR
);
4990 if (colored_spaces_p
)
4993 /* Current row not enabled means it has unknown contents. We must
4994 write the whole desired line in that case. */
4995 must_write_whole_line_p
= !current_row
->enabled_p
;
4996 if (must_write_whole_line_p
)
5003 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
5004 olen
= current_row
->used
[TEXT_AREA
];
5006 /* Ignore trailing spaces, if we can. */
5007 if (!write_spaces_p
)
5008 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
5012 current_row
->enabled_p
= 1;
5013 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
5015 /* If desired line is empty, just clear the line. */
5016 if (!desired_row
->enabled_p
)
5022 nbody
= desired_row
->glyphs
[TEXT_AREA
];
5023 nlen
= desired_row
->used
[TEXT_AREA
];
5024 nend
= nbody
+ nlen
;
5026 /* If display line has unknown contents, write the whole line. */
5027 if (must_write_whole_line_p
)
5029 /* Ignore spaces at the end, if we can. */
5030 if (!write_spaces_p
)
5031 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5034 /* Write the contents of the desired line. */
5037 cursor_to (f
, vpos
, 0);
5038 write_glyphs (f
, nbody
, nlen
);
5041 /* Don't call clear_end_of_line if we already wrote the whole
5042 line. The cursor will not be at the right margin in that
5043 case but in the line below. */
5044 if (nlen
< FRAME_TOTAL_COLS (f
))
5046 cursor_to (f
, vpos
, nlen
);
5047 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5050 /* Make sure we are in the right row, otherwise cursor movement
5051 with cmgoto might use `ch' in the wrong row. */
5052 cursor_to (f
, vpos
, 0);
5054 make_current (desired_matrix
, current_matrix
, vpos
);
5058 /* Pretend trailing spaces are not there at all,
5059 unless for one reason or another we must write all spaces. */
5060 if (!write_spaces_p
)
5061 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5064 /* If there's no i/d char, quickly do the best we can without it. */
5065 if (!FRAME_CHAR_INS_DEL_OK (f
))
5069 /* Find the first glyph in desired row that doesn't agree with
5070 a glyph in the current row, and write the rest from there on. */
5071 for (i
= 0; i
< nlen
; i
++)
5073 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5075 /* Find the end of the run of different glyphs. */
5079 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5080 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5083 /* Output this run of non-matching chars. */
5084 cursor_to (f
, vpos
, i
);
5085 write_glyphs (f
, nbody
+ i
, j
- i
);
5088 /* Now find the next non-match. */
5092 /* Clear the rest of the line, or the non-clear part of it. */
5095 cursor_to (f
, vpos
, nlen
);
5096 clear_end_of_line (f
, olen
);
5099 /* Make current row = desired row. */
5100 make_current (desired_matrix
, current_matrix
, vpos
);
5104 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5105 characters in a row. */
5109 /* If current line is blank, skip over initial spaces, if
5110 possible, and write the rest. */
5114 nsp
= count_blanks (nbody
, nlen
);
5118 cursor_to (f
, vpos
, nsp
);
5119 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5122 /* Exchange contents between current_frame and new_frame. */
5123 make_current (desired_matrix
, current_matrix
, vpos
);
5127 /* Compute number of leading blanks in old and new contents. */
5128 osp
= count_blanks (obody
, olen
);
5129 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5131 /* Compute number of matching chars starting with first non-blank. */
5132 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5133 nbody
+ nsp
, nbody
+ nlen
);
5135 /* Spaces in new match implicit space past the end of old. */
5136 /* A bug causing this to be a no-op was fixed in 18.29. */
5137 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5140 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5144 /* Avoid doing insert/delete char
5145 just cause number of leading spaces differs
5146 when the following text does not match. */
5147 if (begmatch
== 0 && osp
!= nsp
)
5148 osp
= nsp
= min (osp
, nsp
);
5150 /* Find matching characters at end of line */
5153 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5155 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5160 endmatch
= obody
+ olen
- op1
;
5162 /* tem gets the distance to insert or delete.
5163 endmatch is how many characters we save by doing so.
5166 tem
= (nlen
- nsp
) - (olen
- osp
);
5168 && (!FRAME_CHAR_INS_DEL_OK (f
)
5169 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5172 /* nsp - osp is the distance to insert or delete.
5173 If that is nonzero, begmatch is known to be nonzero also.
5174 begmatch + endmatch is how much we save by doing the ins/del.
5178 && (!FRAME_CHAR_INS_DEL_OK (f
)
5179 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5183 osp
= nsp
= min (osp
, nsp
);
5186 /* Now go through the line, inserting, writing and
5187 deleting as appropriate. */
5191 cursor_to (f
, vpos
, nsp
);
5192 delete_glyphs (f
, osp
- nsp
);
5196 /* If going to delete chars later in line
5197 and insert earlier in the line,
5198 must delete first to avoid losing data in the insert */
5199 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5201 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5202 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5203 olen
= nlen
- (nsp
- osp
);
5205 cursor_to (f
, vpos
, osp
);
5206 insert_glyphs (f
, 0, nsp
- osp
);
5210 tem
= nsp
+ begmatch
+ endmatch
;
5211 if (nlen
!= tem
|| olen
!= tem
)
5213 if (!endmatch
|| nlen
== olen
)
5215 /* If new text being written reaches right margin, there is
5216 no need to do clear-to-eol at the end of this function
5217 (and it would not be safe, since cursor is not going to
5218 be "at the margin" after the text is done). */
5219 if (nlen
== FRAME_TOTAL_COLS (f
))
5222 /* Function write_glyphs is prepared to do nothing
5223 if passed a length <= 0. Check it here to avoid
5224 unnecessary cursor movement. */
5227 cursor_to (f
, vpos
, nsp
+ begmatch
);
5228 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5231 else if (nlen
> olen
)
5233 /* Here, we used to have the following simple code:
5234 ----------------------------------------
5235 write_glyphs (nbody + nsp + begmatch, olen - tem);
5236 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5237 ----------------------------------------
5238 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5239 is a padding glyph. */
5240 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5243 cursor_to (f
, vpos
, nsp
+ begmatch
);
5245 /* Calculate columns we can actually overwrite. */
5246 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5248 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5250 /* If we left columns to be overwritten, we must delete them. */
5251 del
= olen
- tem
- out
;
5253 delete_glyphs (f
, del
);
5255 /* At last, we insert columns not yet written out. */
5256 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5259 else if (olen
> nlen
)
5261 cursor_to (f
, vpos
, nsp
+ begmatch
);
5262 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5263 delete_glyphs (f
, olen
- nlen
);
5269 /* If any unerased characters remain after the new line, erase them. */
5272 cursor_to (f
, vpos
, nlen
);
5273 clear_end_of_line (f
, olen
);
5276 /* Exchange contents between current_frame and new_frame. */
5277 make_current (desired_matrix
, current_matrix
, vpos
);
5282 /***********************************************************************
5283 X/Y Position -> Buffer Position
5284 ***********************************************************************/
5286 /* Determine what's under window-relative pixel position (*X, *Y).
5287 Return the OBJECT (string or buffer) that's there.
5288 Return in *POS the position in that object.
5289 Adjust *X and *Y to character positions.
5290 Return in *DX and *DY the pixel coordinates of the click,
5291 relative to the top left corner of OBJECT, or relative to
5292 the top left corner of the character glyph at (*X, *Y)
5294 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5295 if the coordinates point to an empty area of the display. */
5298 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
)
5301 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5302 struct text_pos startp
;
5304 struct glyph_row
*row
;
5305 #ifdef HAVE_WINDOW_SYSTEM
5306 struct image
*img
= 0;
5309 void *itdata
= NULL
;
5311 /* We used to set current_buffer directly here, but that does the
5312 wrong thing with `face-remapping-alist' (bug#2044). */
5313 Fset_buffer (w
->buffer
);
5314 itdata
= bidi_shelve_cache ();
5315 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5316 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5317 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5318 start_display (&it
, w
, startp
);
5319 /* start_display takes into account the header-line row, but IT's
5320 vpos still counts from the glyph row that includes the window's
5321 start position. Adjust for a possible header-line row. */
5322 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
5326 /* First, move to the beginning of the row corresponding to *Y. We
5327 need to be in that row to get the correct value of base paragraph
5328 direction for the text at (*X, *Y). */
5329 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5331 /* TO_X is the pixel position that the iterator will compute for the
5332 glyph at *X. We add it.first_visible_x because iterator
5333 positions include the hscroll. */
5334 to_x
= x0
+ it
.first_visible_x
;
5335 if (it
.bidi_it
.paragraph_dir
== R2L
)
5336 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5337 text area. This is because the iterator, even in R2L
5338 paragraphs, delivers glyphs as if they started at the left
5339 margin of the window. (When we actually produce glyphs for
5340 display, we reverse their order in PRODUCE_GLYPHS, but the
5341 iterator doesn't know about that.) The following line adjusts
5342 the pixel position to the iterator geometry, which is what
5343 move_it_* routines use. (The -1 is because in a window whose
5344 text-area width is W, the rightmost pixel position is W-1, and
5345 it should be mirrored into zero pixel position.) */
5346 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5348 /* Now move horizontally in the row to the glyph under *X. Second
5349 argument is ZV to prevent move_it_in_display_line from matching
5350 based on buffer positions. */
5351 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5352 bidi_unshelve_cache (itdata
, 0);
5354 Fset_buffer (old_current_buffer
);
5356 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5357 *dy
= *y
- it
.current_y
;
5360 if (STRINGP (it
.string
))
5363 if (it
.what
== IT_COMPOSITION
5364 && it
.cmp_it
.nchars
> 1
5365 && it
.cmp_it
.reversed_p
)
5367 /* The current display element is a grapheme cluster in a
5368 composition. In that case, we need the position of the first
5369 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5370 it.current points to the last character of the cluster, thus
5371 we must move back to the first character of the same
5373 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5374 if (STRINGP (it
.string
))
5375 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5377 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5378 CHARPOS (pos
->pos
));
5381 #ifdef HAVE_WINDOW_SYSTEM
5382 if (it
.what
== IT_IMAGE
)
5384 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5385 && !NILP (img
->spec
))
5386 *object
= img
->spec
;
5390 if (it
.vpos
< w
->current_matrix
->nrows
5391 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5394 if (it
.hpos
< row
->used
[TEXT_AREA
])
5396 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5397 #ifdef HAVE_WINDOW_SYSTEM
5400 *dy
-= row
->ascent
- glyph
->ascent
;
5401 *dx
+= glyph
->slice
.img
.x
;
5402 *dy
+= glyph
->slice
.img
.y
;
5403 /* Image slices positions are still relative to the entire image */
5404 *width
= img
->width
;
5405 *height
= img
->height
;
5410 *width
= glyph
->pixel_width
;
5411 *height
= glyph
->ascent
+ glyph
->descent
;
5417 *height
= row
->height
;
5422 *width
= *height
= 0;
5425 /* Add extra (default width) columns if clicked after EOL. */
5426 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5428 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5437 /* Value is the string under window-relative coordinates X/Y in the
5438 mode line or header line (PART says which) of window W, or nil if none.
5439 *CHARPOS is set to the position in the string returned. */
5442 mode_line_string (struct window
*w
, enum window_part part
,
5443 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5444 int *dx
, int *dy
, int *width
, int *height
)
5446 struct glyph_row
*row
;
5447 struct glyph
*glyph
, *end
;
5449 Lisp_Object string
= Qnil
;
5451 if (part
== ON_MODE_LINE
)
5452 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5454 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5456 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5458 if (row
->mode_line_p
&& row
->enabled_p
)
5460 /* Find the glyph under X. If we find one with a string object,
5461 it's the one we were looking for. */
5462 glyph
= row
->glyphs
[TEXT_AREA
];
5463 end
= glyph
+ row
->used
[TEXT_AREA
];
5464 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5465 x0
-= glyph
->pixel_width
;
5466 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5469 string
= glyph
->object
;
5470 *charpos
= glyph
->charpos
;
5471 *width
= glyph
->pixel_width
;
5472 *height
= glyph
->ascent
+ glyph
->descent
;
5473 #ifdef HAVE_WINDOW_SYSTEM
5474 if (glyph
->type
== IMAGE_GLYPH
)
5477 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5479 *object
= img
->spec
;
5480 y0
-= row
->ascent
- glyph
->ascent
;
5486 /* Add extra (default width) columns if clicked after EOL. */
5487 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5489 *height
= row
->height
;
5496 *width
= *height
= 0;
5506 /* Value is the string under window-relative coordinates X/Y in either
5507 marginal area, or nil if none. *CHARPOS is set to the position in
5508 the string returned. */
5511 marginal_area_string (struct window
*w
, enum window_part part
,
5512 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5513 int *dx
, int *dy
, int *width
, int *height
)
5515 struct glyph_row
*row
= w
->current_matrix
->rows
;
5516 struct glyph
*glyph
, *end
;
5517 int x0
, y0
, i
, wy
= *y
;
5519 Lisp_Object string
= Qnil
;
5521 if (part
== ON_LEFT_MARGIN
)
5522 area
= LEFT_MARGIN_AREA
;
5523 else if (part
== ON_RIGHT_MARGIN
)
5524 area
= RIGHT_MARGIN_AREA
;
5528 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5529 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5532 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5536 /* Find the glyph under X. If we find one with a string object,
5537 it's the one we were looking for. */
5538 if (area
== RIGHT_MARGIN_AREA
)
5539 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5540 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5541 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5542 + window_box_width (w
, LEFT_MARGIN_AREA
)
5543 + window_box_width (w
, TEXT_AREA
));
5545 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5546 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5549 glyph
= row
->glyphs
[area
];
5550 end
= glyph
+ row
->used
[area
];
5551 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5552 x0
-= glyph
->pixel_width
;
5553 *x
= glyph
- row
->glyphs
[area
];
5556 string
= glyph
->object
;
5557 *charpos
= glyph
->charpos
;
5558 *width
= glyph
->pixel_width
;
5559 *height
= glyph
->ascent
+ glyph
->descent
;
5560 #ifdef HAVE_WINDOW_SYSTEM
5561 if (glyph
->type
== IMAGE_GLYPH
)
5564 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5566 *object
= img
->spec
;
5567 y0
-= row
->ascent
- glyph
->ascent
;
5568 x0
+= glyph
->slice
.img
.x
;
5569 y0
+= glyph
->slice
.img
.y
;
5575 /* Add extra (default width) columns if clicked after EOL. */
5576 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5578 *height
= row
->height
;
5585 *width
= *height
= 0;
5595 /***********************************************************************
5596 Changing Frame Sizes
5597 ***********************************************************************/
5602 window_change_signal (int signalnum
) /* If we don't have an argument, */
5603 /* some compilers complain in signal calls. */
5606 int old_errno
= errno
;
5608 struct tty_display_info
*tty
;
5610 signal (SIGWINCH
, window_change_signal
);
5611 SIGNAL_THREAD_CHECK (signalnum
);
5613 /* The frame size change obviously applies to a single
5614 termcap-controlled terminal, but we can't decide which.
5615 Therefore, we resize the frames corresponding to each tty.
5617 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5619 if (! tty
->term_initted
)
5622 /* Suspended tty frames have tty->input == NULL avoid trying to
5627 get_tty_size (fileno (tty
->input
), &width
, &height
);
5629 if (width
> 5 && height
> 2) {
5630 Lisp_Object tail
, frame
;
5632 FOR_EACH_FRAME (tail
, frame
)
5633 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5634 /* Record the new sizes, but don't reallocate the data
5635 structures now. Let that be done later outside of the
5637 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5643 #endif /* SIGWINCH */
5646 /* Do any change in frame size that was requested by a signal. SAFE
5647 non-zero means this function is called from a place where it is
5648 safe to change frame sizes while a redisplay is in progress. */
5651 do_pending_window_change (int safe
)
5653 /* If window_change_signal should have run before, run it now. */
5654 if (redisplaying_p
&& !safe
)
5657 while (delayed_size_change
)
5659 Lisp_Object tail
, frame
;
5661 delayed_size_change
= 0;
5663 FOR_EACH_FRAME (tail
, frame
)
5665 struct frame
*f
= XFRAME (frame
);
5667 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5668 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5675 /* Change the frame height and/or width. Values may be given as zero to
5676 indicate no change is to take place.
5678 If DELAY is non-zero, then assume we're being called from a signal
5679 handler, and queue the change for later - perhaps the next
5680 redisplay. Since this tries to resize windows, we can't call it
5681 from a signal handler.
5683 SAFE non-zero means this function is called from a place where it's
5684 safe to change frame sizes while a redisplay is in progress. */
5687 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5689 Lisp_Object tail
, frame
;
5691 if (FRAME_MSDOS_P (f
))
5693 /* On MS-DOS, all frames use the same screen, so a change in
5694 size affects all frames. Termcap now supports multiple
5696 FOR_EACH_FRAME (tail
, frame
)
5697 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5698 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5699 pretend
, delay
, safe
);
5702 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5706 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5708 int new_frame_total_cols
;
5709 ptrdiff_t count
= SPECPDL_INDEX ();
5711 /* If we can't deal with the change now, queue it for later. */
5712 if (delay
|| (redisplaying_p
&& !safe
))
5714 f
->new_text_lines
= newheight
;
5715 f
->new_text_cols
= newwidth
;
5716 delayed_size_change
= 1;
5720 /* This size-change overrides any pending one for this frame. */
5721 f
->new_text_lines
= 0;
5722 f
->new_text_cols
= 0;
5724 /* If an argument is zero, set it to the current value. */
5726 newheight
= FRAME_LINES (f
);
5728 newwidth
= FRAME_COLS (f
);
5730 /* Compute width of windows in F. */
5731 /* Round up to the smallest acceptable size. */
5732 check_frame_size (f
, &newheight
, &newwidth
);
5734 /* This is the width of the frame with vertical scroll bars and fringe
5735 columns. Do this after rounding - see discussion of bug#9723. */
5736 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5738 /* If we're not changing the frame size, quit now. */
5739 /* Frame width may be unchanged but the text portion may change, for
5740 example, fullscreen and remove/add scroll bar. */
5741 if (newheight
== FRAME_LINES (f
)
5742 /* Text portion unchanged? */
5743 && newwidth
== FRAME_COLS (f
)
5744 /* Frame width unchanged? */
5745 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5751 /* We only can set screen dimensions to certain values supported
5752 by our video hardware. Try to find the smallest size greater
5753 or equal to the requested dimensions. */
5754 dos_set_window_size (&newheight
, &newwidth
);
5757 if (newheight
!= FRAME_LINES (f
))
5759 resize_frame_windows (f
, newheight
, 0);
5761 /* MSDOS frames cannot PRETEND, as they change frame size by
5762 manipulating video hardware. */
5763 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5764 FrameRows (FRAME_TTY (f
)) = newheight
;
5767 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5769 resize_frame_windows (f
, new_frame_total_cols
, 1);
5771 /* MSDOS frames cannot PRETEND, as they change frame size by
5772 manipulating video hardware. */
5773 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5774 FrameCols (FRAME_TTY (f
)) = newwidth
;
5776 if (WINDOWP (f
->tool_bar_window
))
5777 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5780 FRAME_LINES (f
) = newheight
;
5781 SET_FRAME_COLS (f
, newwidth
);
5784 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5785 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5787 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5789 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5790 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5791 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5792 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5796 calculate_costs (f
);
5797 SET_FRAME_GARBAGED (f
);
5802 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5804 run_window_configuration_change_hook (f
);
5806 unbind_to (count
, Qnil
);
5811 /***********************************************************************
5812 Terminal Related Lisp Functions
5813 ***********************************************************************/
5815 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5816 1, 1, "FOpen termscript file: ",
5817 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5818 FILE = nil means just close any termscript file currently open. */)
5821 struct tty_display_info
*tty
;
5823 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5824 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5825 error ("Current frame is not on a tty device");
5829 if (tty
->termscript
!= 0)
5832 fclose (tty
->termscript
);
5835 tty
->termscript
= 0;
5839 file
= Fexpand_file_name (file
, Qnil
);
5840 tty
->termscript
= fopen (SSDATA (file
), "w");
5841 if (tty
->termscript
== 0)
5842 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5848 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5849 Ssend_string_to_terminal
, 1, 2, 0,
5850 doc
: /* Send STRING to the terminal without alteration.
5851 Control characters in STRING will have terminal-dependent effects.
5853 Optional parameter TERMINAL specifies the tty terminal device to use.
5854 It may be a terminal object, a frame, or nil for the terminal used by
5855 the currently selected frame. In batch mode, STRING is sent to stdout
5856 when TERMINAL is nil. */)
5857 (Lisp_Object string
, Lisp_Object terminal
)
5859 struct terminal
*t
= get_terminal (terminal
, 1);
5862 /* ??? Perhaps we should do something special for multibyte strings here. */
5863 CHECK_STRING (string
);
5867 error ("Unknown terminal device");
5869 if (t
->type
== output_initial
)
5871 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5872 error ("Device %d is not a termcap terminal device", t
->id
);
5875 struct tty_display_info
*tty
= t
->display_info
.tty
;
5878 error ("Terminal is currently suspended");
5880 if (tty
->termscript
)
5882 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5883 fflush (tty
->termscript
);
5887 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5894 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5895 doc
: /* Beep, or flash the screen.
5896 Also, unless an argument is given,
5897 terminate any keyboard macro currently executing. */)
5905 ring_bell (XFRAME (selected_frame
));
5914 bitch_at_user (void)
5918 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5919 error ("Keyboard macro terminated by a command ringing the bell");
5921 ring_bell (XFRAME (selected_frame
));
5926 /***********************************************************************
5928 ***********************************************************************/
5930 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5931 doc
: /* Pause, without updating display, for SECONDS seconds.
5932 SECONDS may be a floating-point value, meaning that you can wait for a
5933 fraction of a second. Optional second arg MILLISECONDS specifies an
5934 additional wait period, in milliseconds; this is for backwards compatibility.
5935 \(Not all operating systems support waiting for a fraction of a second.) */)
5936 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5938 double duration
= extract_float (seconds
);
5940 if (!NILP (milliseconds
))
5942 CHECK_NUMBER (milliseconds
);
5943 duration
+= XINT (milliseconds
) / 1000.0;
5948 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5949 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5950 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5957 /* This is just like wait_reading_process_output, except that
5960 TIMEOUT is number of seconds to wait (float or integer),
5961 or t to wait forever.
5962 READING is 1 if reading input.
5963 If DO_DISPLAY is >0 display process output while waiting.
5964 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5968 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5973 swallow_events (do_display
);
5975 if ((detect_input_pending_run_timers (do_display
))
5976 || !NILP (Vexecuting_kbd_macro
))
5979 if (do_display
>= 2)
5980 redisplay_preserve_echo_area (2);
5982 if (INTEGERP (timeout
))
5984 sec
= XINT (timeout
);
5989 else if (FLOATP (timeout
))
5991 double seconds
= XFLOAT_DATA (timeout
);
5992 if (! (0 < seconds
))
5996 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5997 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5998 nsec
= EMACS_NSECS (t
);
6001 else if (EQ (timeout
, Qt
))
6007 wrong_type_argument (Qnumberp
, timeout
);
6014 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
6017 return detect_input_pending () ? Qnil
: Qt
;
6021 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
6022 doc
: /* Perform redisplay.
6023 Optional arg FORCE, if non-nil, prevents redisplay from being
6024 preempted by arriving input, even if `redisplay-dont-pause' is nil.
6025 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
6026 preempted by arriving input, so FORCE does nothing.
6028 Return t if redisplay was performed, nil if redisplay was preempted
6029 immediately by pending input. */)
6035 if ((detect_input_pending_run_timers (1)
6036 && NILP (force
) && !redisplay_dont_pause
)
6037 || !NILP (Vexecuting_kbd_macro
))
6040 count
= SPECPDL_INDEX ();
6041 if (!NILP (force
) && !redisplay_dont_pause
)
6042 specbind (Qredisplay_dont_pause
, Qt
);
6043 redisplay_preserve_echo_area (2);
6044 unbind_to (count
, Qnil
);
6050 /***********************************************************************
6051 Other Lisp Functions
6052 ***********************************************************************/
6054 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6055 session's frames, frame names, buffers, buffer-read-only flags, and
6056 buffer-modified-flags. */
6058 static Lisp_Object frame_and_buffer_state
;
6061 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6062 Sframe_or_buffer_changed_p
, 0, 1, 0,
6063 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6064 VARIABLE is a variable name whose value is either nil or a state vector
6065 that will be updated to contain all frames and buffers,
6066 aside from buffers whose names start with space,
6067 along with the buffers' read-only and modified flags. This allows a fast
6068 check to see whether buffer menus might need to be recomputed.
6069 If this function returns non-nil, it updates the internal vector to reflect
6072 If VARIABLE is nil, an internal variable is used. Users should not
6073 pass nil for VARIABLE. */)
6074 (Lisp_Object variable
)
6076 Lisp_Object state
, tail
, frame
, buf
;
6077 Lisp_Object
*vecp
, *end
;
6080 if (! NILP (variable
))
6082 CHECK_SYMBOL (variable
);
6083 state
= Fsymbol_value (variable
);
6084 if (! VECTORP (state
))
6088 state
= frame_and_buffer_state
;
6090 vecp
= XVECTOR (state
)->contents
;
6091 end
= vecp
+ ASIZE (state
);
6093 FOR_EACH_FRAME (tail
, frame
)
6097 if (!EQ (*vecp
++, frame
))
6101 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6104 /* Check that the buffer info matches. */
6105 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6107 buf
= XCDR (XCAR (tail
));
6108 /* Ignore buffers that aren't included in buffer lists. */
6109 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6113 if (!EQ (*vecp
++, buf
))
6117 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6121 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6126 /* Detect deletion of a buffer at the end of the list. */
6127 if (EQ (*vecp
, Qlambda
))
6130 /* Come here if we decide the data has changed. */
6132 /* Count the size we will need.
6133 Start with 1 so there is room for at least one lambda at the end. */
6135 FOR_EACH_FRAME (tail
, frame
)
6137 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6139 /* Reallocate the vector if data has grown to need it,
6140 or if it has shrunk a lot. */
6141 if (! VECTORP (state
)
6142 || n
> ASIZE (state
)
6143 || n
+ 20 < ASIZE (state
) / 2)
6144 /* Add 20 extra so we grow it less often. */
6146 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6147 if (! NILP (variable
))
6148 Fset (variable
, state
);
6150 frame_and_buffer_state
= state
;
6153 /* Record the new data in the (possibly reallocated) vector. */
6154 vecp
= XVECTOR (state
)->contents
;
6155 FOR_EACH_FRAME (tail
, frame
)
6158 *vecp
++ = XFRAME (frame
)->name
;
6160 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6162 buf
= XCDR (XCAR (tail
));
6163 /* Ignore buffers that aren't included in buffer lists. */
6164 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6167 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6168 *vecp
++ = Fbuffer_modified_p (buf
);
6170 /* Fill up the vector with lambdas (always at least one). */
6172 while (vecp
- XVECTOR (state
)->contents
6175 /* Make sure we didn't overflow the vector. */
6176 if (vecp
- XVECTOR (state
)->contents
6184 /***********************************************************************
6186 ***********************************************************************/
6188 /* Initialization done when Emacs fork is started, before doing stty.
6189 Determine terminal type and set terminal_driver. Then invoke its
6190 decoding routine to set up variables in the terminal package. */
6195 char *terminal_type
;
6197 /* Construct the space glyph. */
6198 space_glyph
.type
= CHAR_GLYPH
;
6199 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6200 space_glyph
.charpos
= -1;
6203 cursor_in_echo_area
= 0;
6204 terminal_type
= (char *) 0;
6206 /* Now is the time to initialize this; it's used by init_sys_modes
6208 Vinitial_window_system
= Qnil
;
6210 /* SIGWINCH needs to be handled no matter what display we start
6211 with. Otherwise newly opened tty frames will not resize
6216 #endif /* CANNOT_DUMP */
6217 signal (SIGWINCH
, window_change_signal
);
6218 #endif /* SIGWINCH */
6220 /* If running as a daemon, no need to initialize any frames/terminal. */
6224 /* If the user wants to use a window system, we shouldn't bother
6225 initializing the terminal. This is especially important when the
6226 terminal is so dumb that emacs gives up before and doesn't bother
6227 using the window system.
6229 If the DISPLAY environment variable is set and nonempty,
6230 try to use X, and die with an error message if that doesn't work. */
6232 #ifdef HAVE_X_WINDOWS
6233 if (! inhibit_window_system
&& ! display_arg
)
6236 display
= getenv ("DISPLAY");
6237 display_arg
= (display
!= 0 && *display
!= 0);
6239 if (display_arg
&& !x_display_ok (display
))
6241 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6243 inhibit_window_system
= 1;
6247 if (!inhibit_window_system
&& display_arg
)
6249 Vinitial_window_system
= Qx
;
6251 Vwindow_system_version
= make_number (11);
6254 /* In some versions of ncurses,
6255 tputs crashes if we have not called tgetent.
6257 { char b
[2044]; tgetent (b
, "xterm");}
6259 adjust_frame_glyphs_initially ();
6262 #endif /* HAVE_X_WINDOWS */
6265 if (!inhibit_window_system
)
6267 Vinitial_window_system
= Qw32
;
6268 Vwindow_system_version
= make_number (1);
6269 adjust_frame_glyphs_initially ();
6272 #endif /* HAVE_NTGUI */
6275 if (!inhibit_window_system
6281 Vinitial_window_system
= Qns
;
6282 Vwindow_system_version
= make_number (10);
6283 adjust_frame_glyphs_initially ();
6288 /* If no window system has been specified, try to use the terminal. */
6291 fatal ("standard input is not a tty");
6296 terminal_type
= "w32console";
6298 /* Look at the TERM variable. */
6299 terminal_type
= (char *) getenv ("TERM");
6303 #ifdef HAVE_WINDOW_SYSTEM
6304 if (! inhibit_window_system
)
6305 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6307 #endif /* HAVE_WINDOW_SYSTEM */
6308 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6314 struct frame
*f
= XFRAME (selected_frame
);
6316 /* Open a display on the controlling tty. */
6317 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6319 /* Convert the initial frame to use the new display. */
6320 if (f
->output_method
!= output_initial
)
6322 f
->output_method
= t
->type
;
6325 t
->reference_count
++;
6327 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6329 if (f
->output_method
== output_termcap
)
6330 create_tty_output (f
);
6332 t
->display_info
.tty
->top_frame
= selected_frame
;
6333 change_frame_size (XFRAME (selected_frame
),
6334 FrameRows (t
->display_info
.tty
),
6335 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6337 /* Delete the initial terminal. */
6338 if (--initial_terminal
->reference_count
== 0
6339 && initial_terminal
->delete_terminal_hook
)
6340 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6342 /* Update frame parameters to reflect the new type. */
6343 Fmodify_frame_parameters
6344 (selected_frame
, Fcons (Fcons (Qtty_type
,
6345 Ftty_type (selected_frame
)), Qnil
));
6346 if (t
->display_info
.tty
->name
)
6347 Fmodify_frame_parameters (selected_frame
,
6348 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6351 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6356 struct frame
*sf
= SELECTED_FRAME ();
6357 int width
= FRAME_TOTAL_COLS (sf
);
6358 int height
= FRAME_LINES (sf
);
6360 /* If these sizes are so big they cause overflow, just ignore the
6361 change. It's not clear what better we could do. The rest of
6362 the code assumes that (width + 2) * height * sizeof (struct glyph)
6363 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6364 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6365 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6366 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6367 < (width
+ 2) * height
))
6368 fatal ("screen size %dx%d too big", width
, height
);
6371 adjust_frame_glyphs_initially ();
6372 calculate_costs (XFRAME (selected_frame
));
6374 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6377 && NILP (Vinitial_window_system
))
6379 /* For the initial frame, we don't have any way of knowing what
6380 are the foreground and background colors of the terminal. */
6381 struct frame
*sf
= SELECTED_FRAME ();
6383 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6384 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6385 call0 (intern ("tty-set-up-initial-frame-faces"));
6391 /***********************************************************************
6393 ***********************************************************************/
6395 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6396 Sinternal_show_cursor
, 2, 2, 0,
6397 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6398 WINDOW nil means use the selected window. SHOW non-nil means
6399 show a cursor in WINDOW in the next redisplay. SHOW nil means
6400 don't show a cursor. */)
6401 (Lisp_Object window
, Lisp_Object show
)
6403 /* Don't change cursor state while redisplaying. This could confuse
6405 if (!redisplaying_p
)
6408 window
= selected_window
;
6410 CHECK_WINDOW (window
);
6412 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6419 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6420 Sinternal_show_cursor_p
, 0, 1, 0,
6421 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6422 WINDOW nil or omitted means report on the selected window. */)
6423 (Lisp_Object window
)
6428 window
= selected_window
;
6430 CHECK_WINDOW (window
);
6432 w
= XWINDOW (window
);
6433 return w
->cursor_off_p
? Qnil
: Qt
;
6436 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6437 Slast_nonminibuf_frame
, 0, 0, 0,
6438 doc
: /* Value is last nonminibuffer frame. */)
6441 Lisp_Object frame
= Qnil
;
6443 if (last_nonminibuf_frame
)
6444 XSETFRAME (frame
, last_nonminibuf_frame
);
6449 /***********************************************************************
6451 ***********************************************************************/
6454 syms_of_display (void)
6456 defsubr (&Sredraw_frame
);
6457 defsubr (&Sredraw_display
);
6458 defsubr (&Sframe_or_buffer_changed_p
);
6459 defsubr (&Sopen_termscript
);
6461 defsubr (&Sredisplay
);
6462 defsubr (&Ssleep_for
);
6463 defsubr (&Ssend_string_to_terminal
);
6464 defsubr (&Sinternal_show_cursor
);
6465 defsubr (&Sinternal_show_cursor_p
);
6466 defsubr (&Slast_nonminibuf_frame
);
6469 defsubr (&Sdump_redisplay_history
);
6472 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6473 staticpro (&frame_and_buffer_state
);
6475 DEFSYM (Qdisplay_table
, "display-table");
6476 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6478 DEFVAR_INT ("baud-rate", baud_rate
,
6479 doc
: /* The output baud rate of the terminal.
6480 On most systems, changing this value will affect the amount of padding
6481 and the other strategic decisions made during redisplay. */);
6483 DEFVAR_BOOL ("inverse-video", inverse_video
,
6484 doc
: /* Non-nil means invert the entire frame display.
6485 This means everything is in inverse video which otherwise would not be. */);
6487 DEFVAR_BOOL ("visible-bell", visible_bell
,
6488 doc
: /* Non-nil means try to flash the frame to represent a bell.
6490 See also `ring-bell-function'. */);
6492 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6493 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6494 A non-nil value is useful if the terminal can automatically preserve
6495 Emacs's frame display when you reenter Emacs.
6496 It is up to you to set this variable if your terminal can do that. */);
6498 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6499 doc
: /* Name of the window system that Emacs uses for the first frame.
6500 The value is a symbol:
6501 nil for a termcap frame (a character-only terminal),
6502 'x' for an Emacs frame that is really an X window,
6503 'w32' for an Emacs frame that is a window on MS-Windows display,
6504 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6505 'pc' for a direct-write MS-DOS frame.
6507 Use of this variable as a boolean is deprecated. Instead,
6508 use `display-graphic-p' or any of the other `display-*-p'
6509 predicates which report frame's specific UI-related capabilities. */);
6511 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6512 doc
: /* Name of window system through which the selected frame is displayed.
6513 The value is a symbol:
6514 nil for a termcap frame (a character-only terminal),
6515 'x' for an Emacs frame that is really an X window,
6516 'w32' for an Emacs frame that is a window on MS-Windows display,
6517 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6518 'pc' for a direct-write MS-DOS frame.
6520 Use of this variable as a boolean is deprecated. Instead,
6521 use `display-graphic-p' or any of the other `display-*-p'
6522 predicates which report frame's specific UI-related capabilities. */);
6524 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6525 doc
: /* The version number of the window system in use.
6526 For X windows, this is 11. */);
6528 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6529 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6531 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6532 doc
: /* Table defining how to output a glyph code to the frame.
6533 If not nil, this is a vector indexed by glyph code to define the glyph.
6534 Each element can be:
6535 integer: a glyph code which this glyph is an alias for.
6536 string: output this glyph using that string (not impl. in X windows).
6537 nil: this glyph mod 524288 is the code of a character to output,
6538 and this glyph / 524288 is the face number (see `face-id') to use
6539 while outputting it. */);
6540 Vglyph_table
= Qnil
;
6542 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6543 doc
: /* Display table to use for buffers that specify none.
6544 See `buffer-display-table' for more information. */);
6545 Vstandard_display_table
= Qnil
;
6547 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6548 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6549 redisplay_dont_pause
= 1;
6551 #if PERIODIC_PREEMPTION_CHECKING
6552 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6553 doc
: /* Period in seconds between checking for input during redisplay.
6554 This has an effect only if `redisplay-dont-pause' is nil; in that
6555 case, arriving input preempts redisplay until the input is processed.
6556 If the value is nil, redisplay is never preempted. */);
6557 Vredisplay_preemption_period
= make_float (0.10);
6564 Vinitial_window_system
= Qnil
;
6565 Vwindow_system_version
= Qnil
;