1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 /* cm.h must come after dispextern.h on Windows. */
30 #include "dispextern.h"
33 #include "character.h"
36 #include "termhooks.h"
41 #include "intervals.h"
42 #include "blockinput.h"
45 #include "syssignal.h"
49 #endif /* HAVE_X_WINDOWS */
53 #endif /* HAVE_NTGUI */
59 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
64 /* Get number of chars of output now in the buffer of a stdio stream.
65 This ought to be built in stdio, but it isn't. Some s- files
66 override this because their stdio internals differ. */
68 #ifdef __GNU_LIBRARY__
70 /* The s- file might have overridden the definition with one that
71 works for the system's C library. But we are using the GNU C
72 library, so this is the right definition for every system. */
74 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
75 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
77 #undef PENDING_OUTPUT_COUNT
78 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
80 #else /* not __GNU_LIBRARY__ */
81 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
82 #include <stdio_ext.h>
83 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
85 #ifndef PENDING_OUTPUT_COUNT
86 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
88 #endif /* not __GNU_LIBRARY__ */
90 #if defined (HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
91 #include <term.h> /* for tgetent */
94 /* Structure to pass dimensions around. Used for character bounding
95 boxes, glyph matrix dimensions and alike. */
104 /* Function prototypes. */
106 static void update_frame_line (struct frame
*, int);
107 static int required_matrix_height (struct window
*);
108 static int required_matrix_width (struct window
*);
109 static void adjust_frame_glyphs (struct frame
*);
110 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
111 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
112 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
113 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
115 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
117 static void adjust_frame_message_buffer (struct frame
*);
118 static void adjust_decode_mode_spec_buffer (struct frame
*);
119 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
120 static void clear_window_matrices (struct window
*, int);
121 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
122 static int scrolling_window (struct window
*, int);
123 static int update_window_line (struct window
*, int, int *);
124 static void mirror_make_current (struct window
*, int);
126 static void check_matrix_pointers (struct glyph_matrix
*,
127 struct glyph_matrix
*);
129 static void mirror_line_dance (struct window
*, int, int, int *, char *);
130 static int update_window_tree (struct window
*, int);
131 static int update_window (struct window
*, int);
132 static int update_frame_1 (struct frame
*, int, int);
133 static int scrolling (struct frame
*);
134 static void set_window_cursor_after_update (struct window
*);
135 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
136 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
139 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
140 are supported, so we can check for input during redisplay at
141 regular intervals. */
142 #ifdef EMACS_HAS_USECS
143 #define PERIODIC_PREEMPTION_CHECKING 1
145 #define PERIODIC_PREEMPTION_CHECKING 0
148 #if PERIODIC_PREEMPTION_CHECKING
150 /* Redisplay preemption timers. */
152 static EMACS_TIME preemption_period
;
153 static EMACS_TIME preemption_next_check
;
157 /* Nonzero upon entry to redisplay means do not assume anything about
158 current contents of actual terminal frame; clear and redraw it. */
162 /* Nonzero means last display completed. Zero means it was preempted. */
164 int display_completed
;
166 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
169 /* The currently selected frame. In a single-frame version, this
170 variable always equals the_only_frame. */
172 Lisp_Object selected_frame
;
174 /* A frame which is not just a mini-buffer, or 0 if there are no such
175 frames. This is usually the most recent such frame that was
176 selected. In a single-frame version, this variable always holds
177 the address of the_only_frame. */
179 struct frame
*last_nonminibuf_frame
;
181 /* 1 means SIGWINCH happened when not safe. */
183 static int delayed_size_change
;
185 /* 1 means glyph initialization has been completed at startup. */
187 static int glyphs_initialized_initially_p
;
189 /* Updated window if != 0. Set by update_window. */
191 struct window
*updated_window
;
193 /* Glyph row updated in update_window_line, and area that is updated. */
195 struct glyph_row
*updated_row
;
198 /* A glyph for a space. */
200 struct glyph space_glyph
;
202 /* Counts of allocated structures. These counts serve to diagnose
203 memory leaks and double frees. */
205 static int glyph_matrix_count
;
206 static int glyph_pool_count
;
208 /* If non-null, the frame whose frame matrices are manipulated. If
209 null, window matrices are worked on. */
211 static struct frame
*frame_matrix_frame
;
213 /* Non-zero means that fonts have been loaded since the last glyph
214 matrix adjustments. Redisplay must stop, and glyph matrices must
215 be adjusted when this flag becomes non-zero during display. The
216 reason fonts can be loaded so late is that fonts of fontsets are
217 loaded on demand. Another reason is that a line contains many
218 characters displayed by zero width or very narrow glyphs of
219 variable-width fonts. */
223 /* Convert vpos and hpos from frame to window and vice versa.
224 This may only be used for terminal frames. */
228 static int window_to_frame_vpos (struct window
*, int);
229 static int window_to_frame_hpos (struct window
*, int);
230 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
231 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
233 /* One element of the ring buffer containing redisplay history
236 struct redisplay_history
238 char trace
[512 + 100];
241 /* The size of the history buffer. */
243 #define REDISPLAY_HISTORY_SIZE 30
245 /* The redisplay history buffer. */
247 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
249 /* Next free entry in redisplay_history. */
251 static int history_idx
;
253 /* A tick that's incremented each time something is added to the
256 static uprintmax_t history_tick
;
258 static void add_frame_display_history (struct frame
*, int);
260 /* Add to the redisplay history how window W has been displayed.
261 MSG is a trace containing the information how W's glyph matrix
262 has been constructed. PAUSED_P non-zero means that the update
263 has been interrupted for pending input. */
266 add_window_display_history (struct window
*w
, const char *msg
, int paused_p
)
270 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
272 buf
= redisplay_history
[history_idx
].trace
;
275 snprintf (buf
, sizeof redisplay_history
[0].trace
,
276 "%"pMu
": window %p (`%s')%s\n%s",
279 ((BUFFERP (w
->buffer
)
280 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
281 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
283 paused_p
? " ***paused***" : "",
288 /* Add to the redisplay history that frame F has been displayed.
289 PAUSED_P non-zero means that the update has been interrupted for
293 add_frame_display_history (struct frame
*f
, int paused_p
)
297 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
299 buf
= redisplay_history
[history_idx
].trace
;
302 sprintf (buf
, "%"pMu
": update frame %p%s",
304 f
, paused_p
? " ***paused***" : "");
308 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
309 Sdump_redisplay_history
, 0, 0, "",
310 doc
: /* Dump redisplay history to stderr. */)
315 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
318 i
= REDISPLAY_HISTORY_SIZE
- 1;
319 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
326 #else /* GLYPH_DEBUG == 0 */
328 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
329 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
331 #endif /* GLYPH_DEBUG == 0 */
334 #if defined PROFILING && !HAVE___EXECUTABLE_START
335 /* FIXME: only used to find text start for profiling. */
338 safe_bcopy (const char *from
, char *to
, int size
)
344 /***********************************************************************
346 ***********************************************************************/
348 /* Allocate and return a glyph_matrix structure. POOL is the glyph
349 pool from which memory for the matrix should be allocated, or null
350 for window-based redisplay where no glyph pools are used. The
351 member `pool' of the glyph matrix structure returned is set to
352 POOL, the structure is otherwise zeroed. */
354 static struct glyph_matrix
*
355 new_glyph_matrix (struct glyph_pool
*pool
)
357 struct glyph_matrix
*result
;
359 /* Allocate and clear. */
360 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
361 memset (result
, 0, sizeof *result
);
363 /* Increment number of allocated matrices. This count is used
364 to detect memory leaks. */
365 ++glyph_matrix_count
;
367 /* Set pool and return. */
373 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
375 The global counter glyph_matrix_count is decremented when a matrix
376 is freed. If the count gets negative, more structures were freed
377 than allocated, i.e. one matrix was freed more than once or a bogus
378 pointer was passed to this function.
380 If MATRIX->pool is null, this means that the matrix manages its own
381 glyph memory---this is done for matrices on X frames. Freeing the
382 matrix also frees the glyph memory in this case. */
385 free_glyph_matrix (struct glyph_matrix
*matrix
)
391 /* Detect the case that more matrices are freed than were
393 if (--glyph_matrix_count
< 0)
396 /* Free glyph memory if MATRIX owns it. */
397 if (matrix
->pool
== NULL
)
398 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
399 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
401 /* Free row structures and the matrix itself. */
402 xfree (matrix
->rows
);
408 /* Return the number of glyphs to reserve for a marginal area of
409 window W. TOTAL_GLYPHS is the number of glyphs in a complete
410 display line of window W. MARGIN gives the width of the marginal
411 area in canonical character units. MARGIN should be an integer
415 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
419 if (NUMBERP (margin
))
421 int width
= XFASTINT (w
->total_cols
);
422 double d
= max (0, XFLOATINT (margin
));
423 d
= min (width
/ 2 - 1, d
);
424 n
= (int) ((double) total_glyphs
/ width
* d
);
433 /* Return non-zero if ROW's hash value is correct, zero if not. */
435 verify_row_hash (struct glyph_row
*row
)
437 return row
->hash
== row_hash (row
);
441 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
444 W is null if the function is called for a frame glyph matrix.
445 Otherwise it is the window MATRIX is a member of. X and Y are the
446 indices of the first column and row of MATRIX within the frame
447 matrix, if such a matrix exists. They are zero for purely
448 window-based redisplay. DIM is the needed size of the matrix.
450 In window-based redisplay, where no frame matrices exist, glyph
451 matrices manage their own glyph storage. Otherwise, they allocate
452 storage from a common frame glyph pool which can be found in
455 The reason for this memory management strategy is to avoid complete
456 frame redraws if possible. When we allocate from a common pool, a
457 change of the location or size of a sub-matrix within the pool
458 requires a complete redisplay of the frame because we cannot easily
459 make sure that the current matrices of all windows still agree with
460 what is displayed on the screen. While this is usually fast, it
461 leads to screen flickering. */
464 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
468 int marginal_areas_changed_p
= 0;
469 int header_line_changed_p
= 0;
470 int header_line_p
= 0;
471 int left
= -1, right
= -1;
472 int window_width
= -1, window_height
= -1;
474 /* See if W had a header line that has disappeared now, or vice versa.
478 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
480 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
481 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
483 matrix
->header_line_p
= header_line_p
;
485 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
486 Do nothing if MATRIX' size, position, vscroll, and marginal areas
487 haven't changed. This optimization is important because preserving
488 the matrix means preventing redisplay. */
489 if (matrix
->pool
== NULL
)
491 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
492 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
493 xassert (left
>= 0 && right
>= 0);
494 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
495 || right
!= matrix
->right_margin_glyphs
);
497 if (!marginal_areas_changed_p
499 && !header_line_changed_p
500 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
501 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
502 && matrix
->window_height
== window_height
503 && matrix
->window_vscroll
== w
->vscroll
504 && matrix
->window_width
== window_width
)
508 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
509 if (matrix
->rows_allocated
< dim
.height
)
511 int old_alloc
= matrix
->rows_allocated
;
512 new_rows
= dim
.height
- matrix
->rows_allocated
;
513 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
514 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
515 memset (matrix
->rows
+ old_alloc
, 0,
516 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
521 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
522 on a frame not using window-based redisplay. Set up pointers for
523 each row into the glyph pool. */
526 xassert (matrix
->pool
->glyphs
);
530 left
= margin_glyphs_to_reserve (w
, dim
.width
,
531 w
->left_margin_cols
);
532 right
= margin_glyphs_to_reserve (w
, dim
.width
,
533 w
->right_margin_cols
);
538 for (i
= 0; i
< dim
.height
; ++i
)
540 struct glyph_row
*row
= &matrix
->rows
[i
];
542 row
->glyphs
[LEFT_MARGIN_AREA
]
543 = (matrix
->pool
->glyphs
544 + (y
+ i
) * matrix
->pool
->ncolumns
548 || row
== matrix
->rows
+ dim
.height
- 1
549 || (row
== matrix
->rows
&& matrix
->header_line_p
))
551 row
->glyphs
[TEXT_AREA
]
552 = row
->glyphs
[LEFT_MARGIN_AREA
];
553 row
->glyphs
[RIGHT_MARGIN_AREA
]
554 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
555 row
->glyphs
[LAST_AREA
]
556 = row
->glyphs
[RIGHT_MARGIN_AREA
];
560 row
->glyphs
[TEXT_AREA
]
561 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
562 row
->glyphs
[RIGHT_MARGIN_AREA
]
563 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
564 row
->glyphs
[LAST_AREA
]
565 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
569 matrix
->left_margin_glyphs
= left
;
570 matrix
->right_margin_glyphs
= right
;
574 /* If MATRIX->pool is null, MATRIX is responsible for managing
575 its own memory. It is a window matrix for window-based redisplay.
576 Allocate glyph memory from the heap. */
577 if (dim
.width
> matrix
->matrix_w
579 || header_line_changed_p
580 || marginal_areas_changed_p
)
582 struct glyph_row
*row
= matrix
->rows
;
583 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
587 row
->glyphs
[LEFT_MARGIN_AREA
]
588 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
589 dim
.width
, sizeof (struct glyph
));
591 /* The mode line never has marginal areas. */
592 if (row
== matrix
->rows
+ dim
.height
- 1
593 || (row
== matrix
->rows
&& matrix
->header_line_p
))
595 row
->glyphs
[TEXT_AREA
]
596 = row
->glyphs
[LEFT_MARGIN_AREA
];
597 row
->glyphs
[RIGHT_MARGIN_AREA
]
598 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
599 row
->glyphs
[LAST_AREA
]
600 = row
->glyphs
[RIGHT_MARGIN_AREA
];
604 row
->glyphs
[TEXT_AREA
]
605 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
606 row
->glyphs
[RIGHT_MARGIN_AREA
]
607 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
608 row
->glyphs
[LAST_AREA
]
609 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
615 xassert (left
>= 0 && right
>= 0);
616 matrix
->left_margin_glyphs
= left
;
617 matrix
->right_margin_glyphs
= right
;
620 /* Number of rows to be used by MATRIX. */
621 matrix
->nrows
= dim
.height
;
622 xassert (matrix
->nrows
>= 0);
626 if (matrix
== w
->current_matrix
)
628 /* Mark rows in a current matrix of a window as not having
629 valid contents. It's important to not do this for
630 desired matrices. When Emacs starts, it may already be
631 building desired matrices when this function runs. */
632 if (window_width
< 0)
633 window_width
= window_box_width (w
, -1);
635 /* Optimize the case that only the height has changed (C-x 2,
636 upper window). Invalidate all rows that are no longer part
638 if (!marginal_areas_changed_p
639 && !header_line_changed_p
641 && dim
.width
== matrix
->matrix_w
642 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
643 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
644 && matrix
->window_width
== window_width
)
646 /* Find the last row in the window. */
647 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
648 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
654 /* Window end is invalid, if inside of the rows that
655 are invalidated below. */
656 if (INTEGERP (w
->window_end_vpos
)
657 && XFASTINT (w
->window_end_vpos
) >= i
)
658 w
->window_end_valid
= Qnil
;
660 while (i
< matrix
->nrows
)
661 matrix
->rows
[i
++].enabled_p
= 0;
665 for (i
= 0; i
< matrix
->nrows
; ++i
)
666 matrix
->rows
[i
].enabled_p
= 0;
669 else if (matrix
== w
->desired_matrix
)
671 /* Rows in desired matrices always have to be cleared;
672 redisplay expects this is the case when it runs, so it
673 had better be the case when we adjust matrices between
675 for (i
= 0; i
< matrix
->nrows
; ++i
)
676 matrix
->rows
[i
].enabled_p
= 0;
681 /* Remember last values to be able to optimize frame redraws. */
682 matrix
->matrix_x
= x
;
683 matrix
->matrix_y
= y
;
684 matrix
->matrix_w
= dim
.width
;
685 matrix
->matrix_h
= dim
.height
;
687 /* Record the top y location and height of W at the time the matrix
688 was last adjusted. This is used to optimize redisplay above. */
691 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
692 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
693 matrix
->window_height
= window_height
;
694 matrix
->window_width
= window_width
;
695 matrix
->window_vscroll
= w
->vscroll
;
700 /* Reverse the contents of rows in MATRIX between START and END. The
701 contents of the row at END - 1 end up at START, END - 2 at START +
702 1 etc. This is part of the implementation of rotate_matrix (see
706 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
710 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
712 /* Non-ISO HP/UX compiler doesn't like auto struct
714 struct glyph_row temp
;
715 temp
= matrix
->rows
[i
];
716 matrix
->rows
[i
] = matrix
->rows
[j
];
717 matrix
->rows
[j
] = temp
;
722 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
723 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
724 indices. (Note: this does not copy glyphs, only glyph pointers in
725 row structures are moved around).
727 The algorithm used for rotating the vector was, I believe, first
728 described by Kernighan. See the vector R as consisting of two
729 sub-vectors AB, where A has length BY for BY >= 0. The result
730 after rotating is then BA. Reverse both sub-vectors to get ArBr
731 and reverse the result to get (ArBr)r which is BA. Similar for
735 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
739 /* Up (rotate left, i.e. towards lower indices). */
741 reverse_rows (matrix
, first
, first
+ by
);
742 reverse_rows (matrix
, first
+ by
, last
);
743 reverse_rows (matrix
, first
, last
);
747 /* Down (rotate right, i.e. towards higher indices). */
748 reverse_rows (matrix
, last
- by
, last
);
749 reverse_rows (matrix
, first
, last
- by
);
750 reverse_rows (matrix
, first
, last
);
755 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
756 with indices START <= index < END. Increment positions by DELTA/
760 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
761 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
763 /* Check that START and END are reasonable values. */
764 xassert (start
>= 0 && start
<= matrix
->nrows
);
765 xassert (end
>= 0 && end
<= matrix
->nrows
);
766 xassert (start
<= end
);
768 for (; start
< end
; ++start
)
769 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
773 /* Enable a range of rows in glyph matrix MATRIX. START and END are
774 the row indices of the first and last + 1 row to enable. If
775 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
778 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
780 xassert (start
<= end
);
781 xassert (start
>= 0 && start
< matrix
->nrows
);
782 xassert (end
>= 0 && end
<= matrix
->nrows
);
784 for (; start
< end
; ++start
)
785 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
791 This empties all rows in MATRIX by setting the enabled_p flag for
792 all rows of the matrix to zero. The function prepare_desired_row
793 will eventually really clear a row when it sees one with a zero
796 Resets update hints to defaults value. The only update hint
797 currently present is the flag MATRIX->no_scrolling_p. */
800 clear_glyph_matrix (struct glyph_matrix
*matrix
)
804 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
805 matrix
->no_scrolling_p
= 0;
810 /* Shift part of the glyph matrix MATRIX of window W up or down.
811 Increment y-positions in glyph rows between START and END by DY,
812 and recompute their visible height. */
815 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
819 xassert (start
<= end
);
820 xassert (start
>= 0 && start
< matrix
->nrows
);
821 xassert (end
>= 0 && end
<= matrix
->nrows
);
823 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
824 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
826 for (; start
< end
; ++start
)
828 struct glyph_row
*row
= &matrix
->rows
[start
];
831 row
->visible_height
= row
->height
;
834 row
->visible_height
-= min_y
- row
->y
;
835 if (row
->y
+ row
->height
> max_y
)
836 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
837 if (row
->fringe_bitmap_periodic_p
)
838 row
->redraw_fringe_bitmaps_p
= 1;
843 /* Mark all rows in current matrices of frame F as invalid. Marking
844 invalid is done by setting enabled_p to zero for all rows in a
848 clear_current_matrices (register struct frame
*f
)
850 /* Clear frame current matrix, if we have one. */
851 if (f
->current_matrix
)
852 clear_glyph_matrix (f
->current_matrix
);
854 /* Clear the matrix of the menu bar window, if such a window exists.
855 The menu bar window is currently used to display menus on X when
856 no toolkit support is compiled in. */
857 if (WINDOWP (f
->menu_bar_window
))
858 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
860 /* Clear the matrix of the tool-bar window, if any. */
861 if (WINDOWP (f
->tool_bar_window
))
862 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
864 /* Clear current window matrices. */
865 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
866 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
870 /* Clear out all display lines of F for a coming redisplay. */
873 clear_desired_matrices (register struct frame
*f
)
875 if (f
->desired_matrix
)
876 clear_glyph_matrix (f
->desired_matrix
);
878 if (WINDOWP (f
->menu_bar_window
))
879 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
881 if (WINDOWP (f
->tool_bar_window
))
882 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
884 /* Do it for window matrices. */
885 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
886 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
890 /* Clear matrices in window tree rooted in W. If DESIRED_P is
891 non-zero clear desired matrices, otherwise clear current matrices. */
894 clear_window_matrices (struct window
*w
, int desired_p
)
898 if (!NILP (w
->hchild
))
900 xassert (WINDOWP (w
->hchild
));
901 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
903 else if (!NILP (w
->vchild
))
905 xassert (WINDOWP (w
->vchild
));
906 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
911 clear_glyph_matrix (w
->desired_matrix
);
914 clear_glyph_matrix (w
->current_matrix
);
915 w
->window_end_valid
= Qnil
;
919 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
925 /***********************************************************************
928 See dispextern.h for an overall explanation of glyph rows.
929 ***********************************************************************/
931 /* Clear glyph row ROW. Do it in a way that makes it robust against
932 changes in the glyph_row structure, i.e. addition or removal of
933 structure members. */
935 static struct glyph_row null_row
;
938 clear_glyph_row (struct glyph_row
*row
)
940 struct glyph
*p
[1 + LAST_AREA
];
943 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
944 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
945 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
946 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
951 /* Restore pointers. */
952 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
953 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
954 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
955 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
957 #if 0 /* At some point, some bit-fields of struct glyph were not set,
958 which made glyphs unequal when compared with GLYPH_EQUAL_P.
959 Redisplay outputs such glyphs, and flickering effects were
960 the result. This also depended on the contents of memory
961 returned by xmalloc. If flickering happens again, activate
962 the code below. If the flickering is gone with that, chances
963 are that the flickering has the same reason as here. */
964 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
969 /* Make ROW an empty, enabled row of canonical character height,
970 in window W starting at y-position Y. */
973 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
977 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
978 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
980 clear_glyph_row (row
);
982 row
->ascent
= row
->phys_ascent
= 0;
983 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
984 row
->visible_height
= row
->height
;
987 row
->visible_height
-= min_y
- row
->y
;
988 if (row
->y
+ row
->height
> max_y
)
989 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
995 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
996 are the amounts by which to change positions. Note that the first
997 glyph of the text area of a row can have a buffer position even if
998 the used count of the text area is zero. Such rows display line
1002 increment_row_positions (struct glyph_row
*row
,
1003 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
1007 /* Increment start and end positions. */
1008 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1009 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1010 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1011 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1012 CHARPOS (row
->start
.pos
) += delta
;
1013 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1014 CHARPOS (row
->end
.pos
) += delta
;
1015 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1017 if (!row
->enabled_p
)
1020 /* Increment positions in glyphs. */
1021 for (area
= 0; area
< LAST_AREA
; ++area
)
1022 for (i
= 0; i
< row
->used
[area
]; ++i
)
1023 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1024 && row
->glyphs
[area
][i
].charpos
> 0)
1025 row
->glyphs
[area
][i
].charpos
+= delta
;
1027 /* Capture the case of rows displaying a line end. */
1028 if (row
->used
[TEXT_AREA
] == 0
1029 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1030 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1035 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1036 contents, i.e. glyph structure contents are exchanged between A and
1037 B without changing glyph pointers in A and B. */
1040 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1044 for (area
= 0; area
< LAST_AREA
; ++area
)
1046 /* Number of glyphs to swap. */
1047 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1049 /* Start of glyphs in area of row A. */
1050 struct glyph
*glyph_a
= a
->glyphs
[area
];
1052 /* End + 1 of glyphs in area of row A. */
1053 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1055 /* Start of glyphs in area of row B. */
1056 struct glyph
*glyph_b
= b
->glyphs
[area
];
1058 while (glyph_a
< glyph_a_end
)
1060 /* Non-ISO HP/UX compiler doesn't like auto struct
1064 *glyph_a
= *glyph_b
;
1074 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1075 exchange the used[] array and the hash values of the rows, because
1076 these should all go together for the row's hash value to be
1080 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1083 unsigned hash_tem
= a
->hash
;
1085 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1087 struct glyph
*temp
= a
->glyphs
[i
];
1088 short used_tem
= a
->used
[i
];
1090 a
->glyphs
[i
] = b
->glyphs
[i
];
1091 b
->glyphs
[i
] = temp
;
1092 a
->used
[i
] = b
->used
[i
];
1093 b
->used
[i
] = used_tem
;
1100 /* Copy glyph row structure FROM to glyph row structure TO, except
1101 that glyph pointers, the `used' counts, and the hash values in the
1102 structures are left unchanged. */
1105 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1107 struct glyph
*pointers
[1 + LAST_AREA
];
1108 short used
[1 + LAST_AREA
];
1111 /* Save glyph pointers of TO. */
1112 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1113 memcpy (used
, to
->used
, sizeof to
->used
);
1116 /* Do a structure assignment. */
1119 /* Restore original pointers of TO. */
1120 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1121 memcpy (to
->used
, used
, sizeof to
->used
);
1126 /* Assign glyph row FROM to glyph row TO. This works like a structure
1127 assignment TO = FROM, except that glyph pointers are not copied but
1128 exchanged between TO and FROM. Pointers must be exchanged to avoid
1132 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1134 swap_glyph_pointers (to
, from
);
1135 copy_row_except_pointers (to
, from
);
1139 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1140 a row in a window matrix, is a slice of the glyph memory of the
1141 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1142 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1143 memory of FRAME_ROW. */
1148 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1150 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1151 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1152 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1154 return (frame_glyph_start
<= window_glyph_start
1155 && window_glyph_start
< frame_glyph_end
);
1158 #endif /* GLYPH_DEBUG */
1162 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1163 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1164 in WINDOW_MATRIX is found satisfying the condition. */
1166 static struct glyph_row
*
1167 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1168 struct glyph_matrix
*frame_matrix
, int row
)
1172 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1174 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1175 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1176 frame_matrix
->rows
+ row
))
1179 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1184 /* Prepare ROW for display. Desired rows are cleared lazily,
1185 i.e. they are only marked as to be cleared by setting their
1186 enabled_p flag to zero. When a row is to be displayed, a prior
1187 call to this function really clears it. */
1190 prepare_desired_row (struct glyph_row
*row
)
1192 if (!row
->enabled_p
)
1194 int rp
= row
->reversed_p
;
1196 clear_glyph_row (row
);
1198 row
->reversed_p
= rp
;
1203 /* Return a hash code for glyph row ROW. */
1206 line_hash_code (struct glyph_row
*row
)
1212 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1213 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1217 int c
= glyph
->u
.ch
;
1218 int face_id
= glyph
->face_id
;
1219 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1221 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1222 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1234 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1235 the number of characters in the line. If must_write_spaces is
1236 zero, leading and trailing spaces are ignored. */
1239 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1241 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1242 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1243 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1245 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1246 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1248 /* Ignore trailing and leading spaces if we can. */
1249 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1251 /* Skip from the end over trailing spaces. */
1252 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1255 /* All blank line. */
1259 /* Skip over leading spaces. */
1260 while (CHAR_GLYPH_SPACE_P (*beg
))
1264 /* If we don't have a glyph-table, each glyph is one character,
1265 so return the number of glyphs. */
1266 if (glyph_table_base
== 0)
1270 /* Otherwise, scan the glyphs and accumulate their total length
1277 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1279 if (GLYPH_INVALID_P (g
)
1280 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1283 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1293 /* Test two glyph rows A and B for equality. Value is non-zero if A
1294 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1295 mouse_face_p flags of A and B, too. */
1298 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1300 xassert (verify_row_hash (a
));
1301 xassert (verify_row_hash (b
));
1305 else if (a
->hash
!= b
->hash
)
1309 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1312 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1315 /* Compare glyphs. */
1316 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1318 if (a
->used
[area
] != b
->used
[area
])
1321 a_glyph
= a
->glyphs
[area
];
1322 a_end
= a_glyph
+ a
->used
[area
];
1323 b_glyph
= b
->glyphs
[area
];
1325 while (a_glyph
< a_end
1326 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1327 ++a_glyph
, ++b_glyph
;
1329 if (a_glyph
!= a_end
)
1333 if (a
->fill_line_p
!= b
->fill_line_p
1334 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1335 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1336 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1337 || a
->left_fringe_offset
!= b
->left_fringe_offset
1338 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1339 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1340 || a
->right_fringe_offset
!= b
->right_fringe_offset
1341 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1342 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1343 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1344 || a
->overlapped_p
!= b
->overlapped_p
1345 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1346 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1347 || a
->reversed_p
!= b
->reversed_p
1348 /* Different partially visible characters on left margin. */
1350 /* Different height. */
1351 || a
->ascent
!= b
->ascent
1352 || a
->phys_ascent
!= b
->phys_ascent
1353 || a
->phys_height
!= b
->phys_height
1354 || a
->visible_height
!= b
->visible_height
)
1363 /***********************************************************************
1366 See dispextern.h for an overall explanation of glyph pools.
1367 ***********************************************************************/
1369 /* Allocate a glyph_pool structure. The structure returned is
1370 initialized with zeros. The global variable glyph_pool_count is
1371 incremented for each pool allocated. */
1373 static struct glyph_pool
*
1374 new_glyph_pool (void)
1376 struct glyph_pool
*result
;
1378 /* Allocate a new glyph_pool and clear it. */
1379 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1380 memset (result
, 0, sizeof *result
);
1382 /* For memory leak and double deletion checking. */
1389 /* Free a glyph_pool structure POOL. The function may be called with
1390 a null POOL pointer. The global variable glyph_pool_count is
1391 decremented with every pool structure freed. If this count gets
1392 negative, more structures were freed than allocated, i.e. one
1393 structure must have been freed more than once or a bogus pointer
1394 was passed to free_glyph_pool. */
1397 free_glyph_pool (struct glyph_pool
*pool
)
1401 /* More freed than allocated? */
1403 xassert (glyph_pool_count
>= 0);
1405 xfree (pool
->glyphs
);
1411 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1412 columns we need. This function never shrinks a pool. The only
1413 case in which this would make sense, would be when a frame's size
1414 is changed from a large value to a smaller one. But, if someone
1415 does it once, we can expect that he will do it again.
1417 Value is non-zero if the pool changed in a way which makes
1418 re-adjusting window glyph matrices necessary. */
1421 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1426 changed_p
= (pool
->glyphs
== 0
1427 || matrix_dim
.height
!= pool
->nrows
1428 || matrix_dim
.width
!= pool
->ncolumns
);
1430 /* Enlarge the glyph pool. */
1431 needed
= matrix_dim
.width
;
1432 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1433 memory_full (SIZE_MAX
);
1434 needed
*= matrix_dim
.height
;
1435 if (needed
> pool
->nglyphs
)
1437 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1438 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1439 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1440 memset (pool
->glyphs
+ old_nglyphs
, 0,
1441 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1444 /* Remember the number of rows and columns because (a) we use them
1445 to do sanity checks, and (b) the number of columns determines
1446 where rows in the frame matrix start---this must be available to
1447 determine pointers to rows of window sub-matrices. */
1448 pool
->nrows
= matrix_dim
.height
;
1449 pool
->ncolumns
= matrix_dim
.width
;
1456 /***********************************************************************
1458 ***********************************************************************/
1463 /* Flush standard output. This is sometimes useful to call from the debugger.
1464 XXX Maybe this should be changed to flush the current terminal instead of
1468 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1477 /* Check that no glyph pointers have been lost in MATRIX. If a
1478 pointer has been lost, e.g. by using a structure assignment between
1479 rows, at least one pointer must occur more than once in the rows of
1483 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1487 for (i
= 0; i
< matrix
->nrows
; ++i
)
1488 for (j
= 0; j
< matrix
->nrows
; ++j
)
1490 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1491 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1495 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1498 matrix_row (struct glyph_matrix
*matrix
, int row
)
1500 xassert (matrix
&& matrix
->rows
);
1501 xassert (row
>= 0 && row
< matrix
->nrows
);
1503 /* That's really too slow for normal testing because this function
1504 is called almost everywhere. Although---it's still astonishingly
1505 fast, so it is valuable to have for debugging purposes. */
1507 check_matrix_pointer_lossage (matrix
);
1510 return matrix
->rows
+ row
;
1514 #if 0 /* This function makes invalid assumptions when text is
1515 partially invisible. But it might come handy for debugging
1518 /* Check invariants that must hold for an up to date current matrix of
1522 check_matrix_invariants (struct window
*w
)
1524 struct glyph_matrix
*matrix
= w
->current_matrix
;
1525 int yb
= window_text_bottom_y (w
);
1526 struct glyph_row
*row
= matrix
->rows
;
1527 struct glyph_row
*last_text_row
= NULL
;
1528 struct buffer
*saved
= current_buffer
;
1529 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1532 /* This can sometimes happen for a fresh window. */
1533 if (matrix
->nrows
< 2)
1536 set_buffer_temp (buffer
);
1538 /* Note: last row is always reserved for the mode line. */
1539 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1540 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1542 struct glyph_row
*next
= row
+ 1;
1544 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1545 last_text_row
= row
;
1547 /* Check that character and byte positions are in sync. */
1548 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1549 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1550 xassert (BYTEPOS (row
->start
.pos
)
1551 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1553 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1554 have such a position temporarily in case of a minibuffer
1555 displaying something like `[Sole completion]' at its end. */
1556 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1558 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1559 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1560 xassert (BYTEPOS (row
->end
.pos
)
1561 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1564 /* Check that end position of `row' is equal to start position
1566 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1568 xassert (MATRIX_ROW_END_CHARPOS (row
)
1569 == MATRIX_ROW_START_CHARPOS (next
));
1570 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1571 == MATRIX_ROW_START_BYTEPOS (next
));
1572 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1573 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1578 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1579 xassert (w
->desired_matrix
->rows
!= NULL
);
1580 set_buffer_temp (saved
);
1585 #endif /* GLYPH_DEBUG != 0 */
1589 /**********************************************************************
1590 Allocating/ Adjusting Glyph Matrices
1591 **********************************************************************/
1593 /* Allocate glyph matrices over a window tree for a frame-based
1596 X and Y are column/row within the frame glyph matrix where
1597 sub-matrices for the window tree rooted at WINDOW must be
1598 allocated. DIM_ONLY_P non-zero means that the caller of this
1599 function is only interested in the result matrix dimension, and
1600 matrix adjustments should not be performed.
1602 The function returns the total width/height of the sub-matrices of
1603 the window tree. If called on a frame root window, the computation
1604 will take the mini-buffer window into account.
1606 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1608 NEW_LEAF_MATRIX set if any window in the tree did not have a
1609 glyph matrices yet, and
1611 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1612 any window in the tree will be changed or have been changed (see
1615 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1618 Windows are arranged into chains of windows on the same level
1619 through the next fields of window structures. Such a level can be
1620 either a sequence of horizontally adjacent windows from left to
1621 right, or a sequence of vertically adjacent windows from top to
1622 bottom. Each window in a horizontal sequence can be either a leaf
1623 window or a vertical sequence; a window in a vertical sequence can
1624 be either a leaf or a horizontal sequence. All windows in a
1625 horizontal sequence have the same height, and all windows in a
1626 vertical sequence have the same width.
1628 This function uses, for historical reasons, a more general
1629 algorithm to determine glyph matrix dimensions that would be
1632 The matrix height of a horizontal sequence is determined by the
1633 maximum height of any matrix in the sequence. The matrix width of
1634 a horizontal sequence is computed by adding up matrix widths of
1635 windows in the sequence.
1637 |<------- result width ------->|
1638 +---------+----------+---------+ ---
1641 +---------+ | | result height
1646 The matrix width of a vertical sequence is the maximum matrix width
1647 of any window in the sequence. Its height is computed by adding up
1648 matrix heights of windows in the sequence.
1650 |<---- result width -->|
1658 +------------+---------+ |
1661 +------------+---------+ --- */
1663 /* Bit indicating that a new matrix will be allocated or has been
1666 #define NEW_LEAF_MATRIX (1 << 0)
1668 /* Bit indicating that a matrix will or has changed its location or
1671 #define CHANGED_LEAF_MATRIX (1 << 1)
1674 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1675 int dim_only_p
, int *window_change_flags
)
1677 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1679 int wmax
= 0, hmax
= 0;
1683 int in_horz_combination_p
;
1685 /* What combination is WINDOW part of? Compute this once since the
1686 result is the same for all windows in the `next' chain. The
1687 special case of a root window (parent equal to nil) is treated
1688 like a vertical combination because a root window's `next'
1689 points to the mini-buffer window, if any, which is arranged
1690 vertically below other windows. */
1691 in_horz_combination_p
1692 = (!NILP (XWINDOW (window
)->parent
)
1693 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1695 /* For WINDOW and all windows on the same level. */
1698 w
= XWINDOW (window
);
1700 /* Get the dimension of the window sub-matrix for W, depending
1701 on whether this is a combination or a leaf window. */
1702 if (!NILP (w
->hchild
))
1703 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1705 window_change_flags
);
1706 else if (!NILP (w
->vchild
))
1707 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1709 window_change_flags
);
1712 /* If not already done, allocate sub-matrix structures. */
1713 if (w
->desired_matrix
== NULL
)
1715 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1716 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1717 *window_change_flags
|= NEW_LEAF_MATRIX
;
1720 /* Width and height MUST be chosen so that there are no
1721 holes in the frame matrix. */
1722 dim
.width
= required_matrix_width (w
);
1723 dim
.height
= required_matrix_height (w
);
1725 /* Will matrix be re-allocated? */
1726 if (x
!= w
->desired_matrix
->matrix_x
1727 || y
!= w
->desired_matrix
->matrix_y
1728 || dim
.width
!= w
->desired_matrix
->matrix_w
1729 || dim
.height
!= w
->desired_matrix
->matrix_h
1730 || (margin_glyphs_to_reserve (w
, dim
.width
,
1731 w
->left_margin_cols
)
1732 != w
->desired_matrix
->left_margin_glyphs
)
1733 || (margin_glyphs_to_reserve (w
, dim
.width
,
1734 w
->right_margin_cols
)
1735 != w
->desired_matrix
->right_margin_glyphs
))
1736 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1738 /* Actually change matrices, if allowed. Do not consider
1739 CHANGED_LEAF_MATRIX computed above here because the pool
1740 may have been changed which we don't now here. We trust
1741 that we only will be called with DIM_ONLY_P != 0 when
1745 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1746 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1750 /* If we are part of a horizontal combination, advance x for
1751 windows to the right of W; otherwise advance y for windows
1753 if (in_horz_combination_p
)
1758 /* Remember maximum glyph matrix dimensions. */
1759 wmax
= max (wmax
, dim
.width
);
1760 hmax
= max (hmax
, dim
.height
);
1762 /* Next window on same level. */
1765 while (!NILP (window
));
1767 /* Set `total' to the total glyph matrix dimension of this window
1768 level. In a vertical combination, the width is the width of the
1769 widest window; the height is the y we finally reached, corrected
1770 by the y we started with. In a horizontal combination, the total
1771 height is the height of the tallest window, and the width is the
1772 x we finally reached, corrected by the x we started with. */
1773 if (in_horz_combination_p
)
1775 total
.width
= x
- x0
;
1776 total
.height
= hmax
;
1781 total
.height
= y
- y0
;
1788 /* Return the required height of glyph matrices for window W. */
1791 required_matrix_height (struct window
*w
)
1793 #ifdef HAVE_WINDOW_SYSTEM
1794 struct frame
*f
= XFRAME (w
->frame
);
1796 if (FRAME_WINDOW_P (f
))
1798 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1799 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1800 return (((window_pixel_height
+ ch_height
- 1)
1801 / ch_height
) * w
->nrows_scale_factor
1802 /* One partially visible line at the top and
1803 bottom of the window. */
1805 /* 2 for header and mode line. */
1808 #endif /* HAVE_WINDOW_SYSTEM */
1810 return WINDOW_TOTAL_LINES (w
);
1814 /* Return the required width of glyph matrices for window W. */
1817 required_matrix_width (struct window
*w
)
1819 #ifdef HAVE_WINDOW_SYSTEM
1820 struct frame
*f
= XFRAME (w
->frame
);
1821 if (FRAME_WINDOW_P (f
))
1823 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1824 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1826 /* Compute number of glyphs needed in a glyph row. */
1827 return (((window_pixel_width
+ ch_width
- 1)
1828 / ch_width
) * w
->ncols_scale_factor
1829 /* 2 partially visible columns in the text area. */
1831 /* One partially visible column at the right
1832 edge of each marginal area. */
1835 #endif /* HAVE_WINDOW_SYSTEM */
1837 return XINT (w
->total_cols
);
1841 /* Allocate window matrices for window-based redisplay. W is the
1842 window whose matrices must be allocated/reallocated. */
1845 allocate_matrices_for_window_redisplay (struct window
*w
)
1849 if (!NILP (w
->vchild
))
1850 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1851 else if (!NILP (w
->hchild
))
1852 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1855 /* W is a leaf window. */
1858 /* If matrices are not yet allocated, allocate them now. */
1859 if (w
->desired_matrix
== NULL
)
1861 w
->desired_matrix
= new_glyph_matrix (NULL
);
1862 w
->current_matrix
= new_glyph_matrix (NULL
);
1865 dim
.width
= required_matrix_width (w
);
1866 dim
.height
= required_matrix_height (w
);
1867 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1868 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1871 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1876 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1877 do it for all frames; otherwise do it just for the given frame.
1878 This function must be called when a new frame is created, its size
1879 changes, or its window configuration changes. */
1882 adjust_glyphs (struct frame
*f
)
1884 /* Block input so that expose events and other events that access
1885 glyph matrices are not processed while we are changing them. */
1889 adjust_frame_glyphs (f
);
1892 Lisp_Object tail
, lisp_frame
;
1894 FOR_EACH_FRAME (tail
, lisp_frame
)
1895 adjust_frame_glyphs (XFRAME (lisp_frame
));
1902 /* Adjust frame glyphs when Emacs is initialized.
1904 To be called from init_display.
1906 We need a glyph matrix because redraw will happen soon.
1907 Unfortunately, window sizes on selected_frame are not yet set to
1908 meaningful values. I believe we can assume that there are only two
1909 windows on the frame---the mini-buffer and the root window. Frame
1910 height and width seem to be correct so far. So, set the sizes of
1911 windows to estimated values. */
1914 adjust_frame_glyphs_initially (void)
1916 struct frame
*sf
= SELECTED_FRAME ();
1917 struct window
*root
= XWINDOW (sf
->root_window
);
1918 struct window
*mini
= XWINDOW (root
->next
);
1919 int frame_lines
= FRAME_LINES (sf
);
1920 int frame_cols
= FRAME_COLS (sf
);
1921 int top_margin
= FRAME_TOP_MARGIN (sf
);
1923 /* Do it for the root window. */
1924 XSETFASTINT (root
->top_line
, top_margin
);
1925 XSETFASTINT (root
->total_lines
, frame_lines
- 1 - top_margin
);
1926 XSETFASTINT (root
->total_cols
, frame_cols
);
1928 /* Do it for the mini-buffer window. */
1929 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1930 XSETFASTINT (mini
->total_lines
, 1);
1931 XSETFASTINT (mini
->total_cols
, frame_cols
);
1933 adjust_frame_glyphs (sf
);
1934 glyphs_initialized_initially_p
= 1;
1938 /* Allocate/reallocate glyph matrices of a single frame F. */
1941 adjust_frame_glyphs (struct frame
*f
)
1943 if (FRAME_WINDOW_P (f
))
1944 adjust_frame_glyphs_for_window_redisplay (f
);
1946 adjust_frame_glyphs_for_frame_redisplay (f
);
1948 /* Don't forget the message buffer and the buffer for
1949 decode_mode_spec. */
1950 adjust_frame_message_buffer (f
);
1951 adjust_decode_mode_spec_buffer (f
);
1953 f
->glyphs_initialized_p
= 1;
1956 /* Return 1 if any window in the tree has nonzero window margins. See
1957 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1959 showing_window_margins_p (struct window
*w
)
1963 if (!NILP (w
->hchild
))
1965 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1968 else if (!NILP (w
->vchild
))
1970 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1973 else if (!NILP (w
->left_margin_cols
)
1974 || !NILP (w
->right_margin_cols
))
1977 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1983 /* In the window tree with root W, build current matrices of leaf
1984 windows from the frame's current matrix. */
1987 fake_current_matrices (Lisp_Object window
)
1991 for (; !NILP (window
); window
= w
->next
)
1993 w
= XWINDOW (window
);
1995 if (!NILP (w
->hchild
))
1996 fake_current_matrices (w
->hchild
);
1997 else if (!NILP (w
->vchild
))
1998 fake_current_matrices (w
->vchild
);
2002 struct frame
*f
= XFRAME (w
->frame
);
2003 struct glyph_matrix
*m
= w
->current_matrix
;
2004 struct glyph_matrix
*fm
= f
->current_matrix
;
2006 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
2007 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
2009 for (i
= 0; i
< m
->matrix_h
; ++i
)
2011 struct glyph_row
*r
= m
->rows
+ i
;
2012 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2014 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2015 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2017 r
->enabled_p
= fr
->enabled_p
;
2020 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2021 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2022 r
->used
[TEXT_AREA
] = (m
->matrix_w
2023 - r
->used
[LEFT_MARGIN_AREA
]
2024 - r
->used
[RIGHT_MARGIN_AREA
]);
2033 /* Save away the contents of frame F's current frame matrix. Value is
2034 a glyph matrix holding the contents of F's current frame matrix. */
2036 static struct glyph_matrix
*
2037 save_current_matrix (struct frame
*f
)
2040 struct glyph_matrix
*saved
;
2042 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2043 memset (saved
, 0, sizeof *saved
);
2044 saved
->nrows
= f
->current_matrix
->nrows
;
2045 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2046 * sizeof *saved
->rows
);
2047 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2049 for (i
= 0; i
< saved
->nrows
; ++i
)
2051 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2052 struct glyph_row
*to
= saved
->rows
+ i
;
2053 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2054 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2055 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2056 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2063 /* Restore the contents of frame F's current frame matrix from SAVED,
2064 and free memory associated with SAVED. */
2067 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2071 for (i
= 0; i
< saved
->nrows
; ++i
)
2073 struct glyph_row
*from
= saved
->rows
+ i
;
2074 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2075 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2076 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2077 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2078 xfree (from
->glyphs
[TEXT_AREA
]);
2081 xfree (saved
->rows
);
2087 /* Allocate/reallocate glyph matrices of a single frame F for
2088 frame-based redisplay. */
2091 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2093 struct dim matrix_dim
;
2095 int window_change_flags
;
2098 if (!FRAME_LIVE_P (f
))
2101 top_window_y
= FRAME_TOP_MARGIN (f
);
2103 /* Allocate glyph pool structures if not already done. */
2104 if (f
->desired_pool
== NULL
)
2106 f
->desired_pool
= new_glyph_pool ();
2107 f
->current_pool
= new_glyph_pool ();
2110 /* Allocate frames matrix structures if needed. */
2111 if (f
->desired_matrix
== NULL
)
2113 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2114 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2117 /* Compute window glyph matrices. (This takes the mini-buffer
2118 window into account). The result is the size of the frame glyph
2119 matrix needed. The variable window_change_flags is set to a bit
2120 mask indicating whether new matrices will be allocated or
2121 existing matrices change their size or location within the frame
2123 window_change_flags
= 0;
2125 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2128 &window_change_flags
);
2130 /* Add in menu bar lines, if any. */
2131 matrix_dim
.height
+= top_window_y
;
2133 /* Enlarge pools as necessary. */
2134 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2135 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2137 /* Set up glyph pointers within window matrices. Do this only if
2138 absolutely necessary since it requires a frame redraw. */
2139 if (pool_changed_p
|| window_change_flags
)
2141 /* Do it for window matrices. */
2142 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2144 &window_change_flags
);
2146 /* Size of frame matrices must equal size of frame. Note
2147 that we are called for X frames with window widths NOT equal
2148 to the frame width (from CHANGE_FRAME_SIZE_1). */
2149 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2150 && matrix_dim
.height
== FRAME_LINES (f
));
2152 /* Pointers to glyph memory in glyph rows are exchanged during
2153 the update phase of redisplay, which means in general that a
2154 frame's current matrix consists of pointers into both the
2155 desired and current glyph pool of the frame. Adjusting a
2156 matrix sets the frame matrix up so that pointers are all into
2157 the same pool. If we want to preserve glyph contents of the
2158 current matrix over a call to adjust_glyph_matrix, we must
2159 make a copy of the current glyphs, and restore the current
2160 matrix' contents from that copy. */
2161 if (display_completed
2162 && !FRAME_GARBAGED_P (f
)
2163 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2164 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2165 /* For some reason, the frame glyph matrix gets corrupted if
2166 any of the windows contain margins. I haven't been able
2167 to hunt down the reason, but for the moment this prevents
2168 the problem from manifesting. -- cyd */
2169 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2171 struct glyph_matrix
*copy
= save_current_matrix (f
);
2172 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2173 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2174 restore_current_matrix (f
, copy
);
2175 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2179 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2180 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2181 SET_FRAME_GARBAGED (f
);
2187 /* Allocate/reallocate glyph matrices of a single frame F for
2188 window-based redisplay. */
2191 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2193 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2195 /* Allocate/reallocate window matrices. */
2196 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2198 #ifdef HAVE_X_WINDOWS
2199 /* Allocate/ reallocate matrices of the dummy window used to display
2200 the menu bar under X when no X toolkit support is available. */
2201 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2203 /* Allocate a dummy window if not already done. */
2205 if (NILP (f
->menu_bar_window
))
2207 f
->menu_bar_window
= make_window ();
2208 w
= XWINDOW (f
->menu_bar_window
);
2209 XSETFRAME (w
->frame
, f
);
2210 w
->pseudo_window_p
= 1;
2213 w
= XWINDOW (f
->menu_bar_window
);
2215 /* Set window dimensions to frame dimensions and allocate or
2216 adjust glyph matrices of W. */
2217 XSETFASTINT (w
->top_line
, 0);
2218 XSETFASTINT (w
->left_col
, 0);
2219 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2220 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2221 allocate_matrices_for_window_redisplay (w
);
2223 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2224 #endif /* HAVE_X_WINDOWS */
2228 /* Allocate/ reallocate matrices of the tool bar window. If we
2229 don't have a tool bar window yet, make one. */
2231 if (NILP (f
->tool_bar_window
))
2233 f
->tool_bar_window
= make_window ();
2234 w
= XWINDOW (f
->tool_bar_window
);
2235 XSETFRAME (w
->frame
, f
);
2236 w
->pseudo_window_p
= 1;
2239 w
= XWINDOW (f
->tool_bar_window
);
2241 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2242 XSETFASTINT (w
->left_col
, 0);
2243 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2244 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2245 allocate_matrices_for_window_redisplay (w
);
2251 /* Adjust/ allocate message buffer of frame F.
2253 Note that the message buffer is never freed. Since I could not
2254 find a free in 19.34, I assume that freeing it would be
2255 problematic in some way and don't do it either.
2257 (Implementation note: It should be checked if we can free it
2258 eventually without causing trouble). */
2261 adjust_frame_message_buffer (struct frame
*f
)
2263 ptrdiff_t size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2265 if (FRAME_MESSAGE_BUF (f
))
2267 char *buffer
= FRAME_MESSAGE_BUF (f
);
2268 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2269 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2272 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2276 /* Re-allocate buffer for decode_mode_spec on frame F. */
2279 adjust_decode_mode_spec_buffer (struct frame
*f
)
2281 f
->decode_mode_spec_buffer
2282 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2283 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2288 /**********************************************************************
2289 Freeing Glyph Matrices
2290 **********************************************************************/
2292 /* Free glyph memory for a frame F. F may be null. This function can
2293 be called for the same frame more than once. The root window of
2294 F may be nil when this function is called. This is the case when
2295 the function is called when F is destroyed. */
2298 free_glyphs (struct frame
*f
)
2300 if (f
&& f
->glyphs_initialized_p
)
2302 /* Block interrupt input so that we don't get surprised by an X
2303 event while we're in an inconsistent state. */
2305 f
->glyphs_initialized_p
= 0;
2307 /* Release window sub-matrices. */
2308 if (!NILP (f
->root_window
))
2309 free_window_matrices (XWINDOW (f
->root_window
));
2311 /* Free the dummy window for menu bars without X toolkit and its
2313 if (!NILP (f
->menu_bar_window
))
2315 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2316 free_glyph_matrix (w
->desired_matrix
);
2317 free_glyph_matrix (w
->current_matrix
);
2318 w
->desired_matrix
= w
->current_matrix
= NULL
;
2319 f
->menu_bar_window
= Qnil
;
2322 /* Free the tool bar window and its glyph matrices. */
2323 if (!NILP (f
->tool_bar_window
))
2325 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2326 free_glyph_matrix (w
->desired_matrix
);
2327 free_glyph_matrix (w
->current_matrix
);
2328 w
->desired_matrix
= w
->current_matrix
= NULL
;
2329 f
->tool_bar_window
= Qnil
;
2332 /* Release frame glyph matrices. Reset fields to zero in
2333 case we are called a second time. */
2334 if (f
->desired_matrix
)
2336 free_glyph_matrix (f
->desired_matrix
);
2337 free_glyph_matrix (f
->current_matrix
);
2338 f
->desired_matrix
= f
->current_matrix
= NULL
;
2341 /* Release glyph pools. */
2342 if (f
->desired_pool
)
2344 free_glyph_pool (f
->desired_pool
);
2345 free_glyph_pool (f
->current_pool
);
2346 f
->desired_pool
= f
->current_pool
= NULL
;
2354 /* Free glyph sub-matrices in the window tree rooted at W. This
2355 function may be called with a null pointer, and it may be called on
2356 the same tree more than once. */
2359 free_window_matrices (struct window
*w
)
2363 if (!NILP (w
->hchild
))
2364 free_window_matrices (XWINDOW (w
->hchild
));
2365 else if (!NILP (w
->vchild
))
2366 free_window_matrices (XWINDOW (w
->vchild
));
2369 /* This is a leaf window. Free its memory and reset fields
2370 to zero in case this function is called a second time for
2372 free_glyph_matrix (w
->current_matrix
);
2373 free_glyph_matrix (w
->desired_matrix
);
2374 w
->current_matrix
= w
->desired_matrix
= NULL
;
2377 /* Next window on same level. */
2378 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2383 /* Check glyph memory leaks. This function is called from
2384 shut_down_emacs. Note that frames are not destroyed when Emacs
2385 exits. We therefore free all glyph memory for all active frames
2386 explicitly and check that nothing is left allocated. */
2389 check_glyph_memory (void)
2391 Lisp_Object tail
, frame
;
2393 /* Free glyph memory for all frames. */
2394 FOR_EACH_FRAME (tail
, frame
)
2395 free_glyphs (XFRAME (frame
));
2397 /* Check that nothing is left allocated. */
2398 if (glyph_matrix_count
)
2400 if (glyph_pool_count
)
2406 /**********************************************************************
2407 Building a Frame Matrix
2408 **********************************************************************/
2410 /* Most of the redisplay code works on glyph matrices attached to
2411 windows. This is a good solution most of the time, but it is not
2412 suitable for terminal code. Terminal output functions cannot rely
2413 on being able to set an arbitrary terminal window. Instead they
2414 must be provided with a view of the whole frame, i.e. the whole
2415 screen. We build such a view by constructing a frame matrix from
2416 window matrices in this section.
2418 Windows that must be updated have their must_be_update_p flag set.
2419 For all such windows, their desired matrix is made part of the
2420 desired frame matrix. For other windows, their current matrix is
2421 made part of the desired frame matrix.
2423 +-----------------+----------------+
2424 | desired | desired |
2426 +-----------------+----------------+
2429 +----------------------------------+
2431 Desired window matrices can be made part of the frame matrix in a
2432 cheap way: We exploit the fact that the desired frame matrix and
2433 desired window matrices share their glyph memory. This is not
2434 possible for current window matrices. Their glyphs are copied to
2435 the desired frame matrix. The latter is equivalent to
2436 preserve_other_columns in the old redisplay.
2438 Used glyphs counters for frame matrix rows are the result of adding
2439 up glyph lengths of the window matrices. A line in the frame
2440 matrix is enabled, if a corresponding line in a window matrix is
2443 After building the desired frame matrix, it will be passed to
2444 terminal code, which will manipulate both the desired and current
2445 frame matrix. Changes applied to the frame's current matrix have
2446 to be visible in current window matrices afterwards, of course.
2448 This problem is solved like this:
2450 1. Window and frame matrices share glyphs. Window matrices are
2451 constructed in a way that their glyph contents ARE the glyph
2452 contents needed in a frame matrix. Thus, any modification of
2453 glyphs done in terminal code will be reflected in window matrices
2456 2. Exchanges of rows in a frame matrix done by terminal code are
2457 intercepted by hook functions so that corresponding row operations
2458 on window matrices can be performed. This is necessary because we
2459 use pointers to glyphs in glyph row structures. To satisfy the
2460 assumption of point 1 above that glyphs are updated implicitly in
2461 window matrices when they are manipulated via the frame matrix,
2462 window and frame matrix must of course agree where to find the
2463 glyphs for their rows. Possible manipulations that must be
2464 mirrored are assignments of rows of the desired frame matrix to the
2465 current frame matrix and scrolling the current frame matrix. */
2467 /* Build frame F's desired matrix from window matrices. Only windows
2468 which have the flag must_be_updated_p set have to be updated. Menu
2469 bar lines of a frame are not covered by window matrices, so make
2470 sure not to touch them in this function. */
2473 build_frame_matrix (struct frame
*f
)
2477 /* F must have a frame matrix when this function is called. */
2478 xassert (!FRAME_WINDOW_P (f
));
2480 /* Clear all rows in the frame matrix covered by window matrices.
2481 Menu bar lines are not covered by windows. */
2482 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2483 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2485 /* Build the matrix by walking the window tree. */
2486 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2487 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2491 /* Walk a window tree, building a frame matrix MATRIX from window
2492 matrices. W is the root of a window tree. */
2495 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2499 if (!NILP (w
->hchild
))
2500 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2501 else if (!NILP (w
->vchild
))
2502 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2504 build_frame_matrix_from_leaf_window (matrix
, w
);
2506 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2511 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2512 desired frame matrix built. W is a leaf window whose desired or
2513 current matrix is to be added to FRAME_MATRIX. W's flag
2514 must_be_updated_p determines which matrix it contributes to
2515 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2516 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2517 Adding a desired matrix means setting up used counters and such in
2518 frame rows, while adding a current window matrix to FRAME_MATRIX
2519 means copying glyphs. The latter case corresponds to
2520 preserve_other_columns in the old redisplay. */
2523 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2525 struct glyph_matrix
*window_matrix
;
2526 int window_y
, frame_y
;
2527 /* If non-zero, a glyph to insert at the right border of W. */
2528 GLYPH right_border_glyph
;
2530 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2532 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2533 if (w
->must_be_updated_p
)
2535 window_matrix
= w
->desired_matrix
;
2537 /* Decide whether we want to add a vertical border glyph. */
2538 if (!WINDOW_RIGHTMOST_P (w
))
2540 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2543 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2545 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2547 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2548 spec_glyph_lookup_face (w
, &right_border_glyph
);
2551 if (GLYPH_FACE (right_border_glyph
) <= 0)
2552 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2556 window_matrix
= w
->current_matrix
;
2558 /* For all rows in the window matrix and corresponding rows in the
2561 frame_y
= window_matrix
->matrix_y
;
2562 while (window_y
< window_matrix
->nrows
)
2564 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2565 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2566 int current_row_p
= window_matrix
== w
->current_matrix
;
2568 /* Fill up the frame row with spaces up to the left margin of the
2570 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2572 /* Fill up areas in the window matrix row with spaces. */
2573 fill_up_glyph_row_with_spaces (window_row
);
2575 /* If only part of W's desired matrix has been built, and
2576 window_row wasn't displayed, use the corresponding current
2578 if (window_matrix
== w
->desired_matrix
2579 && !window_row
->enabled_p
)
2581 window_row
= w
->current_matrix
->rows
+ window_y
;
2587 /* Copy window row to frame row. */
2588 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2589 window_row
->glyphs
[0],
2590 window_matrix
->matrix_w
* sizeof (struct glyph
));
2594 xassert (window_row
->enabled_p
);
2596 /* Only when a desired row has been displayed, we want
2597 the corresponding frame row to be updated. */
2598 frame_row
->enabled_p
= 1;
2600 /* Maybe insert a vertical border between horizontally adjacent
2602 if (GLYPH_CHAR (right_border_glyph
) != 0)
2604 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2605 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2609 /* Window row window_y must be a slice of frame row
2611 xassert (glyph_row_slice_p (window_row
, frame_row
));
2613 /* If rows are in sync, we don't have to copy glyphs because
2614 frame and window share glyphs. */
2616 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2617 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2621 /* Set number of used glyphs in the frame matrix. Since we fill
2622 up with spaces, and visit leaf windows from left to right it
2623 can be done simply. */
2624 frame_row
->used
[TEXT_AREA
]
2625 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2633 /* Given a user-specified glyph, possibly including a Lisp-level face
2634 ID, return a glyph that has a realized face ID.
2635 This is used for glyphs displayed specially and not part of the text;
2636 for instance, vertical separators, truncation markers, etc. */
2639 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2641 int lface_id
= GLYPH_FACE (*glyph
);
2642 /* Convert the glyph's specified face to a realized (cache) face. */
2645 int face_id
= merge_faces (XFRAME (w
->frame
),
2646 Qt
, lface_id
, DEFAULT_FACE_ID
);
2647 SET_GLYPH_FACE (*glyph
, face_id
);
2651 /* Add spaces to a glyph row ROW in a window matrix.
2653 Each row has the form:
2655 +---------+-----------------------------+------------+
2656 | left | text | right |
2657 +---------+-----------------------------+------------+
2659 Left and right marginal areas are optional. This function adds
2660 spaces to areas so that there are no empty holes between areas.
2661 In other words: If the right area is not empty, the text area
2662 is filled up with spaces up to the right area. If the text area
2663 is not empty, the left area is filled up.
2665 To be called for frame-based redisplay, only. */
2668 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2670 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2671 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2672 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2676 /* Fill area AREA of glyph row ROW with spaces. To be called for
2677 frame-based redisplay only. */
2680 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2682 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2684 struct glyph
*end
= row
->glyphs
[area
+ 1];
2685 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2688 *text
++ = space_glyph
;
2689 row
->used
[area
] = text
- row
->glyphs
[area
];
2694 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2695 reached. In frame matrices only one area, TEXT_AREA, is used. */
2698 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2700 int i
= row
->used
[TEXT_AREA
];
2701 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2704 glyph
[i
++] = space_glyph
;
2706 row
->used
[TEXT_AREA
] = i
;
2711 /**********************************************************************
2712 Mirroring operations on frame matrices in window matrices
2713 **********************************************************************/
2715 /* Set frame being updated via frame-based redisplay to F. This
2716 function must be called before updates to make explicit that we are
2717 working on frame matrices or not. */
2720 set_frame_matrix_frame (struct frame
*f
)
2722 frame_matrix_frame
= f
;
2726 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2727 DESIRED_MATRIX is the desired matrix corresponding to
2728 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2729 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2730 frame_matrix_frame is non-null, this indicates that the exchange is
2731 done in frame matrices, and that we have to perform analogous
2732 operations in window matrices of frame_matrix_frame. */
2735 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2737 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2738 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2739 int mouse_face_p
= current_row
->mouse_face_p
;
2741 /* Do current_row = desired_row. This exchanges glyph pointers
2742 between both rows, and does a structure assignment otherwise. */
2743 assign_row (current_row
, desired_row
);
2745 /* Enable current_row to mark it as valid. */
2746 current_row
->enabled_p
= 1;
2747 current_row
->mouse_face_p
= mouse_face_p
;
2749 /* If we are called on frame matrices, perform analogous operations
2750 for window matrices. */
2751 if (frame_matrix_frame
)
2752 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2756 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2757 W's frame which has been made current (by swapping pointers between
2758 current and desired matrix). Perform analogous operations in the
2759 matrices of leaf windows in the window tree rooted at W. */
2762 mirror_make_current (struct window
*w
, int frame_row
)
2766 if (!NILP (w
->hchild
))
2767 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2768 else if (!NILP (w
->vchild
))
2769 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2772 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2773 here because the checks performed in debug mode there
2774 will not allow the conversion. */
2775 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2777 /* If FRAME_ROW is within W, assign the desired row to the
2778 current row (exchanging glyph pointers). */
2779 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2781 struct glyph_row
*current_row
2782 = MATRIX_ROW (w
->current_matrix
, row
);
2783 struct glyph_row
*desired_row
2784 = MATRIX_ROW (w
->desired_matrix
, row
);
2786 if (desired_row
->enabled_p
)
2787 assign_row (current_row
, desired_row
);
2789 swap_glyph_pointers (desired_row
, current_row
);
2790 current_row
->enabled_p
= 1;
2792 /* Set the Y coordinate of the mode/header line's row.
2793 It is needed in draw_row_with_mouse_face to find the
2794 screen coordinates. (Window-based redisplay sets
2795 this in update_window, but no one seems to do that
2796 for frame-based redisplay.) */
2797 if (current_row
->mode_line_p
)
2798 current_row
->y
= row
;
2802 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2807 /* Perform row dance after scrolling. We are working on the range of
2808 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2809 including) in MATRIX. COPY_FROM is a vector containing, for each
2810 row I in the range 0 <= I < NLINES, the index of the original line
2811 to move to I. This index is relative to the row range, i.e. 0 <=
2812 index < NLINES. RETAINED_P is a vector containing zero for each
2813 row 0 <= I < NLINES which is empty.
2815 This function is called from do_scrolling and do_direct_scrolling. */
2818 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2819 int *copy_from
, char *retained_p
)
2821 /* A copy of original rows. */
2822 struct glyph_row
*old_rows
;
2824 /* Rows to assign to. */
2825 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2829 /* Make a copy of the original rows. */
2830 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2831 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2833 /* Assign new rows, maybe clear lines. */
2834 for (i
= 0; i
< nlines
; ++i
)
2836 int enabled_before_p
= new_rows
[i
].enabled_p
;
2838 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2839 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2840 new_rows
[i
] = old_rows
[copy_from
[i
]];
2841 new_rows
[i
].enabled_p
= enabled_before_p
;
2843 /* RETAINED_P is zero for empty lines. */
2844 if (!retained_p
[copy_from
[i
]])
2845 new_rows
[i
].enabled_p
= 0;
2848 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2849 if (frame_matrix_frame
)
2850 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2851 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2855 /* Synchronize glyph pointers in the current matrix of window W with
2856 the current frame matrix. */
2859 sync_window_with_frame_matrix_rows (struct window
*w
)
2861 struct frame
*f
= XFRAME (w
->frame
);
2862 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2863 int left
, right
, x
, width
;
2865 /* Preconditions: W must be a leaf window on a tty frame. */
2866 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2867 xassert (!FRAME_WINDOW_P (f
));
2869 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2870 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2871 x
= w
->current_matrix
->matrix_x
;
2872 width
= w
->current_matrix
->matrix_w
;
2874 window_row
= w
->current_matrix
->rows
;
2875 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2876 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2878 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2880 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2881 = frame_row
->glyphs
[0] + x
;
2882 window_row
->glyphs
[TEXT_AREA
]
2883 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2884 window_row
->glyphs
[LAST_AREA
]
2885 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2886 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2887 = window_row
->glyphs
[LAST_AREA
] - right
;
2892 /* Return the window in the window tree rooted in W containing frame
2893 row ROW. Value is null if none is found. */
2895 static struct window
*
2896 frame_row_to_window (struct window
*w
, int row
)
2898 struct window
*found
= NULL
;
2902 if (!NILP (w
->hchild
))
2903 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2904 else if (!NILP (w
->vchild
))
2905 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2906 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2907 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2910 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2917 /* Perform a line dance in the window tree rooted at W, after
2918 scrolling a frame matrix in mirrored_line_dance.
2920 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2921 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2922 COPY_FROM is a vector containing, for each row I in the range 0 <=
2923 I < NLINES, the index of the original line to move to I. This
2924 index is relative to the row range, i.e. 0 <= index < NLINES.
2925 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2929 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2933 if (!NILP (w
->hchild
))
2934 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2935 nlines
, copy_from
, retained_p
);
2936 else if (!NILP (w
->vchild
))
2937 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2938 nlines
, copy_from
, retained_p
);
2941 /* W is a leaf window, and we are working on its current
2943 struct glyph_matrix
*m
= w
->current_matrix
;
2945 struct glyph_row
*old_rows
;
2947 /* Make a copy of the original rows of matrix m. */
2948 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2949 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2951 for (i
= 0; i
< nlines
; ++i
)
2953 /* Frame relative line assigned to. */
2954 int frame_to
= i
+ unchanged_at_top
;
2956 /* Frame relative line assigned. */
2957 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2959 /* Window relative line assigned to. */
2960 int window_to
= frame_to
- m
->matrix_y
;
2962 /* Window relative line assigned. */
2963 int window_from
= frame_from
- m
->matrix_y
;
2965 /* Is assigned line inside window? */
2966 int from_inside_window_p
2967 = window_from
>= 0 && window_from
< m
->matrix_h
;
2969 /* Is assigned to line inside window? */
2970 int to_inside_window_p
2971 = window_to
>= 0 && window_to
< m
->matrix_h
;
2973 if (from_inside_window_p
&& to_inside_window_p
)
2975 /* Enabled setting before assignment. */
2976 int enabled_before_p
;
2978 /* Do the assignment. The enabled_p flag is saved
2979 over the assignment because the old redisplay did
2981 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2982 m
->rows
[window_to
] = old_rows
[window_from
];
2983 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2985 /* If frame line is empty, window line is empty, too. */
2986 if (!retained_p
[copy_from
[i
]])
2987 m
->rows
[window_to
].enabled_p
= 0;
2989 else if (to_inside_window_p
)
2991 /* A copy between windows. This is an infrequent
2992 case not worth optimizing. */
2993 struct frame
*f
= XFRAME (w
->frame
);
2994 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2996 struct glyph_matrix
*m2
;
2999 w2
= frame_row_to_window (root
, frame_from
);
3000 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3001 -nw', FROM_FRAME sometimes has no associated window.
3002 This check avoids a segfault if W2 is null. */
3005 m2
= w2
->current_matrix
;
3006 m2_from
= frame_from
- m2
->matrix_y
;
3007 copy_row_except_pointers (m
->rows
+ window_to
,
3008 m2
->rows
+ m2_from
);
3010 /* If frame line is empty, window line is empty, too. */
3011 if (!retained_p
[copy_from
[i
]])
3012 m
->rows
[window_to
].enabled_p
= 0;
3016 else if (from_inside_window_p
)
3020 /* If there was a copy between windows, make sure glyph
3021 pointers are in sync with the frame matrix. */
3023 sync_window_with_frame_matrix_rows (w
);
3025 /* Check that no pointers are lost. */
3029 /* Next window on same level. */
3030 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3037 /* Check that window and frame matrices agree about their
3038 understanding where glyphs of the rows are to find. For each
3039 window in the window tree rooted at W, check that rows in the
3040 matrices of leaf window agree with their frame matrices about
3044 check_window_matrix_pointers (struct window
*w
)
3048 if (!NILP (w
->hchild
))
3049 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3050 else if (!NILP (w
->vchild
))
3051 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3054 struct frame
*f
= XFRAME (w
->frame
);
3055 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3056 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3059 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3064 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3065 a window and FRAME_MATRIX is the corresponding frame matrix. For
3066 each row in WINDOW_MATRIX check that it's a slice of the
3067 corresponding frame row. If it isn't, abort. */
3070 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3071 struct glyph_matrix
*frame_matrix
)
3073 /* Row number in WINDOW_MATRIX. */
3076 /* Row number corresponding to I in FRAME_MATRIX. */
3077 int j
= window_matrix
->matrix_y
;
3079 /* For all rows check that the row in the window matrix is a
3080 slice of the row in the frame matrix. If it isn't we didn't
3081 mirror an operation on the frame matrix correctly. */
3082 while (i
< window_matrix
->nrows
)
3084 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3085 frame_matrix
->rows
+ j
))
3091 #endif /* GLYPH_DEBUG != 0 */
3095 /**********************************************************************
3096 VPOS and HPOS translations
3097 **********************************************************************/
3101 /* Translate vertical position VPOS which is relative to window W to a
3102 vertical position relative to W's frame. */
3105 window_to_frame_vpos (struct window
*w
, int vpos
)
3107 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3108 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3109 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3110 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3115 /* Translate horizontal position HPOS which is relative to window W to
3116 a horizontal position relative to W's frame. */
3119 window_to_frame_hpos (struct window
*w
, int hpos
)
3121 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3122 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3126 #endif /* GLYPH_DEBUG */
3130 /**********************************************************************
3132 **********************************************************************/
3134 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3135 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3140 CHECK_LIVE_FRAME (frame
);
3143 /* Ignore redraw requests, if frame has no glyphs yet.
3144 (Implementation note: It still has to be checked why we are
3145 called so early here). */
3146 if (!glyphs_initialized_initially_p
)
3151 if (FRAME_MSDOS_P (f
))
3152 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3155 clear_current_matrices (f
);
3157 if (FRAME_TERMCAP_P (f
))
3158 fflush (FRAME_TTY (f
)->output
);
3159 windows_or_buffers_changed
++;
3160 /* Mark all windows as inaccurate, so that every window will have
3161 its redisplay done. */
3162 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3163 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3169 /* Redraw frame F. This is nothing more than a call to the Lisp
3170 function redraw-frame. */
3173 redraw_frame (struct frame
*f
)
3176 XSETFRAME (frame
, f
);
3177 Fredraw_frame (frame
);
3181 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3182 doc
: /* Clear and redisplay all visible frames. */)
3185 Lisp_Object tail
, frame
;
3187 FOR_EACH_FRAME (tail
, frame
)
3188 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3189 Fredraw_frame (frame
);
3196 /***********************************************************************
3198 ***********************************************************************/
3200 /* Update frame F based on the data in desired matrices.
3202 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3203 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3206 Value is non-zero if redisplay was stopped due to pending input. */
3209 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3211 /* 1 means display has been paused because of pending input. */
3213 struct window
*root_window
= XWINDOW (f
->root_window
);
3215 if (redisplay_dont_pause
)
3217 #if PERIODIC_PREEMPTION_CHECKING
3218 else if (NILP (Vredisplay_preemption_period
))
3220 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3223 double p
= XFLOATINT (Vredisplay_preemption_period
);
3226 if (detect_input_pending_ignore_squeezables ())
3233 usec
= (p
- sec
) * 1000000;
3235 EMACS_GET_TIME (tm
);
3236 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3237 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3241 if (FRAME_WINDOW_P (f
))
3243 /* We are working on window matrix basis. All windows whose
3244 flag must_be_updated_p is set have to be updated. */
3246 /* Record that we are not working on frame matrices. */
3247 set_frame_matrix_frame (NULL
);
3249 /* Update all windows in the window tree of F, maybe stopping
3250 when pending input is detected. */
3253 /* Update the menu bar on X frames that don't have toolkit
3255 if (WINDOWP (f
->menu_bar_window
))
3256 update_window (XWINDOW (f
->menu_bar_window
), 1);
3258 /* Update the tool-bar window, if present. */
3259 if (WINDOWP (f
->tool_bar_window
))
3261 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3263 /* Update tool-bar window. */
3264 if (w
->must_be_updated_p
)
3268 update_window (w
, 1);
3269 w
->must_be_updated_p
= 0;
3271 /* Swap tool-bar strings. We swap because we want to
3273 tem
= f
->current_tool_bar_string
;
3274 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3275 f
->desired_tool_bar_string
= tem
;
3280 /* Update windows. */
3281 paused_p
= update_window_tree (root_window
, force_p
);
3284 /* This flush is a performance bottleneck under X,
3285 and it doesn't seem to be necessary anyway (in general).
3286 It is necessary when resizing the window with the mouse, or
3287 at least the fringes are not redrawn in a timely manner. ++kfs */
3288 if (f
->force_flush_display_p
)
3290 FRAME_RIF (f
)->flush_display (f
);
3291 f
->force_flush_display_p
= 0;
3296 /* We are working on frame matrix basis. Set the frame on whose
3297 frame matrix we operate. */
3298 set_frame_matrix_frame (f
);
3300 /* Build F's desired matrix from window matrices. */
3301 build_frame_matrix (f
);
3303 /* Update the display */
3305 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3308 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3310 if (FRAME_TTY (f
)->termscript
)
3311 fflush (FRAME_TTY (f
)->termscript
);
3312 if (FRAME_TERMCAP_P (f
))
3313 fflush (FRAME_TTY (f
)->output
);
3316 /* Check window matrices for lost pointers. */
3318 check_window_matrix_pointers (root_window
);
3319 add_frame_display_history (f
, paused_p
);
3323 #if PERIODIC_PREEMPTION_CHECKING
3326 /* Reset flags indicating that a window should be updated. */
3327 set_window_update_flags (root_window
, 0);
3329 display_completed
= !paused_p
;
3335 /************************************************************************
3336 Window-based updates
3337 ************************************************************************/
3339 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3340 don't stop updating when input is pending. */
3343 update_window_tree (struct window
*w
, int force_p
)
3347 while (w
&& !paused_p
)
3349 if (!NILP (w
->hchild
))
3350 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3351 else if (!NILP (w
->vchild
))
3352 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3353 else if (w
->must_be_updated_p
)
3354 paused_p
|= update_window (w
, force_p
);
3356 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3363 /* Update window W if its flag must_be_updated_p is non-zero. If
3364 FORCE_P is non-zero, don't stop updating if input is pending. */
3367 update_single_window (struct window
*w
, int force_p
)
3369 if (w
->must_be_updated_p
)
3371 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3373 /* Record that this is not a frame-based redisplay. */
3374 set_frame_matrix_frame (NULL
);
3376 if (redisplay_dont_pause
)
3378 #if PERIODIC_PREEMPTION_CHECKING
3379 else if (NILP (Vredisplay_preemption_period
))
3381 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3384 double p
= XFLOATINT (Vredisplay_preemption_period
);
3388 usec
= (p
- sec
) * 1000000;
3390 EMACS_GET_TIME (tm
);
3391 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3392 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3398 update_window (w
, force_p
);
3401 /* Reset flag in W. */
3402 w
->must_be_updated_p
= 0;
3406 #ifdef HAVE_WINDOW_SYSTEM
3408 /* Redraw lines from the current matrix of window W that are
3409 overlapped by other rows. YB is bottom-most y-position in W. */
3412 redraw_overlapped_rows (struct window
*w
, int yb
)
3415 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3417 /* If rows overlapping others have been changed, the rows being
3418 overlapped have to be redrawn. This won't draw lines that have
3419 already been drawn in update_window_line because overlapped_p in
3420 desired rows is 0, so after row assignment overlapped_p in
3421 current rows is 0. */
3422 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3424 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3426 if (!row
->enabled_p
)
3428 else if (row
->mode_line_p
)
3431 if (row
->overlapped_p
)
3433 enum glyph_row_area area
;
3435 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3438 updated_area
= area
;
3439 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3440 area
== TEXT_AREA
? row
->x
: 0);
3441 if (row
->used
[area
])
3442 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3444 FRAME_RIF (f
)->clear_end_of_line (-1);
3447 row
->overlapped_p
= 0;
3450 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3456 /* Redraw lines from the current matrix of window W that overlap
3457 others. YB is bottom-most y-position in W. */
3460 redraw_overlapping_rows (struct window
*w
, int yb
)
3463 struct glyph_row
*row
;
3464 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3466 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3468 row
= w
->current_matrix
->rows
+ i
;
3470 if (!row
->enabled_p
)
3472 else if (row
->mode_line_p
)
3475 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3477 if (row
->overlapping_p
)
3481 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3482 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3483 overlaps
|= OVERLAPS_PRED
;
3484 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3485 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3486 overlaps
|= OVERLAPS_SUCC
;
3490 if (row
->used
[LEFT_MARGIN_AREA
])
3491 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3493 if (row
->used
[TEXT_AREA
])
3494 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3496 if (row
->used
[RIGHT_MARGIN_AREA
])
3497 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3499 /* Record in neighbor rows that ROW overwrites part of
3501 if (overlaps
& OVERLAPS_PRED
)
3502 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3503 if (overlaps
& OVERLAPS_SUCC
)
3504 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3513 #endif /* HAVE_WINDOW_SYSTEM */
3516 #if defined GLYPH_DEBUG && 0
3518 /* Check that no row in the current matrix of window W is enabled
3519 which is below what's displayed in the window. */
3522 check_current_matrix_flags (struct window
*w
)
3524 int last_seen_p
= 0;
3525 int i
, yb
= window_text_bottom_y (w
);
3527 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3529 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3530 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3532 else if (last_seen_p
&& row
->enabled_p
)
3537 #endif /* GLYPH_DEBUG */
3540 /* Update display of window W. FORCE_P non-zero means that we should
3541 not stop when detecting pending input. */
3544 update_window (struct window
*w
, int force_p
)
3546 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3548 #if !PERIODIC_PREEMPTION_CHECKING
3549 int preempt_count
= baud_rate
/ 2400 + 1;
3551 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3553 /* Check that W's frame doesn't have glyph matrices. */
3554 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3557 /* Check pending input the first time so that we can quickly return. */
3558 #if !PERIODIC_PREEMPTION_CHECKING
3560 detect_input_pending_ignore_squeezables ();
3563 /* If forced to complete the update, or if no input is pending, do
3565 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3567 struct glyph_row
*row
, *end
;
3568 struct glyph_row
*mode_line_row
;
3569 struct glyph_row
*header_line_row
;
3570 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3571 #if ! PERIODIC_PREEMPTION_CHECKING
3575 rif
->update_window_begin_hook (w
);
3576 yb
= window_text_bottom_y (w
);
3577 row
= desired_matrix
->rows
;
3578 end
= row
+ desired_matrix
->nrows
- 1;
3580 /* Take note of the header line, if there is one. We will
3581 update it below, after updating all of the window's lines. */
3582 if (row
->mode_line_p
)
3584 header_line_row
= row
;
3588 header_line_row
= NULL
;
3590 /* Update the mode line, if necessary. */
3591 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3592 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3594 mode_line_row
->y
= yb
;
3595 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3597 &mouse_face_overwritten_p
);
3600 /* Find first enabled row. Optimizations in redisplay_internal
3601 may lead to an update with only one row enabled. There may
3602 be also completely empty matrices. */
3603 while (row
< end
&& !row
->enabled_p
)
3606 /* Try reusing part of the display by copying. */
3607 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3609 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3612 /* All rows were found to be equal. */
3618 /* We've scrolled the display. */
3624 /* Update the rest of the lines. */
3625 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3626 /* scrolling_window resets the enabled_p flag of the rows it
3627 reuses from current_matrix. */
3630 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3633 /* We'll have to play a little bit with when to
3634 detect_input_pending. If it's done too often,
3635 scrolling large windows with repeated scroll-up
3636 commands will too quickly pause redisplay. */
3637 #if PERIODIC_PREEMPTION_CHECKING
3641 EMACS_GET_TIME (tm
);
3642 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3643 if (EMACS_TIME_NEG_P (dif
))
3645 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3646 if (detect_input_pending_ignore_squeezables ())
3651 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3652 detect_input_pending_ignore_squeezables ();
3654 changed_p
|= update_window_line (w
, vpos
,
3655 &mouse_face_overwritten_p
);
3657 /* Mark all rows below the last visible one in the current
3658 matrix as invalid. This is necessary because of
3659 variable line heights. Consider the case of three
3660 successive redisplays, where the first displays 5
3661 lines, the second 3 lines, and the third 5 lines again.
3662 If the second redisplay wouldn't mark rows in the
3663 current matrix invalid, the third redisplay might be
3664 tempted to optimize redisplay based on lines displayed
3665 in the first redisplay. */
3666 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3667 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3668 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3671 /* Was display preempted? */
3672 paused_p
= row
< end
;
3676 /* Update the header line after scrolling because a new header
3677 line would otherwise overwrite lines at the top of the window
3678 that can be scrolled. */
3679 if (header_line_row
&& header_line_row
->enabled_p
)
3681 header_line_row
->y
= 0;
3682 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3685 /* Fix the appearance of overlapping/overlapped rows. */
3686 if (!paused_p
&& !w
->pseudo_window_p
)
3688 #ifdef HAVE_WINDOW_SYSTEM
3689 if (changed_p
&& rif
->fix_overlapping_area
)
3691 redraw_overlapped_rows (w
, yb
);
3692 redraw_overlapping_rows (w
, yb
);
3696 /* Make cursor visible at cursor position of W. */
3697 set_window_cursor_after_update (w
);
3699 #if 0 /* Check that current matrix invariants are satisfied. This is
3700 for debugging only. See the comment of check_matrix_invariants. */
3701 IF_DEBUG (check_matrix_invariants (w
));
3706 /* Remember the redisplay method used to display the matrix. */
3707 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3710 #ifdef HAVE_WINDOW_SYSTEM
3711 update_window_fringes (w
, 0);
3714 /* End the update of window W. Don't set the cursor if we
3715 paused updating the display because in this case,
3716 set_window_cursor_after_update hasn't been called, and
3717 output_cursor doesn't contain the cursor location. */
3718 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3724 /* check_current_matrix_flags (w); */
3725 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3728 clear_glyph_matrix (desired_matrix
);
3734 /* Update the display of area AREA in window W, row number VPOS.
3735 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3738 update_marginal_area (struct window
*w
, int area
, int vpos
)
3740 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3741 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3743 /* Let functions in xterm.c know what area subsequent X positions
3744 will be relative to. */
3745 updated_area
= area
;
3747 /* Set cursor to start of glyphs, write them, and clear to the end
3748 of the area. I don't think that something more sophisticated is
3749 necessary here, since marginal areas will not be the default. */
3750 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3751 if (desired_row
->used
[area
])
3752 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3753 rif
->clear_end_of_line (-1);
3757 /* Update the display of the text area of row VPOS in window W.
3758 Value is non-zero if display has changed. */
3761 update_text_area (struct window
*w
, int vpos
)
3763 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3764 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3765 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3768 /* Let functions in xterm.c know what area subsequent X positions
3769 will be relative to. */
3770 updated_area
= TEXT_AREA
;
3772 /* If rows are at different X or Y, or rows have different height,
3773 or the current row is marked invalid, write the entire line. */
3774 if (!current_row
->enabled_p
3775 || desired_row
->y
!= current_row
->y
3776 || desired_row
->ascent
!= current_row
->ascent
3777 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3778 || desired_row
->phys_height
!= current_row
->phys_height
3779 || desired_row
->visible_height
!= current_row
->visible_height
3780 || current_row
->overlapped_p
3781 /* This next line is necessary for correctly redrawing
3782 mouse-face areas after scrolling and other operations.
3783 However, it causes excessive flickering when mouse is moved
3784 across the mode line. Luckily, turning it off for the mode
3785 line doesn't seem to hurt anything. -- cyd.
3786 But it is still needed for the header line. -- kfs. */
3787 || (current_row
->mouse_face_p
3788 && !(current_row
->mode_line_p
&& vpos
> 0))
3789 || current_row
->x
!= desired_row
->x
)
3791 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3793 if (desired_row
->used
[TEXT_AREA
])
3794 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3795 desired_row
->used
[TEXT_AREA
]);
3797 /* Clear to end of window. */
3798 rif
->clear_end_of_line (-1);
3801 /* This erases the cursor. We do this here because
3802 notice_overwritten_cursor cannot easily check this, which
3803 might indicate that the whole functionality of
3804 notice_overwritten_cursor would better be implemented here.
3805 On the other hand, we need notice_overwritten_cursor as long
3806 as mouse highlighting is done asynchronously outside of
3808 if (vpos
== w
->phys_cursor
.vpos
)
3809 w
->phys_cursor_on_p
= 0;
3814 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3815 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3816 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3817 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3818 int abort_skipping
= 0;
3820 /* If the desired row extends its face to the text area end, and
3821 unless the current row also does so at the same position,
3822 make sure we write at least one glyph, so that the face
3823 extension actually takes place. */
3824 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3825 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3826 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3827 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3830 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3834 /* Loop over glyphs that current and desired row may have
3838 int can_skip_p
= !abort_skipping
;
3840 /* Skip over glyphs that both rows have in common. These
3841 don't have to be written. We can't skip if the last
3842 current glyph overlaps the glyph to its right. For
3843 example, consider a current row of `if ' with the `f' in
3844 Courier bold so that it overlaps the ` ' to its right.
3845 If the desired row is ` ', we would skip over the space
3846 after the `if' and there would remain a pixel from the
3847 `f' on the screen. */
3848 if (overlapping_glyphs_p
&& i
> 0)
3850 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3853 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3855 can_skip_p
= (right
== 0 && !abort_skipping
);
3863 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3865 x
+= desired_glyph
->pixel_width
;
3866 ++desired_glyph
, ++current_glyph
, ++i
;
3869 /* Consider the case that the current row contains "xxx
3870 ppp ggg" in italic Courier font, and the desired row
3871 is "xxx ggg". The character `p' has lbearing, `g'
3872 has not. The loop above will stop in front of the
3873 first `p' in the current row. If we would start
3874 writing glyphs there, we wouldn't erase the lbearing
3875 of the `p'. The rest of the lbearing problem is then
3876 taken care of by draw_glyphs. */
3877 if (overlapping_glyphs_p
3879 && i
< current_row
->used
[TEXT_AREA
]
3880 && (current_row
->used
[TEXT_AREA
]
3881 != desired_row
->used
[TEXT_AREA
]))
3885 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3887 while (left
> 0 && i
> 0)
3889 --i
, --desired_glyph
, --current_glyph
;
3890 x
-= desired_glyph
->pixel_width
;
3891 left
-= desired_glyph
->pixel_width
;
3894 /* Abort the skipping algorithm if we end up before
3895 our starting point, to avoid looping (bug#1070).
3896 This can happen when the lbearing is larger than
3898 abort_skipping
= (i
< start_hpos
);
3902 /* Try to avoid writing the entire rest of the desired row
3903 by looking for a resync point. This mainly prevents
3904 mode line flickering in the case the mode line is in
3905 fixed-pitch font, which it usually will be. */
3906 if (i
< desired_row
->used
[TEXT_AREA
])
3908 int start_x
= x
, start_hpos
= i
;
3909 struct glyph
*start
= desired_glyph
;
3911 int skip_first_p
= !can_skip_p
;
3913 /* Find the next glyph that's equal again. */
3916 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3919 x
+= desired_glyph
->pixel_width
;
3920 current_x
+= current_glyph
->pixel_width
;
3921 ++desired_glyph
, ++current_glyph
, ++i
;
3925 if (i
== start_hpos
|| x
!= current_x
)
3929 desired_glyph
= start
;
3933 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3934 rif
->write_glyphs (start
, i
- start_hpos
);
3939 /* Write the rest. */
3940 if (i
< desired_row
->used
[TEXT_AREA
])
3942 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3943 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3947 /* Maybe clear to end of line. */
3948 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3950 /* If new row extends to the end of the text area, nothing
3951 has to be cleared, if and only if we did a write_glyphs
3952 above. This is made sure by setting desired_stop_pos
3953 appropriately above. */
3954 xassert (i
< desired_row
->used
[TEXT_AREA
]
3955 || ((desired_row
->used
[TEXT_AREA
]
3956 == current_row
->used
[TEXT_AREA
])
3957 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3959 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3961 /* If old row extends to the end of the text area, clear. */
3962 if (i
>= desired_row
->used
[TEXT_AREA
])
3963 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3964 desired_row
->pixel_width
);
3965 rif
->clear_end_of_line (-1);
3968 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3970 /* Otherwise clear to the end of the old row. Everything
3971 after that position should be clear already. */
3974 if (i
>= desired_row
->used
[TEXT_AREA
])
3975 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3976 desired_row
->pixel_width
);
3978 /* If cursor is displayed at the end of the line, make sure
3979 it's cleared. Nowadays we don't have a phys_cursor_glyph
3980 with which to erase the cursor (because this method
3981 doesn't work with lbearing/rbearing), so we must do it
3983 if (vpos
== w
->phys_cursor
.vpos
3984 && (desired_row
->reversed_p
3985 ? (w
->phys_cursor
.hpos
< 0)
3986 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3988 w
->phys_cursor_on_p
= 0;
3992 xlim
= current_row
->pixel_width
;
3993 rif
->clear_end_of_line (xlim
);
4002 /* Update row VPOS in window W. Value is non-zero if display has been
4006 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
4008 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
4009 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
4010 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4013 /* Set the row being updated. This is important to let xterm.c
4014 know what line height values are in effect. */
4015 updated_row
= desired_row
;
4017 /* A row can be completely invisible in case a desired matrix was
4018 built with a vscroll and then make_cursor_line_fully_visible shifts
4019 the matrix. Make sure to make such rows current anyway, since
4020 we need the correct y-position, for example, in the current matrix. */
4021 if (desired_row
->mode_line_p
4022 || desired_row
->visible_height
> 0)
4024 xassert (desired_row
->enabled_p
);
4026 /* Update display of the left margin area, if there is one. */
4027 if (!desired_row
->full_width_p
4028 && !NILP (w
->left_margin_cols
))
4031 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4034 /* Update the display of the text area. */
4035 if (update_text_area (w
, vpos
))
4038 if (current_row
->mouse_face_p
)
4039 *mouse_face_overwritten_p
= 1;
4042 /* Update display of the right margin area, if there is one. */
4043 if (!desired_row
->full_width_p
4044 && !NILP (w
->right_margin_cols
))
4047 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4050 /* Draw truncation marks etc. */
4051 if (!current_row
->enabled_p
4052 || desired_row
->y
!= current_row
->y
4053 || desired_row
->visible_height
!= current_row
->visible_height
4054 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4055 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4056 || current_row
->redraw_fringe_bitmaps_p
4057 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4058 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4059 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4060 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4061 rif
->after_update_window_line_hook (desired_row
);
4064 /* Update current_row from desired_row. */
4065 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4071 /* Set the cursor after an update of window W. This function may only
4072 be called from update_window. */
4075 set_window_cursor_after_update (struct window
*w
)
4077 struct frame
*f
= XFRAME (w
->frame
);
4078 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4079 int cx
, cy
, vpos
, hpos
;
4081 /* Not intended for frame matrix updates. */
4082 xassert (FRAME_WINDOW_P (f
));
4084 if (cursor_in_echo_area
4085 && !NILP (echo_area_buffer
[0])
4086 /* If we are showing a message instead of the mini-buffer,
4087 show the cursor for the message instead. */
4088 && XWINDOW (minibuf_window
) == w
4089 && EQ (minibuf_window
, echo_area_window
)
4090 /* These cases apply only to the frame that contains
4091 the active mini-buffer window. */
4092 && FRAME_HAS_MINIBUF_P (f
)
4093 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4095 cx
= cy
= vpos
= hpos
= 0;
4097 if (cursor_in_echo_area
>= 0)
4099 /* If the mini-buffer is several lines high, find the last
4100 line that has any text on it. Note: either all lines
4101 are enabled or none. Otherwise we wouldn't be able to
4103 struct glyph_row
*row
, *last_row
;
4104 struct glyph
*glyph
;
4105 int yb
= window_text_bottom_y (w
);
4108 row
= w
->current_matrix
->rows
;
4109 while (row
->enabled_p
4110 && (last_row
== NULL
4111 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4113 if (row
->used
[TEXT_AREA
]
4114 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4121 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4122 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4124 while (last
> start
&& last
->charpos
< 0)
4127 for (glyph
= start
; glyph
< last
; ++glyph
)
4129 cx
+= glyph
->pixel_width
;
4134 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4142 hpos
= w
->cursor
.hpos
;
4143 vpos
= w
->cursor
.vpos
;
4146 /* Window cursor can be out of sync for horizontally split windows. */
4147 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4148 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4149 vpos
= max (0, vpos
);
4150 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4151 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4155 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4156 tree rooted at W. */
4159 set_window_update_flags (struct window
*w
, int on_p
)
4163 if (!NILP (w
->hchild
))
4164 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4165 else if (!NILP (w
->vchild
))
4166 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4168 w
->must_be_updated_p
= on_p
;
4170 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4176 /***********************************************************************
4177 Window-Based Scrolling
4178 ***********************************************************************/
4180 /* Structure describing rows in scrolling_window. */
4184 /* Number of occurrences of this row in desired and current matrix. */
4185 int old_uses
, new_uses
;
4187 /* Vpos of row in new matrix. */
4188 int new_line_number
;
4190 /* Bucket index of this row_entry in the hash table row_table. */
4193 /* The row described by this entry. */
4194 struct glyph_row
*row
;
4196 /* Hash collision chain. */
4197 struct row_entry
*next
;
4200 /* A pool to allocate row_entry structures from, and the size of the
4201 pool. The pool is reallocated in scrolling_window when we find
4202 that we need a larger one. */
4204 static struct row_entry
*row_entry_pool
;
4205 static ptrdiff_t row_entry_pool_size
;
4207 /* Index of next free entry in row_entry_pool. */
4209 static ptrdiff_t row_entry_idx
;
4211 /* The hash table used during scrolling, and the table's size. This
4212 table is used to quickly identify equal rows in the desired and
4215 static struct row_entry
**row_table
;
4216 static ptrdiff_t row_table_size
;
4218 /* Vectors of pointers to row_entry structures belonging to the
4219 current and desired matrix, and the size of the vectors. */
4221 static struct row_entry
**old_lines
, **new_lines
;
4222 static ptrdiff_t old_lines_size
, new_lines_size
;
4224 /* A pool to allocate run structures from, and its size. */
4226 static struct run
*run_pool
;
4227 static ptrdiff_t runs_size
;
4229 /* A vector of runs of lines found during scrolling. */
4231 static struct run
**runs
;
4233 /* Add glyph row ROW to the scrolling hash table. */
4235 static inline struct row_entry
*
4236 add_row_entry (struct glyph_row
*row
)
4238 struct row_entry
*entry
;
4239 ptrdiff_t i
= row
->hash
% row_table_size
;
4241 entry
= row_table
[i
];
4242 xassert (entry
|| verify_row_hash (row
));
4243 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4244 entry
= entry
->next
;
4248 entry
= row_entry_pool
+ row_entry_idx
++;
4250 entry
->old_uses
= entry
->new_uses
= 0;
4251 entry
->new_line_number
= 0;
4253 entry
->next
= row_table
[i
];
4254 row_table
[i
] = entry
;
4261 /* Try to reuse part of the current display of W by scrolling lines.
4262 HEADER_LINE_P non-zero means W has a header line.
4264 The algorithm is taken from Communications of the ACM, Apr78 "A
4265 Technique for Isolating Differences Between Files." It should take
4268 A short outline of the steps of the algorithm
4270 1. Skip lines equal at the start and end of both matrices.
4272 2. Enter rows in the current and desired matrix into a symbol
4273 table, counting how often they appear in both matrices.
4275 3. Rows that appear exactly once in both matrices serve as anchors,
4276 i.e. we assume that such lines are likely to have been moved.
4278 4. Starting from anchor lines, extend regions to be scrolled both
4279 forward and backward.
4283 -1 if all rows were found to be equal.
4284 0 to indicate that we did not scroll the display, or
4285 1 if we did scroll. */
4288 scrolling_window (struct window
*w
, int header_line_p
)
4290 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4291 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4292 int yb
= window_text_bottom_y (w
);
4294 int j
, first_old
, first_new
, last_old
, last_new
;
4297 struct row_entry
*entry
;
4298 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4300 /* Skip over rows equal at the start. */
4301 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4303 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4304 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4308 && !d
->redraw_fringe_bitmaps_p
4310 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4311 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4312 && row_equal_p (c
, d
, 1))
4321 /* Give up if some rows in the desired matrix are not enabled. */
4322 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4325 first_old
= first_new
= i
;
4327 /* Set last_new to the index + 1 of the row that reaches the
4328 bottom boundary in the desired matrix. Give up if we find a
4329 disabled row before we reach the bottom boundary. */
4331 while (i
< desired_matrix
->nrows
- 1)
4335 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4337 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4346 /* Set last_old to the index + 1 of the row that reaches the bottom
4347 boundary in the current matrix. We don't look at the enabled
4348 flag here because we plan to reuse part of the display even if
4349 other parts are disabled. */
4351 while (i
< current_matrix
->nrows
- 1)
4353 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4362 /* Skip over rows equal at the bottom. */
4365 while (i
- 1 > first_new
4366 && j
- 1 > first_old
4367 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4368 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4369 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4370 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4371 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4372 MATRIX_ROW (current_matrix
, j
- 1), 1))
4377 /* Nothing to do if all rows are equal. */
4378 if (last_new
== first_new
)
4381 /* Check for integer overflow in size calculation.
4383 If next_almost_prime checks (N) for divisibility by 2..10, then
4384 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4385 So, set next_almost_prime_increment_max to 10.
4387 It's just a coincidence that next_almost_prime_increment_max ==
4388 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4389 13, then next_almost_prime_increment_max would be 14, e.g.,
4390 because next_almost_prime (113) would be 127. */
4392 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4393 enum { next_almost_prime_increment_max
= 10 };
4394 ptrdiff_t row_table_max
=
4395 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4396 - next_almost_prime_increment_max
);
4397 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4398 if (current_nrows_max
< current_matrix
->nrows
)
4399 memory_full (SIZE_MAX
);
4402 /* Reallocate vectors, tables etc. if necessary. */
4404 if (current_matrix
->nrows
> old_lines_size
)
4405 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4406 current_matrix
->nrows
- old_lines_size
,
4407 INT_MAX
, sizeof *old_lines
);
4409 if (desired_matrix
->nrows
> new_lines_size
)
4410 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4411 desired_matrix
->nrows
- new_lines_size
,
4412 INT_MAX
, sizeof *new_lines
);
4414 n
= desired_matrix
->nrows
;
4415 n
+= current_matrix
->nrows
;
4416 if (row_table_size
< 3 * n
)
4418 ptrdiff_t size
= next_almost_prime (3 * n
);
4419 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4420 row_table_size
= size
;
4421 memset (row_table
, 0, size
* sizeof *row_table
);
4424 if (n
> row_entry_pool_size
)
4425 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4426 n
- row_entry_pool_size
,
4427 -1, sizeof *row_entry_pool
);
4429 if (desired_matrix
->nrows
> runs_size
)
4431 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4432 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4433 runs_size
= desired_matrix
->nrows
;
4436 nruns
= run_idx
= 0;
4439 /* Add rows from the current and desired matrix to the hash table
4440 row_hash_table to be able to find equal ones quickly. */
4442 for (i
= first_old
; i
< last_old
; ++i
)
4444 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4446 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4447 old_lines
[i
] = entry
;
4451 old_lines
[i
] = NULL
;
4454 for (i
= first_new
; i
< last_new
; ++i
)
4456 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4457 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4459 entry
->new_line_number
= i
;
4460 new_lines
[i
] = entry
;
4463 /* Identify moves based on lines that are unique and equal
4464 in both matrices. */
4465 for (i
= first_old
; i
< last_old
;)
4467 && old_lines
[i
]->old_uses
== 1
4468 && old_lines
[i
]->new_uses
== 1)
4471 int new_line
= old_lines
[i
]->new_line_number
;
4472 struct run
*run
= run_pool
+ run_idx
++;
4475 run
->current_vpos
= i
;
4476 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4477 run
->desired_vpos
= new_line
;
4478 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4480 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4482 /* Extend backward. */
4485 while (p
> first_old
4487 && old_lines
[p
] == new_lines
[q
])
4489 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4490 --run
->current_vpos
;
4491 --run
->desired_vpos
;
4494 run
->desired_y
-= h
;
4495 run
->current_y
-= h
;
4499 /* Extend forward. */
4504 && old_lines
[p
] == new_lines
[q
])
4506 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4512 /* Insert run into list of all runs. Order runs by copied
4513 pixel lines. Note that we record runs that don't have to
4514 be copied because they are already in place. This is done
4515 because we can avoid calling update_window_line in this
4517 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4519 for (q
= nruns
; q
> p
; --q
)
4520 runs
[q
] = runs
[q
- 1];
4529 /* Do the moves. Do it in a way that we don't overwrite something
4530 we want to copy later on. This is not solvable in general
4531 because there is only one display and we don't have a way to
4532 exchange areas on this display. Example:
4534 +-----------+ +-----------+
4536 +-----------+ --> +-----------+
4538 +-----------+ +-----------+
4540 Instead, prefer bigger moves, and invalidate moves that would
4541 copy from where we copied to. */
4543 for (i
= 0; i
< nruns
; ++i
)
4544 if (runs
[i
]->nrows
> 0)
4546 struct run
*r
= runs
[i
];
4548 /* Copy on the display. */
4549 if (r
->current_y
!= r
->desired_y
)
4551 rif
->clear_window_mouse_face (w
);
4552 rif
->scroll_run_hook (w
, r
);
4555 /* Truncate runs that copy to where we copied to, and
4556 invalidate runs that copy from where we copied to. */
4557 for (j
= nruns
- 1; j
> i
; --j
)
4559 struct run
*p
= runs
[j
];
4560 int truncated_p
= 0;
4563 && p
->desired_y
< r
->desired_y
+ r
->height
4564 && p
->desired_y
+ p
->height
> r
->desired_y
)
4566 if (p
->desired_y
< r
->desired_y
)
4568 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4569 p
->height
= r
->desired_y
- p
->desired_y
;
4574 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4577 if (p
->nrows
<= nrows_copied
)
4581 int height_copied
= (r
->desired_y
+ r
->height
4584 p
->current_vpos
+= nrows_copied
;
4585 p
->desired_vpos
+= nrows_copied
;
4586 p
->nrows
-= nrows_copied
;
4587 p
->current_y
+= height_copied
;
4588 p
->desired_y
+= height_copied
;
4589 p
->height
-= height_copied
;
4595 if (r
->current_y
!= r
->desired_y
4596 /* The condition below is equivalent to
4597 ((p->current_y >= r->desired_y
4598 && p->current_y < r->desired_y + r->height)
4599 || (p->current_y + p->height > r->desired_y
4600 && (p->current_y + p->height
4601 <= r->desired_y + r->height)))
4602 because we have 0 < p->height <= r->height. */
4603 && p
->current_y
< r
->desired_y
+ r
->height
4604 && p
->current_y
+ p
->height
> r
->desired_y
)
4607 /* Reorder runs by copied pixel lines if truncated. */
4608 if (truncated_p
&& p
->nrows
> 0)
4612 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4614 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4619 /* Assign matrix rows. */
4620 for (j
= 0; j
< r
->nrows
; ++j
)
4622 struct glyph_row
*from
, *to
;
4623 int to_overlapped_p
;
4625 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4626 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4627 to_overlapped_p
= to
->overlapped_p
;
4628 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4629 assign_row (to
, from
);
4630 /* The above `assign_row' actually does swap, so if we had
4631 an overlap in the copy destination of two runs, then
4632 the second run would assign a previously disabled bogus
4633 row. But thanks to the truncation code in the
4634 preceding for-loop, we no longer have such an overlap,
4635 and thus the assigned row should always be enabled. */
4636 xassert (to
->enabled_p
);
4637 from
->enabled_p
= 0;
4638 to
->overlapped_p
= to_overlapped_p
;
4642 /* Clear the hash table, for the next time. */
4643 for (i
= 0; i
< row_entry_idx
; ++i
)
4644 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4646 /* Value is 1 to indicate that we scrolled the display. */
4652 /************************************************************************
4654 ************************************************************************/
4656 /* Update the desired frame matrix of frame F.
4658 FORCE_P non-zero means that the update should not be stopped by
4659 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4660 should not be tried.
4662 Value is non-zero if update was stopped due to pending input. */
4665 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4667 /* Frame matrices to work on. */
4668 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4669 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4672 int preempt_count
= baud_rate
/ 2400 + 1;
4674 xassert (current_matrix
&& desired_matrix
);
4676 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4677 calculate_costs (f
);
4679 if (preempt_count
<= 0)
4682 #if !PERIODIC_PREEMPTION_CHECKING
4683 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4690 /* If we cannot insert/delete lines, it's no use trying it. */
4691 if (!FRAME_LINE_INS_DEL_OK (f
))
4694 /* See if any of the desired lines are enabled; don't compute for
4695 i/d line if just want cursor motion. */
4696 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4697 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4700 /* Try doing i/d line, if not yet inhibited. */
4701 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4702 force_p
|= scrolling (f
);
4704 /* Update the individual lines as needed. Do bottom line first. */
4705 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4706 update_frame_line (f
, desired_matrix
->nrows
- 1);
4708 /* Now update the rest of the lines. */
4709 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4711 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4713 if (FRAME_TERMCAP_P (f
))
4715 /* Flush out every so many lines.
4716 Also flush out if likely to have more than 1k buffered
4717 otherwise. I'm told that some telnet connections get
4718 really screwed by more than 1k output at once. */
4719 FILE *display_output
= FRAME_TTY (f
)->output
;
4722 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4724 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4726 fflush (display_output
);
4727 if (preempt_count
== 1)
4729 #ifdef EMACS_OUTQSIZE
4730 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4731 /* Probably not a tty. Ignore the error and reset
4733 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4736 if (baud_rate
<= outq
&& baud_rate
> 0)
4737 sleep (outq
/ baud_rate
);
4743 #if PERIODIC_PREEMPTION_CHECKING
4747 EMACS_GET_TIME (tm
);
4748 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4749 if (EMACS_TIME_NEG_P (dif
))
4751 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4752 if (detect_input_pending_ignore_squeezables ())
4757 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4758 detect_input_pending_ignore_squeezables ();
4761 update_frame_line (f
, i
);
4765 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4767 /* Now just clean up termcap drivers and set cursor, etc. */
4770 if ((cursor_in_echo_area
4771 /* If we are showing a message instead of the mini-buffer,
4772 show the cursor for the message instead of for the
4773 (now hidden) mini-buffer contents. */
4774 || (EQ (minibuf_window
, selected_window
)
4775 && EQ (minibuf_window
, echo_area_window
)
4776 && !NILP (echo_area_buffer
[0])))
4777 /* These cases apply only to the frame that contains
4778 the active mini-buffer window. */
4779 && FRAME_HAS_MINIBUF_P (f
)
4780 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4782 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4785 if (cursor_in_echo_area
< 0)
4787 /* Negative value of cursor_in_echo_area means put
4788 cursor at beginning of line. */
4794 /* Positive value of cursor_in_echo_area means put
4795 cursor at the end of the prompt. If the mini-buffer
4796 is several lines high, find the last line that has
4798 row
= FRAME_LINES (f
);
4804 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4806 /* Frame rows are filled up with spaces that
4807 must be ignored here. */
4808 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4810 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4811 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4814 && (last
- 1)->charpos
< 0)
4820 while (row
> top
&& col
== 0);
4822 /* Make sure COL is not out of range. */
4823 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4825 /* If we have another row, advance cursor into it. */
4826 if (row
< FRAME_LINES (f
) - 1)
4828 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4831 /* Otherwise move it back in range. */
4833 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4837 cursor_to (f
, row
, col
);
4841 /* We have only one cursor on terminal frames. Use it to
4842 display the cursor of the selected window. */
4843 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4844 if (w
->cursor
.vpos
>= 0
4845 /* The cursor vpos may be temporarily out of bounds
4846 in the following situation: There is one window,
4847 with the cursor in the lower half of it. The window
4848 is split, and a message causes a redisplay before
4849 a new cursor position has been computed. */
4850 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4852 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4853 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4855 if (INTEGERP (w
->left_margin_cols
))
4856 x
+= XFASTINT (w
->left_margin_cols
);
4858 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4859 cursor_to (f
, y
, x
);
4864 #if !PERIODIC_PREEMPTION_CHECKING
4868 clear_desired_matrices (f
);
4873 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4876 scrolling (struct frame
*frame
)
4878 int unchanged_at_top
, unchanged_at_bottom
;
4881 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4882 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4883 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4884 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4886 int free_at_end_vpos
= FRAME_LINES (frame
);
4887 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4888 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4890 if (!current_matrix
)
4893 /* Compute hash codes of all the lines. Also calculate number of
4894 changed lines, number of unchanged lines at the beginning, and
4895 number of unchanged lines at the end. */
4897 unchanged_at_top
= 0;
4898 unchanged_at_bottom
= FRAME_LINES (frame
);
4899 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4901 /* Give up on this scrolling if some old lines are not enabled. */
4902 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4904 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4905 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4907 /* This line cannot be redrawn, so don't let scrolling mess it. */
4908 new_hash
[i
] = old_hash
[i
];
4909 #define INFINITY 1000000 /* Taken from scroll.c */
4910 draw_cost
[i
] = INFINITY
;
4914 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4915 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4918 if (old_hash
[i
] != new_hash
[i
])
4921 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4923 else if (i
== unchanged_at_top
)
4925 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4928 /* If changed lines are few, don't allow preemption, don't scroll. */
4929 if ((!FRAME_SCROLL_REGION_OK (frame
)
4930 && changed_lines
< baud_rate
/ 2400)
4931 || unchanged_at_bottom
== FRAME_LINES (frame
))
4934 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4935 - unchanged_at_bottom
);
4937 if (FRAME_SCROLL_REGION_OK (frame
))
4938 free_at_end_vpos
-= unchanged_at_bottom
;
4939 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4940 free_at_end_vpos
= -1;
4942 /* If large window, fast terminal and few lines in common between
4943 current frame and desired frame, don't bother with i/d calc. */
4944 if (!FRAME_SCROLL_REGION_OK (frame
)
4945 && window_size
>= 18 && baud_rate
> 2400
4947 10 * scrolling_max_lines_saved (unchanged_at_top
,
4948 FRAME_LINES (frame
) - unchanged_at_bottom
,
4949 old_hash
, new_hash
, draw_cost
)))
4952 if (window_size
< 2)
4955 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4956 draw_cost
+ unchanged_at_top
- 1,
4957 old_draw_cost
+ unchanged_at_top
- 1,
4958 old_hash
+ unchanged_at_top
- 1,
4959 new_hash
+ unchanged_at_top
- 1,
4960 free_at_end_vpos
- unchanged_at_top
);
4966 /* Count the number of blanks at the start of the vector of glyphs R
4967 which is LEN glyphs long. */
4970 count_blanks (struct glyph
*r
, int len
)
4974 for (i
= 0; i
< len
; ++i
)
4975 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4982 /* Count the number of glyphs in common at the start of the glyph
4983 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4984 of STR2. Value is the number of equal glyphs equal at the start. */
4987 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4989 struct glyph
*p1
= str1
;
4990 struct glyph
*p2
= str2
;
4994 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
5001 /* Char insertion/deletion cost vector, from term.c */
5003 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
5006 /* Perform a frame-based update on line VPOS in frame FRAME. */
5009 update_frame_line (struct frame
*f
, int vpos
)
5011 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
5013 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
5014 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
5015 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
5016 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
5017 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
5018 int must_write_whole_line_p
;
5019 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
5020 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
5021 != FACE_TTY_DEFAULT_BG_COLOR
);
5023 if (colored_spaces_p
)
5026 /* Current row not enabled means it has unknown contents. We must
5027 write the whole desired line in that case. */
5028 must_write_whole_line_p
= !current_row
->enabled_p
;
5029 if (must_write_whole_line_p
)
5036 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
5037 olen
= current_row
->used
[TEXT_AREA
];
5039 /* Ignore trailing spaces, if we can. */
5040 if (!write_spaces_p
)
5041 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
5045 current_row
->enabled_p
= 1;
5046 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
5048 /* If desired line is empty, just clear the line. */
5049 if (!desired_row
->enabled_p
)
5055 nbody
= desired_row
->glyphs
[TEXT_AREA
];
5056 nlen
= desired_row
->used
[TEXT_AREA
];
5057 nend
= nbody
+ nlen
;
5059 /* If display line has unknown contents, write the whole line. */
5060 if (must_write_whole_line_p
)
5062 /* Ignore spaces at the end, if we can. */
5063 if (!write_spaces_p
)
5064 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5067 /* Write the contents of the desired line. */
5070 cursor_to (f
, vpos
, 0);
5071 write_glyphs (f
, nbody
, nlen
);
5074 /* Don't call clear_end_of_line if we already wrote the whole
5075 line. The cursor will not be at the right margin in that
5076 case but in the line below. */
5077 if (nlen
< FRAME_TOTAL_COLS (f
))
5079 cursor_to (f
, vpos
, nlen
);
5080 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5083 /* Make sure we are in the right row, otherwise cursor movement
5084 with cmgoto might use `ch' in the wrong row. */
5085 cursor_to (f
, vpos
, 0);
5087 make_current (desired_matrix
, current_matrix
, vpos
);
5091 /* Pretend trailing spaces are not there at all,
5092 unless for one reason or another we must write all spaces. */
5093 if (!write_spaces_p
)
5094 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5097 /* If there's no i/d char, quickly do the best we can without it. */
5098 if (!FRAME_CHAR_INS_DEL_OK (f
))
5102 /* Find the first glyph in desired row that doesn't agree with
5103 a glyph in the current row, and write the rest from there on. */
5104 for (i
= 0; i
< nlen
; i
++)
5106 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5108 /* Find the end of the run of different glyphs. */
5112 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5113 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5116 /* Output this run of non-matching chars. */
5117 cursor_to (f
, vpos
, i
);
5118 write_glyphs (f
, nbody
+ i
, j
- i
);
5121 /* Now find the next non-match. */
5125 /* Clear the rest of the line, or the non-clear part of it. */
5128 cursor_to (f
, vpos
, nlen
);
5129 clear_end_of_line (f
, olen
);
5132 /* Make current row = desired row. */
5133 make_current (desired_matrix
, current_matrix
, vpos
);
5137 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5138 characters in a row. */
5142 /* If current line is blank, skip over initial spaces, if
5143 possible, and write the rest. */
5147 nsp
= count_blanks (nbody
, nlen
);
5151 cursor_to (f
, vpos
, nsp
);
5152 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5155 /* Exchange contents between current_frame and new_frame. */
5156 make_current (desired_matrix
, current_matrix
, vpos
);
5160 /* Compute number of leading blanks in old and new contents. */
5161 osp
= count_blanks (obody
, olen
);
5162 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5164 /* Compute number of matching chars starting with first non-blank. */
5165 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5166 nbody
+ nsp
, nbody
+ nlen
);
5168 /* Spaces in new match implicit space past the end of old. */
5169 /* A bug causing this to be a no-op was fixed in 18.29. */
5170 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5173 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5177 /* Avoid doing insert/delete char
5178 just cause number of leading spaces differs
5179 when the following text does not match. */
5180 if (begmatch
== 0 && osp
!= nsp
)
5181 osp
= nsp
= min (osp
, nsp
);
5183 /* Find matching characters at end of line */
5186 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5188 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5193 endmatch
= obody
+ olen
- op1
;
5195 /* tem gets the distance to insert or delete.
5196 endmatch is how many characters we save by doing so.
5199 tem
= (nlen
- nsp
) - (olen
- osp
);
5201 && (!FRAME_CHAR_INS_DEL_OK (f
)
5202 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5205 /* nsp - osp is the distance to insert or delete.
5206 If that is nonzero, begmatch is known to be nonzero also.
5207 begmatch + endmatch is how much we save by doing the ins/del.
5211 && (!FRAME_CHAR_INS_DEL_OK (f
)
5212 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5216 osp
= nsp
= min (osp
, nsp
);
5219 /* Now go through the line, inserting, writing and
5220 deleting as appropriate. */
5224 cursor_to (f
, vpos
, nsp
);
5225 delete_glyphs (f
, osp
- nsp
);
5229 /* If going to delete chars later in line
5230 and insert earlier in the line,
5231 must delete first to avoid losing data in the insert */
5232 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5234 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5235 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5236 olen
= nlen
- (nsp
- osp
);
5238 cursor_to (f
, vpos
, osp
);
5239 insert_glyphs (f
, 0, nsp
- osp
);
5243 tem
= nsp
+ begmatch
+ endmatch
;
5244 if (nlen
!= tem
|| olen
!= tem
)
5246 if (!endmatch
|| nlen
== olen
)
5248 /* If new text being written reaches right margin, there is
5249 no need to do clear-to-eol at the end of this function
5250 (and it would not be safe, since cursor is not going to
5251 be "at the margin" after the text is done). */
5252 if (nlen
== FRAME_TOTAL_COLS (f
))
5255 /* Function write_glyphs is prepared to do nothing
5256 if passed a length <= 0. Check it here to avoid
5257 unnecessary cursor movement. */
5260 cursor_to (f
, vpos
, nsp
+ begmatch
);
5261 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5264 else if (nlen
> olen
)
5266 /* Here, we used to have the following simple code:
5267 ----------------------------------------
5268 write_glyphs (nbody + nsp + begmatch, olen - tem);
5269 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5270 ----------------------------------------
5271 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5272 is a padding glyph. */
5273 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5276 cursor_to (f
, vpos
, nsp
+ begmatch
);
5278 /* Calculate columns we can actually overwrite. */
5279 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5281 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5283 /* If we left columns to be overwritten, we must delete them. */
5284 del
= olen
- tem
- out
;
5286 delete_glyphs (f
, del
);
5288 /* At last, we insert columns not yet written out. */
5289 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5292 else if (olen
> nlen
)
5294 cursor_to (f
, vpos
, nsp
+ begmatch
);
5295 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5296 delete_glyphs (f
, olen
- nlen
);
5302 /* If any unerased characters remain after the new line, erase them. */
5305 cursor_to (f
, vpos
, nlen
);
5306 clear_end_of_line (f
, olen
);
5309 /* Exchange contents between current_frame and new_frame. */
5310 make_current (desired_matrix
, current_matrix
, vpos
);
5315 /***********************************************************************
5316 X/Y Position -> Buffer Position
5317 ***********************************************************************/
5319 /* Determine what's under window-relative pixel position (*X, *Y).
5320 Return the OBJECT (string or buffer) that's there.
5321 Return in *POS the position in that object.
5322 Adjust *X and *Y to character positions.
5323 Return in *DX and *DY the pixel coordinates of the click,
5324 relative to the top left corner of OBJECT, or relative to
5325 the top left corner of the character glyph at (*X, *Y)
5327 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5328 if the coordinates point to an empty area of the display. */
5331 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
)
5334 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5335 struct text_pos startp
;
5337 struct glyph_row
*row
;
5338 #ifdef HAVE_WINDOW_SYSTEM
5339 struct image
*img
= 0;
5342 void *itdata
= NULL
;
5344 /* We used to set current_buffer directly here, but that does the
5345 wrong thing with `face-remapping-alist' (bug#2044). */
5346 Fset_buffer (w
->buffer
);
5347 itdata
= bidi_shelve_cache ();
5348 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5349 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5350 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5351 start_display (&it
, w
, startp
);
5352 /* start_display takes into account the header-line row, but IT's
5353 vpos still counts from the glyph row that includes the window's
5354 start position. Adjust for a possible header-line row. */
5355 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
5359 /* First, move to the beginning of the row corresponding to *Y. We
5360 need to be in that row to get the correct value of base paragraph
5361 direction for the text at (*X, *Y). */
5362 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5364 /* TO_X is the pixel position that the iterator will compute for the
5365 glyph at *X. We add it.first_visible_x because iterator
5366 positions include the hscroll. */
5367 to_x
= x0
+ it
.first_visible_x
;
5368 if (it
.bidi_it
.paragraph_dir
== R2L
)
5369 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5370 text area. This is because the iterator, even in R2L
5371 paragraphs, delivers glyphs as if they started at the left
5372 margin of the window. (When we actually produce glyphs for
5373 display, we reverse their order in PRODUCE_GLYPHS, but the
5374 iterator doesn't know about that.) The following line adjusts
5375 the pixel position to the iterator geometry, which is what
5376 move_it_* routines use. (The -1 is because in a window whose
5377 text-area width is W, the rightmost pixel position is W-1, and
5378 it should be mirrored into zero pixel position.) */
5379 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5381 /* Now move horizontally in the row to the glyph under *X. Second
5382 argument is ZV to prevent move_it_in_display_line from matching
5383 based on buffer positions. */
5384 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5385 bidi_unshelve_cache (itdata
, 0);
5387 Fset_buffer (old_current_buffer
);
5389 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5390 *dy
= *y
- it
.current_y
;
5393 if (STRINGP (it
.string
))
5396 if (it
.what
== IT_COMPOSITION
5397 && it
.cmp_it
.nchars
> 1
5398 && it
.cmp_it
.reversed_p
)
5400 /* The current display element is a grapheme cluster in a
5401 composition. In that case, we need the position of the first
5402 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5403 it.current points to the last character of the cluster, thus
5404 we must move back to the first character of the same
5406 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5407 if (STRINGP (it
.string
))
5408 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5410 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5411 CHARPOS (pos
->pos
));
5414 #ifdef HAVE_WINDOW_SYSTEM
5415 if (it
.what
== IT_IMAGE
)
5417 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5418 && !NILP (img
->spec
))
5419 *object
= img
->spec
;
5423 if (it
.vpos
< w
->current_matrix
->nrows
5424 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5427 if (it
.hpos
< row
->used
[TEXT_AREA
])
5429 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5430 #ifdef HAVE_WINDOW_SYSTEM
5433 *dy
-= row
->ascent
- glyph
->ascent
;
5434 *dx
+= glyph
->slice
.img
.x
;
5435 *dy
+= glyph
->slice
.img
.y
;
5436 /* Image slices positions are still relative to the entire image */
5437 *width
= img
->width
;
5438 *height
= img
->height
;
5443 *width
= glyph
->pixel_width
;
5444 *height
= glyph
->ascent
+ glyph
->descent
;
5450 *height
= row
->height
;
5455 *width
= *height
= 0;
5458 /* Add extra (default width) columns if clicked after EOL. */
5459 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5461 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5470 /* Value is the string under window-relative coordinates X/Y in the
5471 mode line or header line (PART says which) of window W, or nil if none.
5472 *CHARPOS is set to the position in the string returned. */
5475 mode_line_string (struct window
*w
, enum window_part part
,
5476 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5477 int *dx
, int *dy
, int *width
, int *height
)
5479 struct glyph_row
*row
;
5480 struct glyph
*glyph
, *end
;
5482 Lisp_Object string
= Qnil
;
5484 if (part
== ON_MODE_LINE
)
5485 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5487 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5489 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5491 if (row
->mode_line_p
&& row
->enabled_p
)
5493 /* Find the glyph under X. If we find one with a string object,
5494 it's the one we were looking for. */
5495 glyph
= row
->glyphs
[TEXT_AREA
];
5496 end
= glyph
+ row
->used
[TEXT_AREA
];
5497 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5498 x0
-= glyph
->pixel_width
;
5499 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5502 string
= glyph
->object
;
5503 *charpos
= glyph
->charpos
;
5504 *width
= glyph
->pixel_width
;
5505 *height
= glyph
->ascent
+ glyph
->descent
;
5506 #ifdef HAVE_WINDOW_SYSTEM
5507 if (glyph
->type
== IMAGE_GLYPH
)
5510 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5512 *object
= img
->spec
;
5513 y0
-= row
->ascent
- glyph
->ascent
;
5519 /* Add extra (default width) columns if clicked after EOL. */
5520 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5522 *height
= row
->height
;
5529 *width
= *height
= 0;
5539 /* Value is the string under window-relative coordinates X/Y in either
5540 marginal area, or nil if none. *CHARPOS is set to the position in
5541 the string returned. */
5544 marginal_area_string (struct window
*w
, enum window_part part
,
5545 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5546 int *dx
, int *dy
, int *width
, int *height
)
5548 struct glyph_row
*row
= w
->current_matrix
->rows
;
5549 struct glyph
*glyph
, *end
;
5550 int x0
, y0
, i
, wy
= *y
;
5552 Lisp_Object string
= Qnil
;
5554 if (part
== ON_LEFT_MARGIN
)
5555 area
= LEFT_MARGIN_AREA
;
5556 else if (part
== ON_RIGHT_MARGIN
)
5557 area
= RIGHT_MARGIN_AREA
;
5561 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5562 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5565 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5569 /* Find the glyph under X. If we find one with a string object,
5570 it's the one we were looking for. */
5571 if (area
== RIGHT_MARGIN_AREA
)
5572 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5573 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5574 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5575 + window_box_width (w
, LEFT_MARGIN_AREA
)
5576 + window_box_width (w
, TEXT_AREA
));
5578 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5579 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5582 glyph
= row
->glyphs
[area
];
5583 end
= glyph
+ row
->used
[area
];
5584 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5585 x0
-= glyph
->pixel_width
;
5586 *x
= glyph
- row
->glyphs
[area
];
5589 string
= glyph
->object
;
5590 *charpos
= glyph
->charpos
;
5591 *width
= glyph
->pixel_width
;
5592 *height
= glyph
->ascent
+ glyph
->descent
;
5593 #ifdef HAVE_WINDOW_SYSTEM
5594 if (glyph
->type
== IMAGE_GLYPH
)
5597 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5599 *object
= img
->spec
;
5600 y0
-= row
->ascent
- glyph
->ascent
;
5601 x0
+= glyph
->slice
.img
.x
;
5602 y0
+= glyph
->slice
.img
.y
;
5608 /* Add extra (default width) columns if clicked after EOL. */
5609 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5611 *height
= row
->height
;
5618 *width
= *height
= 0;
5628 /***********************************************************************
5629 Changing Frame Sizes
5630 ***********************************************************************/
5635 window_change_signal (int signalnum
) /* If we don't have an argument, */
5636 /* some compilers complain in signal calls. */
5639 int old_errno
= errno
;
5641 struct tty_display_info
*tty
;
5643 signal (SIGWINCH
, window_change_signal
);
5644 SIGNAL_THREAD_CHECK (signalnum
);
5646 /* The frame size change obviously applies to a single
5647 termcap-controlled terminal, but we can't decide which.
5648 Therefore, we resize the frames corresponding to each tty.
5650 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5652 if (! tty
->term_initted
)
5655 /* Suspended tty frames have tty->input == NULL avoid trying to
5660 get_tty_size (fileno (tty
->input
), &width
, &height
);
5662 if (width
> 5 && height
> 2) {
5663 Lisp_Object tail
, frame
;
5665 FOR_EACH_FRAME (tail
, frame
)
5666 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5667 /* Record the new sizes, but don't reallocate the data
5668 structures now. Let that be done later outside of the
5670 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5676 #endif /* SIGWINCH */
5679 /* Do any change in frame size that was requested by a signal. SAFE
5680 non-zero means this function is called from a place where it is
5681 safe to change frame sizes while a redisplay is in progress. */
5684 do_pending_window_change (int safe
)
5686 /* If window_change_signal should have run before, run it now. */
5687 if (redisplaying_p
&& !safe
)
5690 while (delayed_size_change
)
5692 Lisp_Object tail
, frame
;
5694 delayed_size_change
= 0;
5696 FOR_EACH_FRAME (tail
, frame
)
5698 struct frame
*f
= XFRAME (frame
);
5700 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5701 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5708 /* Change the frame height and/or width. Values may be given as zero to
5709 indicate no change is to take place.
5711 If DELAY is non-zero, then assume we're being called from a signal
5712 handler, and queue the change for later - perhaps the next
5713 redisplay. Since this tries to resize windows, we can't call it
5714 from a signal handler.
5716 SAFE non-zero means this function is called from a place where it's
5717 safe to change frame sizes while a redisplay is in progress. */
5720 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5722 Lisp_Object tail
, frame
;
5724 if (FRAME_MSDOS_P (f
))
5726 /* On MS-DOS, all frames use the same screen, so a change in
5727 size affects all frames. Termcap now supports multiple
5729 FOR_EACH_FRAME (tail
, frame
)
5730 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5731 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5732 pretend
, delay
, safe
);
5735 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5739 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5741 int new_frame_total_cols
;
5742 ptrdiff_t count
= SPECPDL_INDEX ();
5744 /* If we can't deal with the change now, queue it for later. */
5745 if (delay
|| (redisplaying_p
&& !safe
))
5747 f
->new_text_lines
= newheight
;
5748 f
->new_text_cols
= newwidth
;
5749 delayed_size_change
= 1;
5753 /* This size-change overrides any pending one for this frame. */
5754 f
->new_text_lines
= 0;
5755 f
->new_text_cols
= 0;
5757 /* If an argument is zero, set it to the current value. */
5759 newheight
= FRAME_LINES (f
);
5761 newwidth
= FRAME_COLS (f
);
5763 /* Compute width of windows in F. */
5764 /* Round up to the smallest acceptable size. */
5765 check_frame_size (f
, &newheight
, &newwidth
);
5767 /* This is the width of the frame with vertical scroll bars and fringe
5768 columns. Do this after rounding - see discussion of bug#9723. */
5769 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5771 /* If we're not changing the frame size, quit now. */
5772 /* Frame width may be unchanged but the text portion may change, for
5773 example, fullscreen and remove/add scroll bar. */
5774 if (newheight
== FRAME_LINES (f
)
5775 /* Text portion unchanged? */
5776 && newwidth
== FRAME_COLS (f
)
5777 /* Frame width unchanged? */
5778 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5784 /* We only can set screen dimensions to certain values supported
5785 by our video hardware. Try to find the smallest size greater
5786 or equal to the requested dimensions. */
5787 dos_set_window_size (&newheight
, &newwidth
);
5790 if (newheight
!= FRAME_LINES (f
))
5792 resize_frame_windows (f
, newheight
, 0);
5794 /* MSDOS frames cannot PRETEND, as they change frame size by
5795 manipulating video hardware. */
5796 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5797 FrameRows (FRAME_TTY (f
)) = newheight
;
5800 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5802 resize_frame_windows (f
, new_frame_total_cols
, 1);
5804 /* MSDOS frames cannot PRETEND, as they change frame size by
5805 manipulating video hardware. */
5806 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5807 FrameCols (FRAME_TTY (f
)) = newwidth
;
5809 if (WINDOWP (f
->tool_bar_window
))
5810 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5813 FRAME_LINES (f
) = newheight
;
5814 SET_FRAME_COLS (f
, newwidth
);
5817 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5818 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5820 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5822 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5823 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5824 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5825 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5829 calculate_costs (f
);
5830 SET_FRAME_GARBAGED (f
);
5835 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5837 run_window_configuration_change_hook (f
);
5839 unbind_to (count
, Qnil
);
5844 /***********************************************************************
5845 Terminal Related Lisp Functions
5846 ***********************************************************************/
5848 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5849 1, 1, "FOpen termscript file: ",
5850 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5851 FILE = nil means just close any termscript file currently open. */)
5854 struct tty_display_info
*tty
;
5856 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5857 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5858 error ("Current frame is not on a tty device");
5862 if (tty
->termscript
!= 0)
5865 fclose (tty
->termscript
);
5868 tty
->termscript
= 0;
5872 file
= Fexpand_file_name (file
, Qnil
);
5873 tty
->termscript
= fopen (SSDATA (file
), "w");
5874 if (tty
->termscript
== 0)
5875 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5881 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5882 Ssend_string_to_terminal
, 1, 2, 0,
5883 doc
: /* Send STRING to the terminal without alteration.
5884 Control characters in STRING will have terminal-dependent effects.
5886 Optional parameter TERMINAL specifies the tty terminal device to use.
5887 It may be a terminal object, a frame, or nil for the terminal used by
5888 the currently selected frame. In batch mode, STRING is sent to stdout
5889 when TERMINAL is nil. */)
5890 (Lisp_Object string
, Lisp_Object terminal
)
5892 struct terminal
*t
= get_terminal (terminal
, 1);
5895 /* ??? Perhaps we should do something special for multibyte strings here. */
5896 CHECK_STRING (string
);
5900 error ("Unknown terminal device");
5902 if (t
->type
== output_initial
)
5904 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5905 error ("Device %d is not a termcap terminal device", t
->id
);
5908 struct tty_display_info
*tty
= t
->display_info
.tty
;
5911 error ("Terminal is currently suspended");
5913 if (tty
->termscript
)
5915 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5916 fflush (tty
->termscript
);
5920 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5927 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5928 doc
: /* Beep, or flash the screen.
5929 Also, unless an argument is given,
5930 terminate any keyboard macro currently executing. */)
5938 ring_bell (XFRAME (selected_frame
));
5947 bitch_at_user (void)
5951 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5952 error ("Keyboard macro terminated by a command ringing the bell");
5954 ring_bell (XFRAME (selected_frame
));
5959 /***********************************************************************
5961 ***********************************************************************/
5963 /* Convert a positive value DURATION to a seconds count *PSEC plus a
5964 microseconds count *PUSEC, rounding up. On overflow return the
5967 duration_to_sec_usec (double duration
, int *psec
, int *pusec
)
5969 int MILLION
= 1000000;
5970 int sec
= INT_MAX
, usec
= MILLION
- 1;
5972 if (duration
< INT_MAX
+ 1.0)
5975 double usdouble
= (duration
- s
) * MILLION
;
5976 int usfloor
= usdouble
;
5977 int usceil
= usfloor
+ (usfloor
< usdouble
);
5979 if (usceil
< MILLION
)
5984 else if (sec
< INT_MAX
)
5995 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5996 doc
: /* Pause, without updating display, for SECONDS seconds.
5997 SECONDS may be a floating-point value, meaning that you can wait for a
5998 fraction of a second. Optional second arg MILLISECONDS specifies an
5999 additional wait period, in milliseconds; this may be useful if your
6000 Emacs was built without floating point support.
6001 \(Not all operating systems support waiting for a fraction of a second.) */)
6002 (Lisp_Object seconds
, Lisp_Object milliseconds
)
6005 double duration
= extract_float (seconds
);
6007 if (!NILP (milliseconds
))
6009 CHECK_NUMBER (milliseconds
);
6010 duration
+= XINT (milliseconds
) / 1000.0;
6013 if (! (0 < duration
))
6016 duration_to_sec_usec (duration
, &sec
, &usec
);
6018 #ifndef EMACS_HAS_USECS
6019 if (sec
== 0 && usec
!= 0)
6020 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
6023 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
6029 /* This is just like wait_reading_process_output, except that
6032 TIMEOUT is number of seconds to wait (float or integer),
6033 or t to wait forever.
6034 READING is 1 if reading input.
6035 If DO_DISPLAY is >0 display process output while waiting.
6036 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
6040 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
6044 swallow_events (do_display
);
6046 if ((detect_input_pending_run_timers (do_display
))
6047 || !NILP (Vexecuting_kbd_macro
))
6050 if (do_display
>= 2)
6051 redisplay_preserve_echo_area (2);
6053 if (EQ (timeout
, Qt
))
6060 double duration
= extract_float (timeout
);
6062 if (! (0 < duration
))
6065 duration_to_sec_usec (duration
, &sec
, &usec
);
6072 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
6075 return detect_input_pending () ? Qnil
: Qt
;
6079 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
6080 doc
: /* Perform redisplay if no input is available.
6081 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
6082 perform a full redisplay even if input is available.
6083 Return t if redisplay was performed, nil otherwise. */)
6089 if ((detect_input_pending_run_timers (1)
6090 && NILP (force
) && !redisplay_dont_pause
)
6091 || !NILP (Vexecuting_kbd_macro
))
6094 count
= SPECPDL_INDEX ();
6095 if (!NILP (force
) && !redisplay_dont_pause
)
6096 specbind (Qredisplay_dont_pause
, Qt
);
6097 redisplay_preserve_echo_area (2);
6098 unbind_to (count
, Qnil
);
6104 /***********************************************************************
6105 Other Lisp Functions
6106 ***********************************************************************/
6108 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6109 session's frames, frame names, buffers, buffer-read-only flags, and
6110 buffer-modified-flags. */
6112 static Lisp_Object frame_and_buffer_state
;
6115 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6116 Sframe_or_buffer_changed_p
, 0, 1, 0,
6117 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6118 VARIABLE is a variable name whose value is either nil or a state vector
6119 that will be updated to contain all frames and buffers,
6120 aside from buffers whose names start with space,
6121 along with the buffers' read-only and modified flags. This allows a fast
6122 check to see whether buffer menus might need to be recomputed.
6123 If this function returns non-nil, it updates the internal vector to reflect
6126 If VARIABLE is nil, an internal variable is used. Users should not
6127 pass nil for VARIABLE. */)
6128 (Lisp_Object variable
)
6130 Lisp_Object state
, tail
, frame
, buf
;
6131 Lisp_Object
*vecp
, *end
;
6134 if (! NILP (variable
))
6136 CHECK_SYMBOL (variable
);
6137 state
= Fsymbol_value (variable
);
6138 if (! VECTORP (state
))
6142 state
= frame_and_buffer_state
;
6144 vecp
= XVECTOR (state
)->contents
;
6145 end
= vecp
+ ASIZE (state
);
6147 FOR_EACH_FRAME (tail
, frame
)
6151 if (!EQ (*vecp
++, frame
))
6155 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6158 /* Check that the buffer info matches. */
6159 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6161 buf
= XCDR (XCAR (tail
));
6162 /* Ignore buffers that aren't included in buffer lists. */
6163 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6167 if (!EQ (*vecp
++, buf
))
6171 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6175 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6180 /* Detect deletion of a buffer at the end of the list. */
6181 if (EQ (*vecp
, Qlambda
))
6184 /* Come here if we decide the data has changed. */
6186 /* Count the size we will need.
6187 Start with 1 so there is room for at least one lambda at the end. */
6189 FOR_EACH_FRAME (tail
, frame
)
6191 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6193 /* Reallocate the vector if data has grown to need it,
6194 or if it has shrunk a lot. */
6195 if (! VECTORP (state
)
6196 || n
> ASIZE (state
)
6197 || n
+ 20 < ASIZE (state
) / 2)
6198 /* Add 20 extra so we grow it less often. */
6200 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6201 if (! NILP (variable
))
6202 Fset (variable
, state
);
6204 frame_and_buffer_state
= state
;
6207 /* Record the new data in the (possibly reallocated) vector. */
6208 vecp
= XVECTOR (state
)->contents
;
6209 FOR_EACH_FRAME (tail
, frame
)
6212 *vecp
++ = XFRAME (frame
)->name
;
6214 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6216 buf
= XCDR (XCAR (tail
));
6217 /* Ignore buffers that aren't included in buffer lists. */
6218 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6221 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6222 *vecp
++ = Fbuffer_modified_p (buf
);
6224 /* Fill up the vector with lambdas (always at least one). */
6226 while (vecp
- XVECTOR (state
)->contents
6229 /* Make sure we didn't overflow the vector. */
6230 if (vecp
- XVECTOR (state
)->contents
6238 /***********************************************************************
6240 ***********************************************************************/
6242 /* Initialization done when Emacs fork is started, before doing stty.
6243 Determine terminal type and set terminal_driver. Then invoke its
6244 decoding routine to set up variables in the terminal package. */
6249 char *terminal_type
;
6251 /* Construct the space glyph. */
6252 space_glyph
.type
= CHAR_GLYPH
;
6253 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6254 space_glyph
.charpos
= -1;
6257 cursor_in_echo_area
= 0;
6258 terminal_type
= (char *) 0;
6260 /* Now is the time to initialize this; it's used by init_sys_modes
6262 Vinitial_window_system
= Qnil
;
6264 /* SIGWINCH needs to be handled no matter what display we start
6265 with. Otherwise newly opened tty frames will not resize
6270 #endif /* CANNOT_DUMP */
6271 signal (SIGWINCH
, window_change_signal
);
6272 #endif /* SIGWINCH */
6274 /* If running as a daemon, no need to initialize any frames/terminal. */
6278 /* If the user wants to use a window system, we shouldn't bother
6279 initializing the terminal. This is especially important when the
6280 terminal is so dumb that emacs gives up before and doesn't bother
6281 using the window system.
6283 If the DISPLAY environment variable is set and nonempty,
6284 try to use X, and die with an error message if that doesn't work. */
6286 #ifdef HAVE_X_WINDOWS
6287 if (! inhibit_window_system
&& ! display_arg
)
6290 display
= getenv ("DISPLAY");
6291 display_arg
= (display
!= 0 && *display
!= 0);
6293 if (display_arg
&& !x_display_ok (display
))
6295 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6297 inhibit_window_system
= 1;
6301 if (!inhibit_window_system
&& display_arg
)
6303 Vinitial_window_system
= Qx
;
6305 Vwindow_system_version
= make_number (11);
6307 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6308 /* In some versions of ncurses,
6309 tputs crashes if we have not called tgetent.
6311 { char b
[2044]; tgetent (b
, "xterm");}
6313 adjust_frame_glyphs_initially ();
6316 #endif /* HAVE_X_WINDOWS */
6319 if (!inhibit_window_system
)
6321 Vinitial_window_system
= Qw32
;
6322 Vwindow_system_version
= make_number (1);
6323 adjust_frame_glyphs_initially ();
6326 #endif /* HAVE_NTGUI */
6329 if (!inhibit_window_system
6335 Vinitial_window_system
= Qns
;
6336 Vwindow_system_version
= make_number (10);
6337 adjust_frame_glyphs_initially ();
6342 /* If no window system has been specified, try to use the terminal. */
6345 fatal ("standard input is not a tty");
6350 terminal_type
= "w32console";
6352 /* Look at the TERM variable. */
6353 terminal_type
= (char *) getenv ("TERM");
6357 #ifdef HAVE_WINDOW_SYSTEM
6358 if (! inhibit_window_system
)
6359 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6361 #endif /* HAVE_WINDOW_SYSTEM */
6362 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6368 struct frame
*f
= XFRAME (selected_frame
);
6370 /* Open a display on the controlling tty. */
6371 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6373 /* Convert the initial frame to use the new display. */
6374 if (f
->output_method
!= output_initial
)
6376 f
->output_method
= t
->type
;
6379 t
->reference_count
++;
6381 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6383 if (f
->output_method
== output_termcap
)
6384 create_tty_output (f
);
6386 t
->display_info
.tty
->top_frame
= selected_frame
;
6387 change_frame_size (XFRAME (selected_frame
),
6388 FrameRows (t
->display_info
.tty
),
6389 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6391 /* Delete the initial terminal. */
6392 if (--initial_terminal
->reference_count
== 0
6393 && initial_terminal
->delete_terminal_hook
)
6394 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6396 /* Update frame parameters to reflect the new type. */
6397 Fmodify_frame_parameters
6398 (selected_frame
, Fcons (Fcons (Qtty_type
,
6399 Ftty_type (selected_frame
)), Qnil
));
6400 if (t
->display_info
.tty
->name
)
6401 Fmodify_frame_parameters (selected_frame
,
6402 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6405 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6410 struct frame
*sf
= SELECTED_FRAME ();
6411 int width
= FRAME_TOTAL_COLS (sf
);
6412 int height
= FRAME_LINES (sf
);
6414 /* If these sizes are so big they cause overflow, just ignore the
6415 change. It's not clear what better we could do. The rest of
6416 the code assumes that (width + 2) * height * sizeof (struct glyph)
6417 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6418 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6419 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6420 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6421 < (width
+ 2) * height
))
6422 fatal ("screen size %dx%d too big", width
, height
);
6425 adjust_frame_glyphs_initially ();
6426 calculate_costs (XFRAME (selected_frame
));
6428 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6431 && NILP (Vinitial_window_system
))
6433 /* For the initial frame, we don't have any way of knowing what
6434 are the foreground and background colors of the terminal. */
6435 struct frame
*sf
= SELECTED_FRAME ();
6437 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6438 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6439 call0 (intern ("tty-set-up-initial-frame-faces"));
6445 /***********************************************************************
6447 ***********************************************************************/
6449 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6450 Sinternal_show_cursor
, 2, 2, 0,
6451 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6452 WINDOW nil means use the selected window. SHOW non-nil means
6453 show a cursor in WINDOW in the next redisplay. SHOW nil means
6454 don't show a cursor. */)
6455 (Lisp_Object window
, Lisp_Object show
)
6457 /* Don't change cursor state while redisplaying. This could confuse
6459 if (!redisplaying_p
)
6462 window
= selected_window
;
6464 CHECK_WINDOW (window
);
6466 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6473 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6474 Sinternal_show_cursor_p
, 0, 1, 0,
6475 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6476 WINDOW nil or omitted means report on the selected window. */)
6477 (Lisp_Object window
)
6482 window
= selected_window
;
6484 CHECK_WINDOW (window
);
6486 w
= XWINDOW (window
);
6487 return w
->cursor_off_p
? Qnil
: Qt
;
6490 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6491 Slast_nonminibuf_frame
, 0, 0, 0,
6492 doc
: /* Value is last nonminibuffer frame. */)
6495 Lisp_Object frame
= Qnil
;
6497 if (last_nonminibuf_frame
)
6498 XSETFRAME (frame
, last_nonminibuf_frame
);
6503 /***********************************************************************
6505 ***********************************************************************/
6508 syms_of_display (void)
6510 defsubr (&Sredraw_frame
);
6511 defsubr (&Sredraw_display
);
6512 defsubr (&Sframe_or_buffer_changed_p
);
6513 defsubr (&Sopen_termscript
);
6515 defsubr (&Sredisplay
);
6516 defsubr (&Ssleep_for
);
6517 defsubr (&Ssend_string_to_terminal
);
6518 defsubr (&Sinternal_show_cursor
);
6519 defsubr (&Sinternal_show_cursor_p
);
6520 defsubr (&Slast_nonminibuf_frame
);
6523 defsubr (&Sdump_redisplay_history
);
6526 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6527 staticpro (&frame_and_buffer_state
);
6529 DEFSYM (Qdisplay_table
, "display-table");
6530 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6532 DEFVAR_INT ("baud-rate", baud_rate
,
6533 doc
: /* *The output baud rate of the terminal.
6534 On most systems, changing this value will affect the amount of padding
6535 and the other strategic decisions made during redisplay. */);
6537 DEFVAR_BOOL ("inverse-video", inverse_video
,
6538 doc
: /* *Non-nil means invert the entire frame display.
6539 This means everything is in inverse video which otherwise would not be. */);
6541 DEFVAR_BOOL ("visible-bell", visible_bell
,
6542 doc
: /* *Non-nil means try to flash the frame to represent a bell.
6544 See also `ring-bell-function'. */);
6546 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6547 doc
: /* *Non-nil means no need to redraw entire frame after suspending.
6548 A non-nil value is useful if the terminal can automatically preserve
6549 Emacs's frame display when you reenter Emacs.
6550 It is up to you to set this variable if your terminal can do that. */);
6552 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6553 doc
: /* Name of the window system that Emacs uses for the first frame.
6554 The value is a symbol:
6555 nil for a termcap frame (a character-only terminal),
6556 'x' for an Emacs frame that is really an X window,
6557 'w32' for an Emacs frame that is a window on MS-Windows display,
6558 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6559 'pc' for a direct-write MS-DOS frame.
6561 Use of this variable as a boolean is deprecated. Instead,
6562 use `display-graphic-p' or any of the other `display-*-p'
6563 predicates which report frame's specific UI-related capabilities. */);
6565 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6566 doc
: /* Name of window system through which the selected frame is displayed.
6567 The value is a symbol:
6568 nil for a termcap frame (a character-only terminal),
6569 'x' for an Emacs frame that is really an X window,
6570 'w32' for an Emacs frame that is a window on MS-Windows display,
6571 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6572 'pc' for a direct-write MS-DOS frame.
6574 Use of this variable as a boolean is deprecated. Instead,
6575 use `display-graphic-p' or any of the other `display-*-p'
6576 predicates which report frame's specific UI-related capabilities. */);
6578 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6579 doc
: /* The version number of the window system in use.
6580 For X windows, this is 11. */);
6582 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6583 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6585 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6586 doc
: /* Table defining how to output a glyph code to the frame.
6587 If not nil, this is a vector indexed by glyph code to define the glyph.
6588 Each element can be:
6589 integer: a glyph code which this glyph is an alias for.
6590 string: output this glyph using that string (not impl. in X windows).
6591 nil: this glyph mod 524288 is the code of a character to output,
6592 and this glyph / 524288 is the face number (see `face-id') to use
6593 while outputting it. */);
6594 Vglyph_table
= Qnil
;
6596 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6597 doc
: /* Display table to use for buffers that specify none.
6598 See `buffer-display-table' for more information. */);
6599 Vstandard_display_table
= Qnil
;
6601 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6602 doc
: /* *Non-nil means display update isn't paused when input is detected. */);
6603 redisplay_dont_pause
= 1;
6605 #if PERIODIC_PREEMPTION_CHECKING
6606 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6607 doc
: /* *The period in seconds between checking for input during redisplay.
6608 If input is detected, redisplay is pre-empted, and the input is processed.
6609 If nil, never pre-empt redisplay. */);
6610 Vredisplay_preemption_period
= make_float (0.10);
6617 Vinitial_window_system
= Qnil
;
6618 Vwindow_system_version
= Qnil
;