1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 /* cm.h must come after dispextern.h on Windows. */
30 #include "dispextern.h"
33 #include "character.h"
36 #include "termhooks.h"
41 #include "intervals.h"
42 #include "blockinput.h"
45 #include "syssignal.h"
49 #endif /* HAVE_X_WINDOWS */
53 #endif /* HAVE_NTGUI */
59 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
64 /* Get number of chars of output now in the buffer of a stdio stream.
65 This ought to be built in in stdio, but it isn't. Some s- files
66 override this because their stdio internals differ. */
68 #ifdef __GNU_LIBRARY__
70 /* The s- file might have overridden the definition with one that
71 works for the system's C library. But we are using the GNU C
72 library, so this is the right definition for every system. */
74 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
75 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
77 #undef PENDING_OUTPUT_COUNT
78 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
80 #else /* not __GNU_LIBRARY__ */
81 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
82 #include <stdio_ext.h>
83 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
85 #ifndef PENDING_OUTPUT_COUNT
86 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
88 #endif /* not __GNU_LIBRARY__ */
90 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
91 #include <term.h> /* for tgetent */
94 /* Structure to pass dimensions around. Used for character bounding
95 boxes, glyph matrix dimensions and alike. */
104 /* Function prototypes. */
106 static 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
*, EMACS_INT
, EMACS_INT
);
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 sprintf (buf
, "%"pMu
": window %p (`%s')%s\n",
278 ((BUFFERP (w
->buffer
)
279 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
280 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
282 paused_p
? " ***paused***" : "");
287 /* Add to the redisplay history that frame F has been displayed.
288 PAUSED_P non-zero means that the update has been interrupted for
292 add_frame_display_history (struct frame
*f
, int paused_p
)
296 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
298 buf
= redisplay_history
[history_idx
].trace
;
301 sprintf (buf
, "%"pMu
": update frame %p%s",
303 f
, paused_p
? " ***paused***" : "");
307 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
308 Sdump_redisplay_history
, 0, 0, "",
309 doc
: /* Dump redisplay history to stderr. */)
314 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
317 i
= REDISPLAY_HISTORY_SIZE
- 1;
318 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
325 #else /* GLYPH_DEBUG == 0 */
327 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
328 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
330 #endif /* GLYPH_DEBUG == 0 */
333 #if defined PROFILING && !HAVE___EXECUTABLE_START
334 /* FIXME: only used to find text start for profiling. */
337 safe_bcopy (const char *from
, char *to
, int size
)
343 /***********************************************************************
345 ***********************************************************************/
347 /* Allocate and return a glyph_matrix structure. POOL is the glyph
348 pool from which memory for the matrix should be allocated, or null
349 for window-based redisplay where no glyph pools are used. The
350 member `pool' of the glyph matrix structure returned is set to
351 POOL, the structure is otherwise zeroed. */
353 static struct glyph_matrix
*
354 new_glyph_matrix (struct glyph_pool
*pool
)
356 struct glyph_matrix
*result
;
358 /* Allocate and clear. */
359 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
360 memset (result
, 0, sizeof *result
);
362 /* Increment number of allocated matrices. This count is used
363 to detect memory leaks. */
364 ++glyph_matrix_count
;
366 /* Set pool and return. */
372 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
374 The global counter glyph_matrix_count is decremented when a matrix
375 is freed. If the count gets negative, more structures were freed
376 than allocated, i.e. one matrix was freed more than once or a bogus
377 pointer was passed to this function.
379 If MATRIX->pool is null, this means that the matrix manages its own
380 glyph memory---this is done for matrices on X frames. Freeing the
381 matrix also frees the glyph memory in this case. */
384 free_glyph_matrix (struct glyph_matrix
*matrix
)
390 /* Detect the case that more matrices are freed than were
392 if (--glyph_matrix_count
< 0)
395 /* Free glyph memory if MATRIX owns it. */
396 if (matrix
->pool
== NULL
)
397 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
398 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
400 /* Free row structures and the matrix itself. */
401 xfree (matrix
->rows
);
407 /* Return the number of glyphs to reserve for a marginal area of
408 window W. TOTAL_GLYPHS is the number of glyphs in a complete
409 display line of window W. MARGIN gives the width of the marginal
410 area in canonical character units. MARGIN should be an integer
414 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
418 if (NUMBERP (margin
))
420 int width
= XFASTINT (w
->total_cols
);
421 double d
= max (0, XFLOATINT (margin
));
422 d
= min (width
/ 2 - 1, d
);
423 n
= (int) ((double) total_glyphs
/ width
* d
);
432 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
435 W is null if the function is called for a frame glyph matrix.
436 Otherwise it is the window MATRIX is a member of. X and Y are the
437 indices of the first column and row of MATRIX within the frame
438 matrix, if such a matrix exists. They are zero for purely
439 window-based redisplay. DIM is the needed size of the matrix.
441 In window-based redisplay, where no frame matrices exist, glyph
442 matrices manage their own glyph storage. Otherwise, they allocate
443 storage from a common frame glyph pool which can be found in
446 The reason for this memory management strategy is to avoid complete
447 frame redraws if possible. When we allocate from a common pool, a
448 change of the location or size of a sub-matrix within the pool
449 requires a complete redisplay of the frame because we cannot easily
450 make sure that the current matrices of all windows still agree with
451 what is displayed on the screen. While this is usually fast, it
452 leads to screen flickering. */
455 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
459 int marginal_areas_changed_p
= 0;
460 int header_line_changed_p
= 0;
461 int header_line_p
= 0;
462 int left
= -1, right
= -1;
463 int window_width
= -1, window_height
= -1;
465 /* See if W had a header line that has disappeared now, or vice versa.
469 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
471 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
472 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
474 matrix
->header_line_p
= header_line_p
;
476 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
477 Do nothing if MATRIX' size, position, vscroll, and marginal areas
478 haven't changed. This optimization is important because preserving
479 the matrix means preventing redisplay. */
480 if (matrix
->pool
== NULL
)
482 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
483 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
484 xassert (left
>= 0 && right
>= 0);
485 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
486 || right
!= matrix
->right_margin_glyphs
);
488 if (!marginal_areas_changed_p
490 && !header_line_changed_p
491 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
492 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
493 && matrix
->window_height
== window_height
494 && matrix
->window_vscroll
== w
->vscroll
495 && matrix
->window_width
== window_width
)
499 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
500 if (matrix
->rows_allocated
< dim
.height
)
502 ptrdiff_t size
= dim
.height
* sizeof (struct glyph_row
);
503 new_rows
= dim
.height
- matrix
->rows_allocated
;
504 matrix
->rows
= (struct glyph_row
*) xrealloc (matrix
->rows
, size
);
505 memset (matrix
->rows
+ matrix
->rows_allocated
, 0,
506 new_rows
* sizeof *matrix
->rows
);
507 matrix
->rows_allocated
= dim
.height
;
512 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
513 on a frame not using window-based redisplay. Set up pointers for
514 each row into the glyph pool. */
517 xassert (matrix
->pool
->glyphs
);
521 left
= margin_glyphs_to_reserve (w
, dim
.width
,
522 w
->left_margin_cols
);
523 right
= margin_glyphs_to_reserve (w
, dim
.width
,
524 w
->right_margin_cols
);
529 for (i
= 0; i
< dim
.height
; ++i
)
531 struct glyph_row
*row
= &matrix
->rows
[i
];
533 row
->glyphs
[LEFT_MARGIN_AREA
]
534 = (matrix
->pool
->glyphs
535 + (y
+ i
) * matrix
->pool
->ncolumns
539 || row
== matrix
->rows
+ dim
.height
- 1
540 || (row
== matrix
->rows
&& matrix
->header_line_p
))
542 row
->glyphs
[TEXT_AREA
]
543 = row
->glyphs
[LEFT_MARGIN_AREA
];
544 row
->glyphs
[RIGHT_MARGIN_AREA
]
545 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
546 row
->glyphs
[LAST_AREA
]
547 = row
->glyphs
[RIGHT_MARGIN_AREA
];
551 row
->glyphs
[TEXT_AREA
]
552 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
553 row
->glyphs
[RIGHT_MARGIN_AREA
]
554 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
555 row
->glyphs
[LAST_AREA
]
556 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
560 matrix
->left_margin_glyphs
= left
;
561 matrix
->right_margin_glyphs
= right
;
565 /* If MATRIX->pool is null, MATRIX is responsible for managing
566 its own memory. It is a window matrix for window-based redisplay.
567 Allocate glyph memory from the heap. */
568 if (dim
.width
> matrix
->matrix_w
570 || header_line_changed_p
571 || marginal_areas_changed_p
)
573 struct glyph_row
*row
= matrix
->rows
;
574 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
578 row
->glyphs
[LEFT_MARGIN_AREA
]
579 = (struct glyph
*) xrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
581 * sizeof (struct glyph
)));
583 /* The mode line never has marginal areas. */
584 if (row
== matrix
->rows
+ dim
.height
- 1
585 || (row
== matrix
->rows
&& matrix
->header_line_p
))
587 row
->glyphs
[TEXT_AREA
]
588 = row
->glyphs
[LEFT_MARGIN_AREA
];
589 row
->glyphs
[RIGHT_MARGIN_AREA
]
590 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
591 row
->glyphs
[LAST_AREA
]
592 = row
->glyphs
[RIGHT_MARGIN_AREA
];
596 row
->glyphs
[TEXT_AREA
]
597 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
598 row
->glyphs
[RIGHT_MARGIN_AREA
]
599 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
600 row
->glyphs
[LAST_AREA
]
601 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
607 xassert (left
>= 0 && right
>= 0);
608 matrix
->left_margin_glyphs
= left
;
609 matrix
->right_margin_glyphs
= right
;
612 /* Number of rows to be used by MATRIX. */
613 matrix
->nrows
= dim
.height
;
614 xassert (matrix
->nrows
>= 0);
618 if (matrix
== w
->current_matrix
)
620 /* Mark rows in a current matrix of a window as not having
621 valid contents. It's important to not do this for
622 desired matrices. When Emacs starts, it may already be
623 building desired matrices when this function runs. */
624 if (window_width
< 0)
625 window_width
= window_box_width (w
, -1);
627 /* Optimize the case that only the height has changed (C-x 2,
628 upper window). Invalidate all rows that are no longer part
630 if (!marginal_areas_changed_p
631 && !header_line_changed_p
633 && dim
.width
== matrix
->matrix_w
634 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
635 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
636 && matrix
->window_width
== window_width
)
638 /* Find the last row in the window. */
639 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
640 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
646 /* Window end is invalid, if inside of the rows that
647 are invalidated below. */
648 if (INTEGERP (w
->window_end_vpos
)
649 && XFASTINT (w
->window_end_vpos
) >= i
)
650 w
->window_end_valid
= Qnil
;
652 while (i
< matrix
->nrows
)
653 matrix
->rows
[i
++].enabled_p
= 0;
657 for (i
= 0; i
< matrix
->nrows
; ++i
)
658 matrix
->rows
[i
].enabled_p
= 0;
661 else if (matrix
== w
->desired_matrix
)
663 /* Rows in desired matrices always have to be cleared;
664 redisplay expects this is the case when it runs, so it
665 had better be the case when we adjust matrices between
667 for (i
= 0; i
< matrix
->nrows
; ++i
)
668 matrix
->rows
[i
].enabled_p
= 0;
673 /* Remember last values to be able to optimize frame redraws. */
674 matrix
->matrix_x
= x
;
675 matrix
->matrix_y
= y
;
676 matrix
->matrix_w
= dim
.width
;
677 matrix
->matrix_h
= dim
.height
;
679 /* Record the top y location and height of W at the time the matrix
680 was last adjusted. This is used to optimize redisplay above. */
683 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
684 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
685 matrix
->window_height
= window_height
;
686 matrix
->window_width
= window_width
;
687 matrix
->window_vscroll
= w
->vscroll
;
692 /* Reverse the contents of rows in MATRIX between START and END. The
693 contents of the row at END - 1 end up at START, END - 2 at START +
694 1 etc. This is part of the implementation of rotate_matrix (see
698 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
702 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
704 /* Non-ISO HP/UX compiler doesn't like auto struct
706 struct glyph_row temp
;
707 temp
= matrix
->rows
[i
];
708 matrix
->rows
[i
] = matrix
->rows
[j
];
709 matrix
->rows
[j
] = temp
;
714 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
715 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
716 indices. (Note: this does not copy glyphs, only glyph pointers in
717 row structures are moved around).
719 The algorithm used for rotating the vector was, I believe, first
720 described by Kernighan. See the vector R as consisting of two
721 sub-vectors AB, where A has length BY for BY >= 0. The result
722 after rotating is then BA. Reverse both sub-vectors to get ArBr
723 and reverse the result to get (ArBr)r which is BA. Similar for
727 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
731 /* Up (rotate left, i.e. towards lower indices). */
733 reverse_rows (matrix
, first
, first
+ by
);
734 reverse_rows (matrix
, first
+ by
, last
);
735 reverse_rows (matrix
, first
, last
);
739 /* Down (rotate right, i.e. towards higher indices). */
740 reverse_rows (matrix
, last
- by
, last
);
741 reverse_rows (matrix
, first
, last
- by
);
742 reverse_rows (matrix
, first
, last
);
747 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
748 with indices START <= index < END. Increment positions by DELTA/
752 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
753 EMACS_INT delta
, EMACS_INT delta_bytes
)
755 /* Check that START and END are reasonable values. */
756 xassert (start
>= 0 && start
<= matrix
->nrows
);
757 xassert (end
>= 0 && end
<= matrix
->nrows
);
758 xassert (start
<= end
);
760 for (; start
< end
; ++start
)
761 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
765 /* Enable a range of rows in glyph matrix MATRIX. START and END are
766 the row indices of the first and last + 1 row to enable. If
767 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
770 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
772 xassert (start
<= end
);
773 xassert (start
>= 0 && start
< matrix
->nrows
);
774 xassert (end
>= 0 && end
<= matrix
->nrows
);
776 for (; start
< end
; ++start
)
777 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
783 This empties all rows in MATRIX by setting the enabled_p flag for
784 all rows of the matrix to zero. The function prepare_desired_row
785 will eventually really clear a row when it sees one with a zero
788 Resets update hints to defaults value. The only update hint
789 currently present is the flag MATRIX->no_scrolling_p. */
792 clear_glyph_matrix (struct glyph_matrix
*matrix
)
796 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
797 matrix
->no_scrolling_p
= 0;
802 /* Shift part of the glyph matrix MATRIX of window W up or down.
803 Increment y-positions in glyph rows between START and END by DY,
804 and recompute their visible height. */
807 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
811 xassert (start
<= end
);
812 xassert (start
>= 0 && start
< matrix
->nrows
);
813 xassert (end
>= 0 && end
<= matrix
->nrows
);
815 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
816 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
818 for (; start
< end
; ++start
)
820 struct glyph_row
*row
= &matrix
->rows
[start
];
823 row
->visible_height
= row
->height
;
826 row
->visible_height
-= min_y
- row
->y
;
827 if (row
->y
+ row
->height
> max_y
)
828 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
829 if (row
->fringe_bitmap_periodic_p
)
830 row
->redraw_fringe_bitmaps_p
= 1;
835 /* Mark all rows in current matrices of frame F as invalid. Marking
836 invalid is done by setting enabled_p to zero for all rows in a
840 clear_current_matrices (register struct frame
*f
)
842 /* Clear frame current matrix, if we have one. */
843 if (f
->current_matrix
)
844 clear_glyph_matrix (f
->current_matrix
);
846 /* Clear the matrix of the menu bar window, if such a window exists.
847 The menu bar window is currently used to display menus on X when
848 no toolkit support is compiled in. */
849 if (WINDOWP (f
->menu_bar_window
))
850 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
852 /* Clear the matrix of the tool-bar window, if any. */
853 if (WINDOWP (f
->tool_bar_window
))
854 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
856 /* Clear current window matrices. */
857 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
858 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
862 /* Clear out all display lines of F for a coming redisplay. */
865 clear_desired_matrices (register struct frame
*f
)
867 if (f
->desired_matrix
)
868 clear_glyph_matrix (f
->desired_matrix
);
870 if (WINDOWP (f
->menu_bar_window
))
871 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
873 if (WINDOWP (f
->tool_bar_window
))
874 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
876 /* Do it for window matrices. */
877 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
878 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
882 /* Clear matrices in window tree rooted in W. If DESIRED_P is
883 non-zero clear desired matrices, otherwise clear current matrices. */
886 clear_window_matrices (struct window
*w
, int desired_p
)
890 if (!NILP (w
->hchild
))
892 xassert (WINDOWP (w
->hchild
));
893 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
895 else if (!NILP (w
->vchild
))
897 xassert (WINDOWP (w
->vchild
));
898 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
903 clear_glyph_matrix (w
->desired_matrix
);
906 clear_glyph_matrix (w
->current_matrix
);
907 w
->window_end_valid
= Qnil
;
911 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
917 /***********************************************************************
920 See dispextern.h for an overall explanation of glyph rows.
921 ***********************************************************************/
923 /* Clear glyph row ROW. Do it in a way that makes it robust against
924 changes in the glyph_row structure, i.e. addition or removal of
925 structure members. */
927 static struct glyph_row null_row
;
930 clear_glyph_row (struct glyph_row
*row
)
932 struct glyph
*p
[1 + LAST_AREA
];
935 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
936 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
937 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
938 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
943 /* Restore pointers. */
944 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
945 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
946 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
947 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
949 #if 0 /* At some point, some bit-fields of struct glyph were not set,
950 which made glyphs unequal when compared with GLYPH_EQUAL_P.
951 Redisplay outputs such glyphs, and flickering effects were
952 the result. This also depended on the contents of memory
953 returned by xmalloc. If flickering happens again, activate
954 the code below. If the flickering is gone with that, chances
955 are that the flickering has the same reason as here. */
956 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
961 /* Make ROW an empty, enabled row of canonical character height,
962 in window W starting at y-position Y. */
965 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
969 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
970 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
972 clear_glyph_row (row
);
974 row
->ascent
= row
->phys_ascent
= 0;
975 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
976 row
->visible_height
= row
->height
;
979 row
->visible_height
-= min_y
- row
->y
;
980 if (row
->y
+ row
->height
> max_y
)
981 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
987 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
988 are the amounts by which to change positions. Note that the first
989 glyph of the text area of a row can have a buffer position even if
990 the used count of the text area is zero. Such rows display line
994 increment_row_positions (struct glyph_row
*row
,
995 EMACS_INT delta
, EMACS_INT delta_bytes
)
999 /* Increment start and end positions. */
1000 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1001 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1002 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1003 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1004 CHARPOS (row
->start
.pos
) += delta
;
1005 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1006 CHARPOS (row
->end
.pos
) += delta
;
1007 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1009 if (!row
->enabled_p
)
1012 /* Increment positions in glyphs. */
1013 for (area
= 0; area
< LAST_AREA
; ++area
)
1014 for (i
= 0; i
< row
->used
[area
]; ++i
)
1015 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1016 && row
->glyphs
[area
][i
].charpos
> 0)
1017 row
->glyphs
[area
][i
].charpos
+= delta
;
1019 /* Capture the case of rows displaying a line end. */
1020 if (row
->used
[TEXT_AREA
] == 0
1021 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1022 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1027 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1028 contents, i.e. glyph structure contents are exchanged between A and
1029 B without changing glyph pointers in A and B. */
1032 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1036 for (area
= 0; area
< LAST_AREA
; ++area
)
1038 /* Number of glyphs to swap. */
1039 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1041 /* Start of glyphs in area of row A. */
1042 struct glyph
*glyph_a
= a
->glyphs
[area
];
1044 /* End + 1 of glyphs in area of row A. */
1045 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1047 /* Start of glyphs in area of row B. */
1048 struct glyph
*glyph_b
= b
->glyphs
[area
];
1050 while (glyph_a
< glyph_a_end
)
1052 /* Non-ISO HP/UX compiler doesn't like auto struct
1056 *glyph_a
= *glyph_b
;
1066 /* Exchange pointers to glyph memory between glyph rows A and B. */
1069 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1072 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1074 struct glyph
*temp
= a
->glyphs
[i
];
1075 a
->glyphs
[i
] = b
->glyphs
[i
];
1076 b
->glyphs
[i
] = temp
;
1081 /* Copy glyph row structure FROM to glyph row structure TO, except
1082 that glyph pointers in the structures are left unchanged. */
1085 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1087 struct glyph
*pointers
[1 + LAST_AREA
];
1089 /* Save glyph pointers of TO. */
1090 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1092 /* Do a structure assignment. */
1095 /* Restore original pointers of TO. */
1096 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1100 /* Assign glyph row FROM to glyph row TO. This works like a structure
1101 assignment TO = FROM, except that glyph pointers are not copied but
1102 exchanged between TO and FROM. Pointers must be exchanged to avoid
1106 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1108 swap_glyph_pointers (to
, from
);
1109 copy_row_except_pointers (to
, from
);
1113 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1114 a row in a window matrix, is a slice of the glyph memory of the
1115 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1116 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1117 memory of FRAME_ROW. */
1122 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1124 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1125 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1126 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1128 return (frame_glyph_start
<= window_glyph_start
1129 && window_glyph_start
< frame_glyph_end
);
1132 #endif /* GLYPH_DEBUG */
1136 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1137 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1138 in WINDOW_MATRIX is found satisfying the condition. */
1140 static struct glyph_row
*
1141 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1142 struct glyph_matrix
*frame_matrix
, int row
)
1146 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1148 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1149 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1150 frame_matrix
->rows
+ row
))
1153 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1158 /* Prepare ROW for display. Desired rows are cleared lazily,
1159 i.e. they are only marked as to be cleared by setting their
1160 enabled_p flag to zero. When a row is to be displayed, a prior
1161 call to this function really clears it. */
1164 prepare_desired_row (struct glyph_row
*row
)
1166 if (!row
->enabled_p
)
1168 int rp
= row
->reversed_p
;
1170 clear_glyph_row (row
);
1172 row
->reversed_p
= rp
;
1177 /* Return a hash code for glyph row ROW. */
1180 line_hash_code (struct glyph_row
*row
)
1186 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1187 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1191 int c
= glyph
->u
.ch
;
1192 int face_id
= glyph
->face_id
;
1193 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1195 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1196 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1208 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1209 the number of characters in the line. If must_write_spaces is
1210 zero, leading and trailing spaces are ignored. */
1213 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1215 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1216 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1217 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1219 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1220 int glyph_table_len
= GLYPH_TABLE_LENGTH
;
1222 /* Ignore trailing and leading spaces if we can. */
1223 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1225 /* Skip from the end over trailing spaces. */
1226 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1229 /* All blank line. */
1233 /* Skip over leading spaces. */
1234 while (CHAR_GLYPH_SPACE_P (*beg
))
1238 /* If we don't have a glyph-table, each glyph is one character,
1239 so return the number of glyphs. */
1240 if (glyph_table_base
== 0)
1244 /* Otherwise, scan the glyphs and accumulate their total length
1251 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1253 if (GLYPH_INVALID_P (g
)
1254 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1257 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1267 /* Test two glyph rows A and B for equality. Value is non-zero if A
1268 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1269 mouse_face_p flags of A and B, too. */
1272 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1276 else if (a
->hash
!= b
->hash
)
1280 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1283 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1286 /* Compare glyphs. */
1287 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1289 if (a
->used
[area
] != b
->used
[area
])
1292 a_glyph
= a
->glyphs
[area
];
1293 a_end
= a_glyph
+ a
->used
[area
];
1294 b_glyph
= b
->glyphs
[area
];
1296 while (a_glyph
< a_end
1297 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1298 ++a_glyph
, ++b_glyph
;
1300 if (a_glyph
!= a_end
)
1304 if (a
->fill_line_p
!= b
->fill_line_p
1305 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1306 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1307 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1308 || a
->left_fringe_offset
!= b
->left_fringe_offset
1309 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1310 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1311 || a
->right_fringe_offset
!= b
->right_fringe_offset
1312 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1313 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1314 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1315 || a
->overlapped_p
!= b
->overlapped_p
1316 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1317 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1318 || a
->reversed_p
!= b
->reversed_p
1319 /* Different partially visible characters on left margin. */
1321 /* Different height. */
1322 || a
->ascent
!= b
->ascent
1323 || a
->phys_ascent
!= b
->phys_ascent
1324 || a
->phys_height
!= b
->phys_height
1325 || a
->visible_height
!= b
->visible_height
)
1334 /***********************************************************************
1337 See dispextern.h for an overall explanation of glyph pools.
1338 ***********************************************************************/
1340 /* Allocate a glyph_pool structure. The structure returned is
1341 initialized with zeros. The global variable glyph_pool_count is
1342 incremented for each pool allocated. */
1344 static struct glyph_pool
*
1345 new_glyph_pool (void)
1347 struct glyph_pool
*result
;
1349 /* Allocate a new glyph_pool and clear it. */
1350 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1351 memset (result
, 0, sizeof *result
);
1353 /* For memory leak and double deletion checking. */
1360 /* Free a glyph_pool structure POOL. The function may be called with
1361 a null POOL pointer. The global variable glyph_pool_count is
1362 decremented with every pool structure freed. If this count gets
1363 negative, more structures were freed than allocated, i.e. one
1364 structure must have been freed more than once or a bogus pointer
1365 was passed to free_glyph_pool. */
1368 free_glyph_pool (struct glyph_pool
*pool
)
1372 /* More freed than allocated? */
1374 xassert (glyph_pool_count
>= 0);
1376 xfree (pool
->glyphs
);
1382 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1383 columns we need. This function never shrinks a pool. The only
1384 case in which this would make sense, would be when a frame's size
1385 is changed from a large value to a smaller one. But, if someone
1386 does it once, we can expect that he will do it again.
1388 Value is non-zero if the pool changed in a way which makes
1389 re-adjusting window glyph matrices necessary. */
1392 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1397 changed_p
= (pool
->glyphs
== 0
1398 || matrix_dim
.height
!= pool
->nrows
1399 || matrix_dim
.width
!= pool
->ncolumns
);
1401 /* Enlarge the glyph pool. */
1402 needed
= matrix_dim
.width
* matrix_dim
.height
;
1403 if (needed
> pool
->nglyphs
)
1405 ptrdiff_t size
= needed
* sizeof (struct glyph
);
1409 pool
->glyphs
= (struct glyph
*) xrealloc (pool
->glyphs
, size
);
1410 memset (pool
->glyphs
+ pool
->nglyphs
, 0,
1411 size
- pool
->nglyphs
* sizeof (struct glyph
));
1415 pool
->glyphs
= (struct glyph
*) xmalloc (size
);
1416 memset (pool
->glyphs
, 0, size
);
1419 pool
->nglyphs
= needed
;
1422 /* Remember the number of rows and columns because (a) we use them
1423 to do sanity checks, and (b) the number of columns determines
1424 where rows in the frame matrix start---this must be available to
1425 determine pointers to rows of window sub-matrices. */
1426 pool
->nrows
= matrix_dim
.height
;
1427 pool
->ncolumns
= matrix_dim
.width
;
1434 /***********************************************************************
1436 ***********************************************************************/
1441 /* Flush standard output. This is sometimes useful to call from the debugger.
1442 XXX Maybe this should be changed to flush the current terminal instead of
1446 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1455 /* Check that no glyph pointers have been lost in MATRIX. If a
1456 pointer has been lost, e.g. by using a structure assignment between
1457 rows, at least one pointer must occur more than once in the rows of
1461 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1465 for (i
= 0; i
< matrix
->nrows
; ++i
)
1466 for (j
= 0; j
< matrix
->nrows
; ++j
)
1468 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1469 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1473 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1476 matrix_row (struct glyph_matrix
*matrix
, int row
)
1478 xassert (matrix
&& matrix
->rows
);
1479 xassert (row
>= 0 && row
< matrix
->nrows
);
1481 /* That's really too slow for normal testing because this function
1482 is called almost everywhere. Although---it's still astonishingly
1483 fast, so it is valuable to have for debugging purposes. */
1485 check_matrix_pointer_lossage (matrix
);
1488 return matrix
->rows
+ row
;
1492 #if 0 /* This function makes invalid assumptions when text is
1493 partially invisible. But it might come handy for debugging
1496 /* Check invariants that must hold for an up to date current matrix of
1500 check_matrix_invariants (struct window
*w
)
1502 struct glyph_matrix
*matrix
= w
->current_matrix
;
1503 int yb
= window_text_bottom_y (w
);
1504 struct glyph_row
*row
= matrix
->rows
;
1505 struct glyph_row
*last_text_row
= NULL
;
1506 struct buffer
*saved
= current_buffer
;
1507 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1510 /* This can sometimes happen for a fresh window. */
1511 if (matrix
->nrows
< 2)
1514 set_buffer_temp (buffer
);
1516 /* Note: last row is always reserved for the mode line. */
1517 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1518 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1520 struct glyph_row
*next
= row
+ 1;
1522 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1523 last_text_row
= row
;
1525 /* Check that character and byte positions are in sync. */
1526 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1527 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1528 xassert (BYTEPOS (row
->start
.pos
)
1529 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1531 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1532 have such a position temporarily in case of a minibuffer
1533 displaying something like `[Sole completion]' at its end. */
1534 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1536 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1537 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1538 xassert (BYTEPOS (row
->end
.pos
)
1539 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1542 /* Check that end position of `row' is equal to start position
1544 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1546 xassert (MATRIX_ROW_END_CHARPOS (row
)
1547 == MATRIX_ROW_START_CHARPOS (next
));
1548 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1549 == MATRIX_ROW_START_BYTEPOS (next
));
1550 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1551 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1556 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1557 xassert (w
->desired_matrix
->rows
!= NULL
);
1558 set_buffer_temp (saved
);
1563 #endif /* GLYPH_DEBUG != 0 */
1567 /**********************************************************************
1568 Allocating/ Adjusting Glyph Matrices
1569 **********************************************************************/
1571 /* Allocate glyph matrices over a window tree for a frame-based
1574 X and Y are column/row within the frame glyph matrix where
1575 sub-matrices for the window tree rooted at WINDOW must be
1576 allocated. DIM_ONLY_P non-zero means that the caller of this
1577 function is only interested in the result matrix dimension, and
1578 matrix adjustments should not be performed.
1580 The function returns the total width/height of the sub-matrices of
1581 the window tree. If called on a frame root window, the computation
1582 will take the mini-buffer window into account.
1584 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1586 NEW_LEAF_MATRIX set if any window in the tree did not have a
1587 glyph matrices yet, and
1589 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1590 any window in the tree will be changed or have been changed (see
1593 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1596 Windows are arranged into chains of windows on the same level
1597 through the next fields of window structures. Such a level can be
1598 either a sequence of horizontally adjacent windows from left to
1599 right, or a sequence of vertically adjacent windows from top to
1600 bottom. Each window in a horizontal sequence can be either a leaf
1601 window or a vertical sequence; a window in a vertical sequence can
1602 be either a leaf or a horizontal sequence. All windows in a
1603 horizontal sequence have the same height, and all windows in a
1604 vertical sequence have the same width.
1606 This function uses, for historical reasons, a more general
1607 algorithm to determine glyph matrix dimensions that would be
1610 The matrix height of a horizontal sequence is determined by the
1611 maximum height of any matrix in the sequence. The matrix width of
1612 a horizontal sequence is computed by adding up matrix widths of
1613 windows in the sequence.
1615 |<------- result width ------->|
1616 +---------+----------+---------+ ---
1619 +---------+ | | result height
1624 The matrix width of a vertical sequence is the maximum matrix width
1625 of any window in the sequence. Its height is computed by adding up
1626 matrix heights of windows in the sequence.
1628 |<---- result width -->|
1636 +------------+---------+ |
1639 +------------+---------+ --- */
1641 /* Bit indicating that a new matrix will be allocated or has been
1644 #define NEW_LEAF_MATRIX (1 << 0)
1646 /* Bit indicating that a matrix will or has changed its location or
1649 #define CHANGED_LEAF_MATRIX (1 << 1)
1652 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1653 int dim_only_p
, int *window_change_flags
)
1655 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1657 int wmax
= 0, hmax
= 0;
1661 int in_horz_combination_p
;
1663 /* What combination is WINDOW part of? Compute this once since the
1664 result is the same for all windows in the `next' chain. The
1665 special case of a root window (parent equal to nil) is treated
1666 like a vertical combination because a root window's `next'
1667 points to the mini-buffer window, if any, which is arranged
1668 vertically below other windows. */
1669 in_horz_combination_p
1670 = (!NILP (XWINDOW (window
)->parent
)
1671 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1673 /* For WINDOW and all windows on the same level. */
1676 w
= XWINDOW (window
);
1678 /* Get the dimension of the window sub-matrix for W, depending
1679 on whether this is a combination or a leaf window. */
1680 if (!NILP (w
->hchild
))
1681 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1683 window_change_flags
);
1684 else if (!NILP (w
->vchild
))
1685 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1687 window_change_flags
);
1690 /* If not already done, allocate sub-matrix structures. */
1691 if (w
->desired_matrix
== NULL
)
1693 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1694 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1695 *window_change_flags
|= NEW_LEAF_MATRIX
;
1698 /* Width and height MUST be chosen so that there are no
1699 holes in the frame matrix. */
1700 dim
.width
= required_matrix_width (w
);
1701 dim
.height
= required_matrix_height (w
);
1703 /* Will matrix be re-allocated? */
1704 if (x
!= w
->desired_matrix
->matrix_x
1705 || y
!= w
->desired_matrix
->matrix_y
1706 || dim
.width
!= w
->desired_matrix
->matrix_w
1707 || dim
.height
!= w
->desired_matrix
->matrix_h
1708 || (margin_glyphs_to_reserve (w
, dim
.width
,
1709 w
->left_margin_cols
)
1710 != w
->desired_matrix
->left_margin_glyphs
)
1711 || (margin_glyphs_to_reserve (w
, dim
.width
,
1712 w
->right_margin_cols
)
1713 != w
->desired_matrix
->right_margin_glyphs
))
1714 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1716 /* Actually change matrices, if allowed. Do not consider
1717 CHANGED_LEAF_MATRIX computed above here because the pool
1718 may have been changed which we don't now here. We trust
1719 that we only will be called with DIM_ONLY_P != 0 when
1723 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1724 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1728 /* If we are part of a horizontal combination, advance x for
1729 windows to the right of W; otherwise advance y for windows
1731 if (in_horz_combination_p
)
1736 /* Remember maximum glyph matrix dimensions. */
1737 wmax
= max (wmax
, dim
.width
);
1738 hmax
= max (hmax
, dim
.height
);
1740 /* Next window on same level. */
1743 while (!NILP (window
));
1745 /* Set `total' to the total glyph matrix dimension of this window
1746 level. In a vertical combination, the width is the width of the
1747 widest window; the height is the y we finally reached, corrected
1748 by the y we started with. In a horizontal combination, the total
1749 height is the height of the tallest window, and the width is the
1750 x we finally reached, corrected by the x we started with. */
1751 if (in_horz_combination_p
)
1753 total
.width
= x
- x0
;
1754 total
.height
= hmax
;
1759 total
.height
= y
- y0
;
1766 /* Return the required height of glyph matrices for window W. */
1769 required_matrix_height (struct window
*w
)
1771 #ifdef HAVE_WINDOW_SYSTEM
1772 struct frame
*f
= XFRAME (w
->frame
);
1774 if (FRAME_WINDOW_P (f
))
1776 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1777 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1778 return (((window_pixel_height
+ ch_height
- 1)
1779 / ch_height
) * w
->nrows_scale_factor
1780 /* One partially visible line at the top and
1781 bottom of the window. */
1783 /* 2 for header and mode line. */
1786 #endif /* HAVE_WINDOW_SYSTEM */
1788 return WINDOW_TOTAL_LINES (w
);
1792 /* Return the required width of glyph matrices for window W. */
1795 required_matrix_width (struct window
*w
)
1797 #ifdef HAVE_WINDOW_SYSTEM
1798 struct frame
*f
= XFRAME (w
->frame
);
1799 if (FRAME_WINDOW_P (f
))
1801 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1802 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1804 /* Compute number of glyphs needed in a glyph row. */
1805 return (((window_pixel_width
+ ch_width
- 1)
1806 / ch_width
) * w
->ncols_scale_factor
1807 /* 2 partially visible columns in the text area. */
1809 /* One partially visible column at the right
1810 edge of each marginal area. */
1813 #endif /* HAVE_WINDOW_SYSTEM */
1815 return XINT (w
->total_cols
);
1819 /* Allocate window matrices for window-based redisplay. W is the
1820 window whose matrices must be allocated/reallocated. */
1823 allocate_matrices_for_window_redisplay (struct window
*w
)
1827 if (!NILP (w
->vchild
))
1828 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1829 else if (!NILP (w
->hchild
))
1830 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1833 /* W is a leaf window. */
1836 /* If matrices are not yet allocated, allocate them now. */
1837 if (w
->desired_matrix
== NULL
)
1839 w
->desired_matrix
= new_glyph_matrix (NULL
);
1840 w
->current_matrix
= new_glyph_matrix (NULL
);
1843 dim
.width
= required_matrix_width (w
);
1844 dim
.height
= required_matrix_height (w
);
1845 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1846 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1849 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1854 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1855 do it for all frames; otherwise do it just for the given frame.
1856 This function must be called when a new frame is created, its size
1857 changes, or its window configuration changes. */
1860 adjust_glyphs (struct frame
*f
)
1862 /* Block input so that expose events and other events that access
1863 glyph matrices are not processed while we are changing them. */
1867 adjust_frame_glyphs (f
);
1870 Lisp_Object tail
, lisp_frame
;
1872 FOR_EACH_FRAME (tail
, lisp_frame
)
1873 adjust_frame_glyphs (XFRAME (lisp_frame
));
1880 /* Adjust frame glyphs when Emacs is initialized.
1882 To be called from init_display.
1884 We need a glyph matrix because redraw will happen soon.
1885 Unfortunately, window sizes on selected_frame are not yet set to
1886 meaningful values. I believe we can assume that there are only two
1887 windows on the frame---the mini-buffer and the root window. Frame
1888 height and width seem to be correct so far. So, set the sizes of
1889 windows to estimated values. */
1892 adjust_frame_glyphs_initially (void)
1894 struct frame
*sf
= SELECTED_FRAME ();
1895 struct window
*root
= XWINDOW (sf
->root_window
);
1896 struct window
*mini
= XWINDOW (root
->next
);
1897 int frame_lines
= FRAME_LINES (sf
);
1898 int frame_cols
= FRAME_COLS (sf
);
1899 int top_margin
= FRAME_TOP_MARGIN (sf
);
1901 /* Do it for the root window. */
1902 XSETFASTINT (root
->top_line
, top_margin
);
1903 XSETFASTINT (root
->total_lines
, frame_lines
- 1 - top_margin
);
1904 XSETFASTINT (root
->total_cols
, frame_cols
);
1906 /* Do it for the mini-buffer window. */
1907 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1908 XSETFASTINT (mini
->total_lines
, 1);
1909 XSETFASTINT (mini
->total_cols
, frame_cols
);
1911 adjust_frame_glyphs (sf
);
1912 glyphs_initialized_initially_p
= 1;
1916 /* Allocate/reallocate glyph matrices of a single frame F. */
1919 adjust_frame_glyphs (struct frame
*f
)
1921 if (FRAME_WINDOW_P (f
))
1922 adjust_frame_glyphs_for_window_redisplay (f
);
1924 adjust_frame_glyphs_for_frame_redisplay (f
);
1926 /* Don't forget the message buffer and the buffer for
1927 decode_mode_spec. */
1928 adjust_frame_message_buffer (f
);
1929 adjust_decode_mode_spec_buffer (f
);
1931 f
->glyphs_initialized_p
= 1;
1934 /* Return 1 if any window in the tree has nonzero window margins. See
1935 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1937 showing_window_margins_p (struct window
*w
)
1941 if (!NILP (w
->hchild
))
1943 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1946 else if (!NILP (w
->vchild
))
1948 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1951 else if (!NILP (w
->left_margin_cols
)
1952 || !NILP (w
->right_margin_cols
))
1955 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1961 /* In the window tree with root W, build current matrices of leaf
1962 windows from the frame's current matrix. */
1965 fake_current_matrices (Lisp_Object window
)
1969 for (; !NILP (window
); window
= w
->next
)
1971 w
= XWINDOW (window
);
1973 if (!NILP (w
->hchild
))
1974 fake_current_matrices (w
->hchild
);
1975 else if (!NILP (w
->vchild
))
1976 fake_current_matrices (w
->vchild
);
1980 struct frame
*f
= XFRAME (w
->frame
);
1981 struct glyph_matrix
*m
= w
->current_matrix
;
1982 struct glyph_matrix
*fm
= f
->current_matrix
;
1984 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1985 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1987 for (i
= 0; i
< m
->matrix_h
; ++i
)
1989 struct glyph_row
*r
= m
->rows
+ i
;
1990 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1992 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1993 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1995 r
->enabled_p
= fr
->enabled_p
;
1998 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1999 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2000 r
->used
[TEXT_AREA
] = (m
->matrix_w
2001 - r
->used
[LEFT_MARGIN_AREA
]
2002 - r
->used
[RIGHT_MARGIN_AREA
]);
2011 /* Save away the contents of frame F's current frame matrix. Value is
2012 a glyph matrix holding the contents of F's current frame matrix. */
2014 static struct glyph_matrix
*
2015 save_current_matrix (struct frame
*f
)
2018 struct glyph_matrix
*saved
;
2020 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2021 memset (saved
, 0, sizeof *saved
);
2022 saved
->nrows
= f
->current_matrix
->nrows
;
2023 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2024 * sizeof *saved
->rows
);
2025 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2027 for (i
= 0; i
< saved
->nrows
; ++i
)
2029 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2030 struct glyph_row
*to
= saved
->rows
+ i
;
2031 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2032 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2033 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2034 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2041 /* Restore the contents of frame F's current frame matrix from SAVED,
2042 and free memory associated with SAVED. */
2045 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2049 for (i
= 0; i
< saved
->nrows
; ++i
)
2051 struct glyph_row
*from
= saved
->rows
+ i
;
2052 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2053 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2054 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2055 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2056 xfree (from
->glyphs
[TEXT_AREA
]);
2059 xfree (saved
->rows
);
2065 /* Allocate/reallocate glyph matrices of a single frame F for
2066 frame-based redisplay. */
2069 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2071 struct dim matrix_dim
;
2073 int window_change_flags
;
2076 if (!FRAME_LIVE_P (f
))
2079 top_window_y
= FRAME_TOP_MARGIN (f
);
2081 /* Allocate glyph pool structures if not already done. */
2082 if (f
->desired_pool
== NULL
)
2084 f
->desired_pool
= new_glyph_pool ();
2085 f
->current_pool
= new_glyph_pool ();
2088 /* Allocate frames matrix structures if needed. */
2089 if (f
->desired_matrix
== NULL
)
2091 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2092 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2095 /* Compute window glyph matrices. (This takes the mini-buffer
2096 window into account). The result is the size of the frame glyph
2097 matrix needed. The variable window_change_flags is set to a bit
2098 mask indicating whether new matrices will be allocated or
2099 existing matrices change their size or location within the frame
2101 window_change_flags
= 0;
2103 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2106 &window_change_flags
);
2108 /* Add in menu bar lines, if any. */
2109 matrix_dim
.height
+= top_window_y
;
2111 /* Enlarge pools as necessary. */
2112 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2113 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2115 /* Set up glyph pointers within window matrices. Do this only if
2116 absolutely necessary since it requires a frame redraw. */
2117 if (pool_changed_p
|| window_change_flags
)
2119 /* Do it for window matrices. */
2120 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2122 &window_change_flags
);
2124 /* Size of frame matrices must equal size of frame. Note
2125 that we are called for X frames with window widths NOT equal
2126 to the frame width (from CHANGE_FRAME_SIZE_1). */
2127 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2128 && matrix_dim
.height
== FRAME_LINES (f
));
2130 /* Pointers to glyph memory in glyph rows are exchanged during
2131 the update phase of redisplay, which means in general that a
2132 frame's current matrix consists of pointers into both the
2133 desired and current glyph pool of the frame. Adjusting a
2134 matrix sets the frame matrix up so that pointers are all into
2135 the same pool. If we want to preserve glyph contents of the
2136 current matrix over a call to adjust_glyph_matrix, we must
2137 make a copy of the current glyphs, and restore the current
2138 matrix' contents from that copy. */
2139 if (display_completed
2140 && !FRAME_GARBAGED_P (f
)
2141 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2142 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2143 /* For some reason, the frame glyph matrix gets corrupted if
2144 any of the windows contain margins. I haven't been able
2145 to hunt down the reason, but for the moment this prevents
2146 the problem from manifesting. -- cyd */
2147 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2149 struct glyph_matrix
*copy
= save_current_matrix (f
);
2150 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2151 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2152 restore_current_matrix (f
, copy
);
2153 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2157 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2158 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2159 SET_FRAME_GARBAGED (f
);
2165 /* Allocate/reallocate glyph matrices of a single frame F for
2166 window-based redisplay. */
2169 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2171 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2173 /* Allocate/reallocate window matrices. */
2174 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2176 #ifdef HAVE_X_WINDOWS
2177 /* Allocate/ reallocate matrices of the dummy window used to display
2178 the menu bar under X when no X toolkit support is available. */
2179 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2181 /* Allocate a dummy window if not already done. */
2183 if (NILP (f
->menu_bar_window
))
2185 f
->menu_bar_window
= make_window ();
2186 w
= XWINDOW (f
->menu_bar_window
);
2187 XSETFRAME (w
->frame
, f
);
2188 w
->pseudo_window_p
= 1;
2191 w
= XWINDOW (f
->menu_bar_window
);
2193 /* Set window dimensions to frame dimensions and allocate or
2194 adjust glyph matrices of W. */
2195 XSETFASTINT (w
->top_line
, 0);
2196 XSETFASTINT (w
->left_col
, 0);
2197 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2198 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2199 allocate_matrices_for_window_redisplay (w
);
2201 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2202 #endif /* HAVE_X_WINDOWS */
2206 /* Allocate/ reallocate matrices of the tool bar window. If we
2207 don't have a tool bar window yet, make one. */
2209 if (NILP (f
->tool_bar_window
))
2211 f
->tool_bar_window
= make_window ();
2212 w
= XWINDOW (f
->tool_bar_window
);
2213 XSETFRAME (w
->frame
, f
);
2214 w
->pseudo_window_p
= 1;
2217 w
= XWINDOW (f
->tool_bar_window
);
2219 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2220 XSETFASTINT (w
->left_col
, 0);
2221 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2222 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2223 allocate_matrices_for_window_redisplay (w
);
2229 /* Adjust/ allocate message buffer of frame F.
2231 Note that the message buffer is never freed. Since I could not
2232 find a free in 19.34, I assume that freeing it would be
2233 problematic in some way and don't do it either.
2235 (Implementation note: It should be checked if we can free it
2236 eventually without causing trouble). */
2239 adjust_frame_message_buffer (struct frame
*f
)
2241 ptrdiff_t size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2243 if (FRAME_MESSAGE_BUF (f
))
2245 char *buffer
= FRAME_MESSAGE_BUF (f
);
2246 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2247 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2250 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2254 /* Re-allocate buffer for decode_mode_spec on frame F. */
2257 adjust_decode_mode_spec_buffer (struct frame
*f
)
2259 f
->decode_mode_spec_buffer
2260 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2261 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2266 /**********************************************************************
2267 Freeing Glyph Matrices
2268 **********************************************************************/
2270 /* Free glyph memory for a frame F. F may be null. This function can
2271 be called for the same frame more than once. The root window of
2272 F may be nil when this function is called. This is the case when
2273 the function is called when F is destroyed. */
2276 free_glyphs (struct frame
*f
)
2278 if (f
&& f
->glyphs_initialized_p
)
2280 /* Block interrupt input so that we don't get surprised by an X
2281 event while we're in an inconsistent state. */
2283 f
->glyphs_initialized_p
= 0;
2285 /* Release window sub-matrices. */
2286 if (!NILP (f
->root_window
))
2287 free_window_matrices (XWINDOW (f
->root_window
));
2289 /* Free the dummy window for menu bars without X toolkit and its
2291 if (!NILP (f
->menu_bar_window
))
2293 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2294 free_glyph_matrix (w
->desired_matrix
);
2295 free_glyph_matrix (w
->current_matrix
);
2296 w
->desired_matrix
= w
->current_matrix
= NULL
;
2297 f
->menu_bar_window
= Qnil
;
2300 /* Free the tool bar window and its glyph matrices. */
2301 if (!NILP (f
->tool_bar_window
))
2303 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2304 free_glyph_matrix (w
->desired_matrix
);
2305 free_glyph_matrix (w
->current_matrix
);
2306 w
->desired_matrix
= w
->current_matrix
= NULL
;
2307 f
->tool_bar_window
= Qnil
;
2310 /* Release frame glyph matrices. Reset fields to zero in
2311 case we are called a second time. */
2312 if (f
->desired_matrix
)
2314 free_glyph_matrix (f
->desired_matrix
);
2315 free_glyph_matrix (f
->current_matrix
);
2316 f
->desired_matrix
= f
->current_matrix
= NULL
;
2319 /* Release glyph pools. */
2320 if (f
->desired_pool
)
2322 free_glyph_pool (f
->desired_pool
);
2323 free_glyph_pool (f
->current_pool
);
2324 f
->desired_pool
= f
->current_pool
= NULL
;
2332 /* Free glyph sub-matrices in the window tree rooted at W. This
2333 function may be called with a null pointer, and it may be called on
2334 the same tree more than once. */
2337 free_window_matrices (struct window
*w
)
2341 if (!NILP (w
->hchild
))
2342 free_window_matrices (XWINDOW (w
->hchild
));
2343 else if (!NILP (w
->vchild
))
2344 free_window_matrices (XWINDOW (w
->vchild
));
2347 /* This is a leaf window. Free its memory and reset fields
2348 to zero in case this function is called a second time for
2350 free_glyph_matrix (w
->current_matrix
);
2351 free_glyph_matrix (w
->desired_matrix
);
2352 w
->current_matrix
= w
->desired_matrix
= NULL
;
2355 /* Next window on same level. */
2356 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2361 /* Check glyph memory leaks. This function is called from
2362 shut_down_emacs. Note that frames are not destroyed when Emacs
2363 exits. We therefore free all glyph memory for all active frames
2364 explicitly and check that nothing is left allocated. */
2367 check_glyph_memory (void)
2369 Lisp_Object tail
, frame
;
2371 /* Free glyph memory for all frames. */
2372 FOR_EACH_FRAME (tail
, frame
)
2373 free_glyphs (XFRAME (frame
));
2375 /* Check that nothing is left allocated. */
2376 if (glyph_matrix_count
)
2378 if (glyph_pool_count
)
2384 /**********************************************************************
2385 Building a Frame Matrix
2386 **********************************************************************/
2388 /* Most of the redisplay code works on glyph matrices attached to
2389 windows. This is a good solution most of the time, but it is not
2390 suitable for terminal code. Terminal output functions cannot rely
2391 on being able to set an arbitrary terminal window. Instead they
2392 must be provided with a view of the whole frame, i.e. the whole
2393 screen. We build such a view by constructing a frame matrix from
2394 window matrices in this section.
2396 Windows that must be updated have their must_be_update_p flag set.
2397 For all such windows, their desired matrix is made part of the
2398 desired frame matrix. For other windows, their current matrix is
2399 made part of the desired frame matrix.
2401 +-----------------+----------------+
2402 | desired | desired |
2404 +-----------------+----------------+
2407 +----------------------------------+
2409 Desired window matrices can be made part of the frame matrix in a
2410 cheap way: We exploit the fact that the desired frame matrix and
2411 desired window matrices share their glyph memory. This is not
2412 possible for current window matrices. Their glyphs are copied to
2413 the desired frame matrix. The latter is equivalent to
2414 preserve_other_columns in the old redisplay.
2416 Used glyphs counters for frame matrix rows are the result of adding
2417 up glyph lengths of the window matrices. A line in the frame
2418 matrix is enabled, if a corresponding line in a window matrix is
2421 After building the desired frame matrix, it will be passed to
2422 terminal code, which will manipulate both the desired and current
2423 frame matrix. Changes applied to the frame's current matrix have
2424 to be visible in current window matrices afterwards, of course.
2426 This problem is solved like this:
2428 1. Window and frame matrices share glyphs. Window matrices are
2429 constructed in a way that their glyph contents ARE the glyph
2430 contents needed in a frame matrix. Thus, any modification of
2431 glyphs done in terminal code will be reflected in window matrices
2434 2. Exchanges of rows in a frame matrix done by terminal code are
2435 intercepted by hook functions so that corresponding row operations
2436 on window matrices can be performed. This is necessary because we
2437 use pointers to glyphs in glyph row structures. To satisfy the
2438 assumption of point 1 above that glyphs are updated implicitly in
2439 window matrices when they are manipulated via the frame matrix,
2440 window and frame matrix must of course agree where to find the
2441 glyphs for their rows. Possible manipulations that must be
2442 mirrored are assignments of rows of the desired frame matrix to the
2443 current frame matrix and scrolling the current frame matrix. */
2445 /* Build frame F's desired matrix from window matrices. Only windows
2446 which have the flag must_be_updated_p set have to be updated. Menu
2447 bar lines of a frame are not covered by window matrices, so make
2448 sure not to touch them in this function. */
2451 build_frame_matrix (struct frame
*f
)
2455 /* F must have a frame matrix when this function is called. */
2456 xassert (!FRAME_WINDOW_P (f
));
2458 /* Clear all rows in the frame matrix covered by window matrices.
2459 Menu bar lines are not covered by windows. */
2460 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2461 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2463 /* Build the matrix by walking the window tree. */
2464 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2465 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2469 /* Walk a window tree, building a frame matrix MATRIX from window
2470 matrices. W is the root of a window tree. */
2473 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2477 if (!NILP (w
->hchild
))
2478 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2479 else if (!NILP (w
->vchild
))
2480 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2482 build_frame_matrix_from_leaf_window (matrix
, w
);
2484 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2489 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2490 desired frame matrix built. W is a leaf window whose desired or
2491 current matrix is to be added to FRAME_MATRIX. W's flag
2492 must_be_updated_p determines which matrix it contributes to
2493 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2494 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2495 Adding a desired matrix means setting up used counters and such in
2496 frame rows, while adding a current window matrix to FRAME_MATRIX
2497 means copying glyphs. The latter case corresponds to
2498 preserve_other_columns in the old redisplay. */
2501 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2503 struct glyph_matrix
*window_matrix
;
2504 int window_y
, frame_y
;
2505 /* If non-zero, a glyph to insert at the right border of W. */
2506 GLYPH right_border_glyph
;
2508 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2510 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2511 if (w
->must_be_updated_p
)
2513 window_matrix
= w
->desired_matrix
;
2515 /* Decide whether we want to add a vertical border glyph. */
2516 if (!WINDOW_RIGHTMOST_P (w
))
2518 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2521 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2523 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
))
2524 && GLYPH_CODE_CHAR_VALID_P (gc
))
2526 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2527 spec_glyph_lookup_face (w
, &right_border_glyph
);
2530 if (GLYPH_FACE (right_border_glyph
) <= 0)
2531 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2535 window_matrix
= w
->current_matrix
;
2537 /* For all rows in the window matrix and corresponding rows in the
2540 frame_y
= window_matrix
->matrix_y
;
2541 while (window_y
< window_matrix
->nrows
)
2543 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2544 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2545 int current_row_p
= window_matrix
== w
->current_matrix
;
2547 /* Fill up the frame row with spaces up to the left margin of the
2549 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2551 /* Fill up areas in the window matrix row with spaces. */
2552 fill_up_glyph_row_with_spaces (window_row
);
2554 /* If only part of W's desired matrix has been built, and
2555 window_row wasn't displayed, use the corresponding current
2557 if (window_matrix
== w
->desired_matrix
2558 && !window_row
->enabled_p
)
2560 window_row
= w
->current_matrix
->rows
+ window_y
;
2566 /* Copy window row to frame row. */
2567 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2568 window_row
->glyphs
[0],
2569 window_matrix
->matrix_w
* sizeof (struct glyph
));
2573 xassert (window_row
->enabled_p
);
2575 /* Only when a desired row has been displayed, we want
2576 the corresponding frame row to be updated. */
2577 frame_row
->enabled_p
= 1;
2579 /* Maybe insert a vertical border between horizontally adjacent
2581 if (GLYPH_CHAR (right_border_glyph
) != 0)
2583 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2584 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2588 /* Window row window_y must be a slice of frame row
2590 xassert (glyph_row_slice_p (window_row
, frame_row
));
2592 /* If rows are in sync, we don't have to copy glyphs because
2593 frame and window share glyphs. */
2595 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2596 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2600 /* Set number of used glyphs in the frame matrix. Since we fill
2601 up with spaces, and visit leaf windows from left to right it
2602 can be done simply. */
2603 frame_row
->used
[TEXT_AREA
]
2604 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2612 /* Given a user-specified glyph, possibly including a Lisp-level face
2613 ID, return a glyph that has a realized face ID.
2614 This is used for glyphs displayed specially and not part of the text;
2615 for instance, vertical separators, truncation markers, etc. */
2618 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2620 int lface_id
= GLYPH_FACE (*glyph
);
2621 /* Convert the glyph's specified face to a realized (cache) face. */
2624 int face_id
= merge_faces (XFRAME (w
->frame
),
2625 Qt
, lface_id
, DEFAULT_FACE_ID
);
2626 SET_GLYPH_FACE (*glyph
, face_id
);
2630 /* Add spaces to a glyph row ROW in a window matrix.
2632 Each row has the form:
2634 +---------+-----------------------------+------------+
2635 | left | text | right |
2636 +---------+-----------------------------+------------+
2638 Left and right marginal areas are optional. This function adds
2639 spaces to areas so that there are no empty holes between areas.
2640 In other words: If the right area is not empty, the text area
2641 is filled up with spaces up to the right area. If the text area
2642 is not empty, the left area is filled up.
2644 To be called for frame-based redisplay, only. */
2647 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2649 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2650 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2651 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2655 /* Fill area AREA of glyph row ROW with spaces. To be called for
2656 frame-based redisplay only. */
2659 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2661 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2663 struct glyph
*end
= row
->glyphs
[area
+ 1];
2664 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2667 *text
++ = space_glyph
;
2668 row
->used
[area
] = text
- row
->glyphs
[area
];
2673 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2674 reached. In frame matrices only one area, TEXT_AREA, is used. */
2677 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2679 int i
= row
->used
[TEXT_AREA
];
2680 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2683 glyph
[i
++] = space_glyph
;
2685 row
->used
[TEXT_AREA
] = i
;
2690 /**********************************************************************
2691 Mirroring operations on frame matrices in window matrices
2692 **********************************************************************/
2694 /* Set frame being updated via frame-based redisplay to F. This
2695 function must be called before updates to make explicit that we are
2696 working on frame matrices or not. */
2699 set_frame_matrix_frame (struct frame
*f
)
2701 frame_matrix_frame
= f
;
2705 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2706 DESIRED_MATRIX is the desired matrix corresponding to
2707 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2708 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2709 frame_matrix_frame is non-null, this indicates that the exchange is
2710 done in frame matrices, and that we have to perform analogous
2711 operations in window matrices of frame_matrix_frame. */
2714 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2716 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2717 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2718 int mouse_face_p
= current_row
->mouse_face_p
;
2720 /* Do current_row = desired_row. This exchanges glyph pointers
2721 between both rows, and does a structure assignment otherwise. */
2722 assign_row (current_row
, desired_row
);
2724 /* Enable current_row to mark it as valid. */
2725 current_row
->enabled_p
= 1;
2726 current_row
->mouse_face_p
= mouse_face_p
;
2728 /* If we are called on frame matrices, perform analogous operations
2729 for window matrices. */
2730 if (frame_matrix_frame
)
2731 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2735 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2736 W's frame which has been made current (by swapping pointers between
2737 current and desired matrix). Perform analogous operations in the
2738 matrices of leaf windows in the window tree rooted at W. */
2741 mirror_make_current (struct window
*w
, int frame_row
)
2745 if (!NILP (w
->hchild
))
2746 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2747 else if (!NILP (w
->vchild
))
2748 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2751 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2752 here because the checks performed in debug mode there
2753 will not allow the conversion. */
2754 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2756 /* If FRAME_ROW is within W, assign the desired row to the
2757 current row (exchanging glyph pointers). */
2758 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2760 struct glyph_row
*current_row
2761 = MATRIX_ROW (w
->current_matrix
, row
);
2762 struct glyph_row
*desired_row
2763 = MATRIX_ROW (w
->desired_matrix
, row
);
2765 if (desired_row
->enabled_p
)
2766 assign_row (current_row
, desired_row
);
2768 swap_glyph_pointers (desired_row
, current_row
);
2769 current_row
->enabled_p
= 1;
2771 /* Set the Y coordinate of the mode/header line's row.
2772 It is needed in draw_row_with_mouse_face to find the
2773 screen coordinates. (Window-based redisplay sets
2774 this in update_window, but no one seems to do that
2775 for frame-based redisplay.) */
2776 if (current_row
->mode_line_p
)
2777 current_row
->y
= row
;
2781 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2786 /* Perform row dance after scrolling. We are working on the range of
2787 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2788 including) in MATRIX. COPY_FROM is a vector containing, for each
2789 row I in the range 0 <= I < NLINES, the index of the original line
2790 to move to I. This index is relative to the row range, i.e. 0 <=
2791 index < NLINES. RETAINED_P is a vector containing zero for each
2792 row 0 <= I < NLINES which is empty.
2794 This function is called from do_scrolling and do_direct_scrolling. */
2797 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2798 int *copy_from
, char *retained_p
)
2800 /* A copy of original rows. */
2801 struct glyph_row
*old_rows
;
2803 /* Rows to assign to. */
2804 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2808 /* Make a copy of the original rows. */
2809 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2810 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2812 /* Assign new rows, maybe clear lines. */
2813 for (i
= 0; i
< nlines
; ++i
)
2815 int enabled_before_p
= new_rows
[i
].enabled_p
;
2817 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2818 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2819 new_rows
[i
] = old_rows
[copy_from
[i
]];
2820 new_rows
[i
].enabled_p
= enabled_before_p
;
2822 /* RETAINED_P is zero for empty lines. */
2823 if (!retained_p
[copy_from
[i
]])
2824 new_rows
[i
].enabled_p
= 0;
2827 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2828 if (frame_matrix_frame
)
2829 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2830 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2834 /* Synchronize glyph pointers in the current matrix of window W with
2835 the current frame matrix. */
2838 sync_window_with_frame_matrix_rows (struct window
*w
)
2840 struct frame
*f
= XFRAME (w
->frame
);
2841 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2842 int left
, right
, x
, width
;
2844 /* Preconditions: W must be a leaf window on a tty frame. */
2845 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2846 xassert (!FRAME_WINDOW_P (f
));
2848 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2849 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2850 x
= w
->current_matrix
->matrix_x
;
2851 width
= w
->current_matrix
->matrix_w
;
2853 window_row
= w
->current_matrix
->rows
;
2854 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2855 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2857 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2859 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2860 = frame_row
->glyphs
[0] + x
;
2861 window_row
->glyphs
[TEXT_AREA
]
2862 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2863 window_row
->glyphs
[LAST_AREA
]
2864 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2865 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2866 = window_row
->glyphs
[LAST_AREA
] - right
;
2871 /* Return the window in the window tree rooted in W containing frame
2872 row ROW. Value is null if none is found. */
2874 static struct window
*
2875 frame_row_to_window (struct window
*w
, int row
)
2877 struct window
*found
= NULL
;
2881 if (!NILP (w
->hchild
))
2882 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2883 else if (!NILP (w
->vchild
))
2884 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2885 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2886 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2889 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2896 /* Perform a line dance in the window tree rooted at W, after
2897 scrolling a frame matrix in mirrored_line_dance.
2899 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2900 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2901 COPY_FROM is a vector containing, for each row I in the range 0 <=
2902 I < NLINES, the index of the original line to move to I. This
2903 index is relative to the row range, i.e. 0 <= index < NLINES.
2904 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2908 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2912 if (!NILP (w
->hchild
))
2913 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2914 nlines
, copy_from
, retained_p
);
2915 else if (!NILP (w
->vchild
))
2916 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2917 nlines
, copy_from
, retained_p
);
2920 /* W is a leaf window, and we are working on its current
2922 struct glyph_matrix
*m
= w
->current_matrix
;
2924 struct glyph_row
*old_rows
;
2926 /* Make a copy of the original rows of matrix m. */
2927 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2928 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2930 for (i
= 0; i
< nlines
; ++i
)
2932 /* Frame relative line assigned to. */
2933 int frame_to
= i
+ unchanged_at_top
;
2935 /* Frame relative line assigned. */
2936 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2938 /* Window relative line assigned to. */
2939 int window_to
= frame_to
- m
->matrix_y
;
2941 /* Window relative line assigned. */
2942 int window_from
= frame_from
- m
->matrix_y
;
2944 /* Is assigned line inside window? */
2945 int from_inside_window_p
2946 = window_from
>= 0 && window_from
< m
->matrix_h
;
2948 /* Is assigned to line inside window? */
2949 int to_inside_window_p
2950 = window_to
>= 0 && window_to
< m
->matrix_h
;
2952 if (from_inside_window_p
&& to_inside_window_p
)
2954 /* Enabled setting before assignment. */
2955 int enabled_before_p
;
2957 /* Do the assignment. The enabled_p flag is saved
2958 over the assignment because the old redisplay did
2960 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2961 m
->rows
[window_to
] = old_rows
[window_from
];
2962 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2964 /* If frame line is empty, window line is empty, too. */
2965 if (!retained_p
[copy_from
[i
]])
2966 m
->rows
[window_to
].enabled_p
= 0;
2968 else if (to_inside_window_p
)
2970 /* A copy between windows. This is an infrequent
2971 case not worth optimizing. */
2972 struct frame
*f
= XFRAME (w
->frame
);
2973 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2975 struct glyph_matrix
*m2
;
2978 w2
= frame_row_to_window (root
, frame_from
);
2979 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2980 -nw', FROM_FRAME sometimes has no associated window.
2981 This check avoids a segfault if W2 is null. */
2984 m2
= w2
->current_matrix
;
2985 m2_from
= frame_from
- m2
->matrix_y
;
2986 copy_row_except_pointers (m
->rows
+ window_to
,
2987 m2
->rows
+ m2_from
);
2989 /* If frame line is empty, window line is empty, too. */
2990 if (!retained_p
[copy_from
[i
]])
2991 m
->rows
[window_to
].enabled_p
= 0;
2995 else if (from_inside_window_p
)
2999 /* If there was a copy between windows, make sure glyph
3000 pointers are in sync with the frame matrix. */
3002 sync_window_with_frame_matrix_rows (w
);
3004 /* Check that no pointers are lost. */
3008 /* Next window on same level. */
3009 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3016 /* Check that window and frame matrices agree about their
3017 understanding where glyphs of the rows are to find. For each
3018 window in the window tree rooted at W, check that rows in the
3019 matrices of leaf window agree with their frame matrices about
3023 check_window_matrix_pointers (struct window
*w
)
3027 if (!NILP (w
->hchild
))
3028 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3029 else if (!NILP (w
->vchild
))
3030 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3033 struct frame
*f
= XFRAME (w
->frame
);
3034 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3035 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3038 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3043 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3044 a window and FRAME_MATRIX is the corresponding frame matrix. For
3045 each row in WINDOW_MATRIX check that it's a slice of the
3046 corresponding frame row. If it isn't, abort. */
3049 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3050 struct glyph_matrix
*frame_matrix
)
3052 /* Row number in WINDOW_MATRIX. */
3055 /* Row number corresponding to I in FRAME_MATRIX. */
3056 int j
= window_matrix
->matrix_y
;
3058 /* For all rows check that the row in the window matrix is a
3059 slice of the row in the frame matrix. If it isn't we didn't
3060 mirror an operation on the frame matrix correctly. */
3061 while (i
< window_matrix
->nrows
)
3063 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3064 frame_matrix
->rows
+ j
))
3070 #endif /* GLYPH_DEBUG != 0 */
3074 /**********************************************************************
3075 VPOS and HPOS translations
3076 **********************************************************************/
3080 /* Translate vertical position VPOS which is relative to window W to a
3081 vertical position relative to W's frame. */
3084 window_to_frame_vpos (struct window
*w
, int vpos
)
3086 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3087 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3088 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3089 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3094 /* Translate horizontal position HPOS which is relative to window W to
3095 a horizontal position relative to W's frame. */
3098 window_to_frame_hpos (struct window
*w
, int hpos
)
3100 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3101 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3105 #endif /* GLYPH_DEBUG */
3109 /**********************************************************************
3111 **********************************************************************/
3113 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3114 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3119 CHECK_LIVE_FRAME (frame
);
3122 /* Ignore redraw requests, if frame has no glyphs yet.
3123 (Implementation note: It still has to be checked why we are
3124 called so early here). */
3125 if (!glyphs_initialized_initially_p
)
3130 if (FRAME_MSDOS_P (f
))
3131 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3134 clear_current_matrices (f
);
3136 if (FRAME_TERMCAP_P (f
))
3137 fflush (FRAME_TTY (f
)->output
);
3138 windows_or_buffers_changed
++;
3139 /* Mark all windows as inaccurate, so that every window will have
3140 its redisplay done. */
3141 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3142 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3148 /* Redraw frame F. This is nothing more than a call to the Lisp
3149 function redraw-frame. */
3152 redraw_frame (struct frame
*f
)
3155 XSETFRAME (frame
, f
);
3156 Fredraw_frame (frame
);
3160 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3161 doc
: /* Clear and redisplay all visible frames. */)
3164 Lisp_Object tail
, frame
;
3166 FOR_EACH_FRAME (tail
, frame
)
3167 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3168 Fredraw_frame (frame
);
3175 /***********************************************************************
3177 ***********************************************************************/
3179 /* Update frame F based on the data in desired matrices.
3181 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3182 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3185 Value is non-zero if redisplay was stopped due to pending input. */
3188 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3190 /* 1 means display has been paused because of pending input. */
3192 struct window
*root_window
= XWINDOW (f
->root_window
);
3194 if (redisplay_dont_pause
)
3196 #if PERIODIC_PREEMPTION_CHECKING
3197 else if (NILP (Vredisplay_preemption_period
))
3199 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3202 double p
= XFLOATINT (Vredisplay_preemption_period
);
3205 if (detect_input_pending_ignore_squeezables ())
3212 usec
= (p
- sec
) * 1000000;
3214 EMACS_GET_TIME (tm
);
3215 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3216 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3220 if (FRAME_WINDOW_P (f
))
3222 /* We are working on window matrix basis. All windows whose
3223 flag must_be_updated_p is set have to be updated. */
3225 /* Record that we are not working on frame matrices. */
3226 set_frame_matrix_frame (NULL
);
3228 /* Update all windows in the window tree of F, maybe stopping
3229 when pending input is detected. */
3232 /* Update the menu bar on X frames that don't have toolkit
3234 if (WINDOWP (f
->menu_bar_window
))
3235 update_window (XWINDOW (f
->menu_bar_window
), 1);
3237 /* Update the tool-bar window, if present. */
3238 if (WINDOWP (f
->tool_bar_window
))
3240 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3242 /* Update tool-bar window. */
3243 if (w
->must_be_updated_p
)
3247 update_window (w
, 1);
3248 w
->must_be_updated_p
= 0;
3250 /* Swap tool-bar strings. We swap because we want to
3252 tem
= f
->current_tool_bar_string
;
3253 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3254 f
->desired_tool_bar_string
= tem
;
3259 /* Update windows. */
3260 paused_p
= update_window_tree (root_window
, force_p
);
3263 /* This flush is a performance bottleneck under X,
3264 and it doesn't seem to be necessary anyway (in general).
3265 It is necessary when resizing the window with the mouse, or
3266 at least the fringes are not redrawn in a timely manner. ++kfs */
3267 if (f
->force_flush_display_p
)
3269 FRAME_RIF (f
)->flush_display (f
);
3270 f
->force_flush_display_p
= 0;
3275 /* We are working on frame matrix basis. Set the frame on whose
3276 frame matrix we operate. */
3277 set_frame_matrix_frame (f
);
3279 /* Build F's desired matrix from window matrices. */
3280 build_frame_matrix (f
);
3282 /* Update the display */
3284 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3287 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3289 if (FRAME_TTY (f
)->termscript
)
3290 fflush (FRAME_TTY (f
)->termscript
);
3291 if (FRAME_TERMCAP_P (f
))
3292 fflush (FRAME_TTY (f
)->output
);
3295 /* Check window matrices for lost pointers. */
3297 check_window_matrix_pointers (root_window
);
3298 add_frame_display_history (f
, paused_p
);
3302 #if PERIODIC_PREEMPTION_CHECKING
3305 /* Reset flags indicating that a window should be updated. */
3306 set_window_update_flags (root_window
, 0);
3308 display_completed
= !paused_p
;
3314 /************************************************************************
3315 Window-based updates
3316 ************************************************************************/
3318 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3319 don't stop updating when input is pending. */
3322 update_window_tree (struct window
*w
, int force_p
)
3326 while (w
&& !paused_p
)
3328 if (!NILP (w
->hchild
))
3329 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3330 else if (!NILP (w
->vchild
))
3331 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3332 else if (w
->must_be_updated_p
)
3333 paused_p
|= update_window (w
, force_p
);
3335 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3342 /* Update window W if its flag must_be_updated_p is non-zero. If
3343 FORCE_P is non-zero, don't stop updating if input is pending. */
3346 update_single_window (struct window
*w
, int force_p
)
3348 if (w
->must_be_updated_p
)
3350 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3352 /* Record that this is not a frame-based redisplay. */
3353 set_frame_matrix_frame (NULL
);
3355 if (redisplay_dont_pause
)
3357 #if PERIODIC_PREEMPTION_CHECKING
3358 else if (NILP (Vredisplay_preemption_period
))
3360 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3363 double p
= XFLOATINT (Vredisplay_preemption_period
);
3367 usec
= (p
- sec
) * 1000000;
3369 EMACS_GET_TIME (tm
);
3370 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3371 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3377 update_window (w
, force_p
);
3380 /* Reset flag in W. */
3381 w
->must_be_updated_p
= 0;
3385 #ifdef HAVE_WINDOW_SYSTEM
3387 /* Redraw lines from the current matrix of window W that are
3388 overlapped by other rows. YB is bottom-most y-position in W. */
3391 redraw_overlapped_rows (struct window
*w
, int yb
)
3394 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3396 /* If rows overlapping others have been changed, the rows being
3397 overlapped have to be redrawn. This won't draw lines that have
3398 already been drawn in update_window_line because overlapped_p in
3399 desired rows is 0, so after row assignment overlapped_p in
3400 current rows is 0. */
3401 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3403 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3405 if (!row
->enabled_p
)
3407 else if (row
->mode_line_p
)
3410 if (row
->overlapped_p
)
3412 enum glyph_row_area area
;
3414 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3417 updated_area
= area
;
3418 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3419 area
== TEXT_AREA
? row
->x
: 0);
3420 if (row
->used
[area
])
3421 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3423 FRAME_RIF (f
)->clear_end_of_line (-1);
3426 row
->overlapped_p
= 0;
3429 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3435 /* Redraw lines from the current matrix of window W that overlap
3436 others. YB is bottom-most y-position in W. */
3439 redraw_overlapping_rows (struct window
*w
, int yb
)
3442 struct glyph_row
*row
;
3443 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3445 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3447 row
= w
->current_matrix
->rows
+ i
;
3449 if (!row
->enabled_p
)
3451 else if (row
->mode_line_p
)
3454 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3456 if (row
->overlapping_p
)
3460 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3461 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3462 overlaps
|= OVERLAPS_PRED
;
3463 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3464 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3465 overlaps
|= OVERLAPS_SUCC
;
3469 if (row
->used
[LEFT_MARGIN_AREA
])
3470 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3472 if (row
->used
[TEXT_AREA
])
3473 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3475 if (row
->used
[RIGHT_MARGIN_AREA
])
3476 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3478 /* Record in neighbour rows that ROW overwrites part of
3480 if (overlaps
& OVERLAPS_PRED
)
3481 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3482 if (overlaps
& OVERLAPS_SUCC
)
3483 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3492 #endif /* HAVE_WINDOW_SYSTEM */
3495 #if defined GLYPH_DEBUG && 0
3497 /* Check that no row in the current matrix of window W is enabled
3498 which is below what's displayed in the window. */
3501 check_current_matrix_flags (struct window
*w
)
3503 int last_seen_p
= 0;
3504 int i
, yb
= window_text_bottom_y (w
);
3506 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3508 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3509 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3511 else if (last_seen_p
&& row
->enabled_p
)
3516 #endif /* GLYPH_DEBUG */
3519 /* Update display of window W. FORCE_P non-zero means that we should
3520 not stop when detecting pending input. */
3523 update_window (struct window
*w
, int force_p
)
3525 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3527 #if !PERIODIC_PREEMPTION_CHECKING
3528 int preempt_count
= baud_rate
/ 2400 + 1;
3530 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3532 /* Check that W's frame doesn't have glyph matrices. */
3533 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3536 /* Check pending input the first time so that we can quickly return. */
3537 #if !PERIODIC_PREEMPTION_CHECKING
3539 detect_input_pending_ignore_squeezables ();
3542 /* If forced to complete the update, or if no input is pending, do
3544 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3546 struct glyph_row
*row
, *end
;
3547 struct glyph_row
*mode_line_row
;
3548 struct glyph_row
*header_line_row
;
3549 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3550 #if ! PERIODIC_PREEMPTION_CHECKING
3554 rif
->update_window_begin_hook (w
);
3555 yb
= window_text_bottom_y (w
);
3557 /* If window has a header line, update it before everything else.
3558 Adjust y-positions of other rows by the header line height. */
3559 row
= desired_matrix
->rows
;
3560 end
= row
+ desired_matrix
->nrows
- 1;
3562 if (row
->mode_line_p
)
3564 header_line_row
= row
;
3568 header_line_row
= NULL
;
3570 /* Update the mode line, if necessary. */
3571 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3572 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3574 mode_line_row
->y
= yb
;
3575 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3577 &mouse_face_overwritten_p
);
3580 /* Find first enabled row. Optimizations in redisplay_internal
3581 may lead to an update with only one row enabled. There may
3582 be also completely empty matrices. */
3583 while (row
< end
&& !row
->enabled_p
)
3586 /* Try reusing part of the display by copying. */
3587 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3589 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3592 /* All rows were found to be equal. */
3598 /* We've scrolled the display. */
3604 /* Update the rest of the lines. */
3605 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3608 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3611 /* We'll have to play a little bit with when to
3612 detect_input_pending. If it's done too often,
3613 scrolling large windows with repeated scroll-up
3614 commands will too quickly pause redisplay. */
3615 #if PERIODIC_PREEMPTION_CHECKING
3619 EMACS_GET_TIME (tm
);
3620 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3621 if (EMACS_TIME_NEG_P (dif
))
3623 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3624 if (detect_input_pending_ignore_squeezables ())
3629 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3630 detect_input_pending_ignore_squeezables ();
3632 changed_p
|= update_window_line (w
, vpos
,
3633 &mouse_face_overwritten_p
);
3635 /* Mark all rows below the last visible one in the current
3636 matrix as invalid. This is necessary because of
3637 variable line heights. Consider the case of three
3638 successive redisplays, where the first displays 5
3639 lines, the second 3 lines, and the third 5 lines again.
3640 If the second redisplay wouldn't mark rows in the
3641 current matrix invalid, the third redisplay might be
3642 tempted to optimize redisplay based on lines displayed
3643 in the first redisplay. */
3644 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3645 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3646 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3649 /* Was display preempted? */
3650 paused_p
= row
< end
;
3654 /* Update the header line after scrolling because a new header
3655 line would otherwise overwrite lines at the top of the window
3656 that can be scrolled. */
3657 if (header_line_row
&& header_line_row
->enabled_p
)
3659 header_line_row
->y
= 0;
3660 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3663 /* Fix the appearance of overlapping/overlapped rows. */
3664 if (!paused_p
&& !w
->pseudo_window_p
)
3666 #ifdef HAVE_WINDOW_SYSTEM
3667 if (changed_p
&& rif
->fix_overlapping_area
)
3669 redraw_overlapped_rows (w
, yb
);
3670 redraw_overlapping_rows (w
, yb
);
3674 /* Make cursor visible at cursor position of W. */
3675 set_window_cursor_after_update (w
);
3677 #if 0 /* Check that current matrix invariants are satisfied. This is
3678 for debugging only. See the comment of check_matrix_invariants. */
3679 IF_DEBUG (check_matrix_invariants (w
));
3684 /* Remember the redisplay method used to display the matrix. */
3685 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3688 #ifdef HAVE_WINDOW_SYSTEM
3689 update_window_fringes (w
, 0);
3692 /* End the update of window W. Don't set the cursor if we
3693 paused updating the display because in this case,
3694 set_window_cursor_after_update hasn't been called, and
3695 output_cursor doesn't contain the cursor location. */
3696 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3702 /* check_current_matrix_flags (w); */
3703 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3706 clear_glyph_matrix (desired_matrix
);
3712 /* Update the display of area AREA in window W, row number VPOS.
3713 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3716 update_marginal_area (struct window
*w
, int area
, int vpos
)
3718 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3719 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3721 /* Let functions in xterm.c know what area subsequent X positions
3722 will be relative to. */
3723 updated_area
= area
;
3725 /* Set cursor to start of glyphs, write them, and clear to the end
3726 of the area. I don't think that something more sophisticated is
3727 necessary here, since marginal areas will not be the default. */
3728 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3729 if (desired_row
->used
[area
])
3730 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3731 rif
->clear_end_of_line (-1);
3735 /* Update the display of the text area of row VPOS in window W.
3736 Value is non-zero if display has changed. */
3739 update_text_area (struct window
*w
, int vpos
)
3741 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3742 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3743 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3746 /* Let functions in xterm.c know what area subsequent X positions
3747 will be relative to. */
3748 updated_area
= TEXT_AREA
;
3750 /* If rows are at different X or Y, or rows have different height,
3751 or the current row is marked invalid, write the entire line. */
3752 if (!current_row
->enabled_p
3753 || desired_row
->y
!= current_row
->y
3754 || desired_row
->ascent
!= current_row
->ascent
3755 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3756 || desired_row
->phys_height
!= current_row
->phys_height
3757 || desired_row
->visible_height
!= current_row
->visible_height
3758 || current_row
->overlapped_p
3759 /* This next line is necessary for correctly redrawing
3760 mouse-face areas after scrolling and other operations.
3761 However, it causes excessive flickering when mouse is moved
3762 across the mode line. Luckily, turning it off for the mode
3763 line doesn't seem to hurt anything. -- cyd.
3764 But it is still needed for the header line. -- kfs. */
3765 || (current_row
->mouse_face_p
3766 && !(current_row
->mode_line_p
&& vpos
> 0))
3767 || current_row
->x
!= desired_row
->x
)
3769 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3771 if (desired_row
->used
[TEXT_AREA
])
3772 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3773 desired_row
->used
[TEXT_AREA
]);
3775 /* Clear to end of window. */
3776 rif
->clear_end_of_line (-1);
3779 /* This erases the cursor. We do this here because
3780 notice_overwritten_cursor cannot easily check this, which
3781 might indicate that the whole functionality of
3782 notice_overwritten_cursor would better be implemented here.
3783 On the other hand, we need notice_overwritten_cursor as long
3784 as mouse highlighting is done asynchronously outside of
3786 if (vpos
== w
->phys_cursor
.vpos
)
3787 w
->phys_cursor_on_p
= 0;
3792 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3793 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3794 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3795 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3796 int abort_skipping
= 0;
3798 /* If the desired row extends its face to the text area end, and
3799 unless the current row also does so at the same position,
3800 make sure we write at least one glyph, so that the face
3801 extension actually takes place. */
3802 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3803 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3804 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3805 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3808 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3812 /* Loop over glyphs that current and desired row may have
3816 int can_skip_p
= !abort_skipping
;
3818 /* Skip over glyphs that both rows have in common. These
3819 don't have to be written. We can't skip if the last
3820 current glyph overlaps the glyph to its right. For
3821 example, consider a current row of `if ' with the `f' in
3822 Courier bold so that it overlaps the ` ' to its right.
3823 If the desired row is ` ', we would skip over the space
3824 after the `if' and there would remain a pixel from the
3825 `f' on the screen. */
3826 if (overlapping_glyphs_p
&& i
> 0)
3828 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3831 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3833 can_skip_p
= (right
== 0 && !abort_skipping
);
3841 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3843 x
+= desired_glyph
->pixel_width
;
3844 ++desired_glyph
, ++current_glyph
, ++i
;
3847 /* Consider the case that the current row contains "xxx
3848 ppp ggg" in italic Courier font, and the desired row
3849 is "xxx ggg". The character `p' has lbearing, `g'
3850 has not. The loop above will stop in front of the
3851 first `p' in the current row. If we would start
3852 writing glyphs there, we wouldn't erase the lbearing
3853 of the `p'. The rest of the lbearing problem is then
3854 taken care of by draw_glyphs. */
3855 if (overlapping_glyphs_p
3857 && i
< current_row
->used
[TEXT_AREA
]
3858 && (current_row
->used
[TEXT_AREA
]
3859 != desired_row
->used
[TEXT_AREA
]))
3863 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3865 while (left
> 0 && i
> 0)
3867 --i
, --desired_glyph
, --current_glyph
;
3868 x
-= desired_glyph
->pixel_width
;
3869 left
-= desired_glyph
->pixel_width
;
3872 /* Abort the skipping algorithm if we end up before
3873 our starting point, to avoid looping (bug#1070).
3874 This can happen when the lbearing is larger than
3876 abort_skipping
= (i
< start_hpos
);
3880 /* Try to avoid writing the entire rest of the desired row
3881 by looking for a resync point. This mainly prevents
3882 mode line flickering in the case the mode line is in
3883 fixed-pitch font, which it usually will be. */
3884 if (i
< desired_row
->used
[TEXT_AREA
])
3886 int start_x
= x
, start_hpos
= i
;
3887 struct glyph
*start
= desired_glyph
;
3889 int skip_first_p
= !can_skip_p
;
3891 /* Find the next glyph that's equal again. */
3894 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3897 x
+= desired_glyph
->pixel_width
;
3898 current_x
+= current_glyph
->pixel_width
;
3899 ++desired_glyph
, ++current_glyph
, ++i
;
3903 if (i
== start_hpos
|| x
!= current_x
)
3907 desired_glyph
= start
;
3911 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3912 rif
->write_glyphs (start
, i
- start_hpos
);
3917 /* Write the rest. */
3918 if (i
< desired_row
->used
[TEXT_AREA
])
3920 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3921 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3925 /* Maybe clear to end of line. */
3926 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3928 /* If new row extends to the end of the text area, nothing
3929 has to be cleared, if and only if we did a write_glyphs
3930 above. This is made sure by setting desired_stop_pos
3931 appropriately above. */
3932 xassert (i
< desired_row
->used
[TEXT_AREA
]
3933 || ((desired_row
->used
[TEXT_AREA
]
3934 == current_row
->used
[TEXT_AREA
])
3935 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3937 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3939 /* If old row extends to the end of the text area, clear. */
3940 if (i
>= desired_row
->used
[TEXT_AREA
])
3941 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3942 desired_row
->pixel_width
);
3943 rif
->clear_end_of_line (-1);
3946 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3948 /* Otherwise clear to the end of the old row. Everything
3949 after that position should be clear already. */
3952 if (i
>= desired_row
->used
[TEXT_AREA
])
3953 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3954 desired_row
->pixel_width
);
3956 /* If cursor is displayed at the end of the line, make sure
3957 it's cleared. Nowadays we don't have a phys_cursor_glyph
3958 with which to erase the cursor (because this method
3959 doesn't work with lbearing/rbearing), so we must do it
3961 if (vpos
== w
->phys_cursor
.vpos
3962 && (desired_row
->reversed_p
3963 ? (w
->phys_cursor
.hpos
< 0)
3964 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3966 w
->phys_cursor_on_p
= 0;
3970 xlim
= current_row
->pixel_width
;
3971 rif
->clear_end_of_line (xlim
);
3980 /* Update row VPOS in window W. Value is non-zero if display has been
3984 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
3986 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3987 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3988 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3991 /* Set the row being updated. This is important to let xterm.c
3992 know what line height values are in effect. */
3993 updated_row
= desired_row
;
3995 /* A row can be completely invisible in case a desired matrix was
3996 built with a vscroll and then make_cursor_line_fully_visible shifts
3997 the matrix. Make sure to make such rows current anyway, since
3998 we need the correct y-position, for example, in the current matrix. */
3999 if (desired_row
->mode_line_p
4000 || desired_row
->visible_height
> 0)
4002 xassert (desired_row
->enabled_p
);
4004 /* Update display of the left margin area, if there is one. */
4005 if (!desired_row
->full_width_p
4006 && !NILP (w
->left_margin_cols
))
4009 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4012 /* Update the display of the text area. */
4013 if (update_text_area (w
, vpos
))
4016 if (current_row
->mouse_face_p
)
4017 *mouse_face_overwritten_p
= 1;
4020 /* Update display of the right margin area, if there is one. */
4021 if (!desired_row
->full_width_p
4022 && !NILP (w
->right_margin_cols
))
4025 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4028 /* Draw truncation marks etc. */
4029 if (!current_row
->enabled_p
4030 || desired_row
->y
!= current_row
->y
4031 || desired_row
->visible_height
!= current_row
->visible_height
4032 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4033 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4034 || current_row
->redraw_fringe_bitmaps_p
4035 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4036 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4037 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4038 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4039 rif
->after_update_window_line_hook (desired_row
);
4042 /* Update current_row from desired_row. */
4043 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4049 /* Set the cursor after an update of window W. This function may only
4050 be called from update_window. */
4053 set_window_cursor_after_update (struct window
*w
)
4055 struct frame
*f
= XFRAME (w
->frame
);
4056 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4057 int cx
, cy
, vpos
, hpos
;
4059 /* Not intended for frame matrix updates. */
4060 xassert (FRAME_WINDOW_P (f
));
4062 if (cursor_in_echo_area
4063 && !NILP (echo_area_buffer
[0])
4064 /* If we are showing a message instead of the mini-buffer,
4065 show the cursor for the message instead. */
4066 && XWINDOW (minibuf_window
) == w
4067 && EQ (minibuf_window
, echo_area_window
)
4068 /* These cases apply only to the frame that contains
4069 the active mini-buffer window. */
4070 && FRAME_HAS_MINIBUF_P (f
)
4071 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4073 cx
= cy
= vpos
= hpos
= 0;
4075 if (cursor_in_echo_area
>= 0)
4077 /* If the mini-buffer is several lines high, find the last
4078 line that has any text on it. Note: either all lines
4079 are enabled or none. Otherwise we wouldn't be able to
4081 struct glyph_row
*row
, *last_row
;
4082 struct glyph
*glyph
;
4083 int yb
= window_text_bottom_y (w
);
4086 row
= w
->current_matrix
->rows
;
4087 while (row
->enabled_p
4088 && (last_row
== NULL
4089 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4091 if (row
->used
[TEXT_AREA
]
4092 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4099 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4100 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4102 while (last
> start
&& last
->charpos
< 0)
4105 for (glyph
= start
; glyph
< last
; ++glyph
)
4107 cx
+= glyph
->pixel_width
;
4112 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4120 hpos
= w
->cursor
.hpos
;
4121 vpos
= w
->cursor
.vpos
;
4124 /* Window cursor can be out of sync for horizontally split windows. */
4125 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4126 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4127 vpos
= max (0, vpos
);
4128 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4129 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4133 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4134 tree rooted at W. */
4137 set_window_update_flags (struct window
*w
, int on_p
)
4141 if (!NILP (w
->hchild
))
4142 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4143 else if (!NILP (w
->vchild
))
4144 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4146 w
->must_be_updated_p
= on_p
;
4148 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4154 /***********************************************************************
4155 Window-Based Scrolling
4156 ***********************************************************************/
4158 /* Structure describing rows in scrolling_window. */
4162 /* Number of occurrences of this row in desired and current matrix. */
4163 int old_uses
, new_uses
;
4165 /* Vpos of row in new matrix. */
4166 int new_line_number
;
4168 /* Bucket index of this row_entry in the hash table row_table. */
4171 /* The row described by this entry. */
4172 struct glyph_row
*row
;
4174 /* Hash collision chain. */
4175 struct row_entry
*next
;
4178 /* A pool to allocate row_entry structures from, and the size of the
4179 pool. The pool is reallocated in scrolling_window when we find
4180 that we need a larger one. */
4182 static struct row_entry
*row_entry_pool
;
4183 static int row_entry_pool_size
;
4185 /* Index of next free entry in row_entry_pool. */
4187 static int row_entry_idx
;
4189 /* The hash table used during scrolling, and the table's size. This
4190 table is used to quickly identify equal rows in the desired and
4193 static struct row_entry
**row_table
;
4194 static int row_table_size
;
4196 /* Vectors of pointers to row_entry structures belonging to the
4197 current and desired matrix, and the size of the vectors. */
4199 static struct row_entry
**old_lines
, **new_lines
;
4200 static int old_lines_size
, new_lines_size
;
4202 /* A pool to allocate run structures from, and its size. */
4204 static struct run
*run_pool
;
4205 static int runs_size
;
4207 /* A vector of runs of lines found during scrolling. */
4209 static struct run
**runs
;
4211 /* Add glyph row ROW to the scrolling hash table. */
4213 static inline struct row_entry
*
4214 add_row_entry (struct glyph_row
*row
)
4216 struct row_entry
*entry
;
4217 int i
= row
->hash
% row_table_size
;
4219 entry
= row_table
[i
];
4220 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4221 entry
= entry
->next
;
4225 entry
= row_entry_pool
+ row_entry_idx
++;
4227 entry
->old_uses
= entry
->new_uses
= 0;
4228 entry
->new_line_number
= 0;
4230 entry
->next
= row_table
[i
];
4231 row_table
[i
] = entry
;
4238 /* Try to reuse part of the current display of W by scrolling lines.
4239 HEADER_LINE_P non-zero means W has a header line.
4241 The algorithm is taken from Communications of the ACM, Apr78 "A
4242 Technique for Isolating Differences Between Files." It should take
4245 A short outline of the steps of the algorithm
4247 1. Skip lines equal at the start and end of both matrices.
4249 2. Enter rows in the current and desired matrix into a symbol
4250 table, counting how often they appear in both matrices.
4252 3. Rows that appear exactly once in both matrices serve as anchors,
4253 i.e. we assume that such lines are likely to have been moved.
4255 4. Starting from anchor lines, extend regions to be scrolled both
4256 forward and backward.
4260 -1 if all rows were found to be equal.
4261 0 to indicate that we did not scroll the display, or
4262 1 if we did scroll. */
4265 scrolling_window (struct window
*w
, int header_line_p
)
4267 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4268 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4269 int yb
= window_text_bottom_y (w
);
4270 int i
, j
, first_old
, first_new
, last_old
, last_new
;
4271 int nruns
, n
, run_idx
;
4273 struct row_entry
*entry
;
4274 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4276 /* Skip over rows equal at the start. */
4277 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4279 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4280 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4284 && !d
->redraw_fringe_bitmaps_p
4286 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4287 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4288 && row_equal_p (c
, d
, 1))
4297 /* Give up if some rows in the desired matrix are not enabled. */
4298 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4301 first_old
= first_new
= i
;
4303 /* Set last_new to the index + 1 of the row that reaches the
4304 bottom boundary in the desired matrix. Give up if we find a
4305 disabled row before we reach the bottom boundary. */
4307 while (i
< desired_matrix
->nrows
- 1)
4311 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4313 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4322 /* Set last_old to the index + 1 of the row that reaches the bottom
4323 boundary in the current matrix. We don't look at the enabled
4324 flag here because we plan to reuse part of the display even if
4325 other parts are disabled. */
4327 while (i
< current_matrix
->nrows
- 1)
4329 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4338 /* Skip over rows equal at the bottom. */
4341 while (i
- 1 > first_new
4342 && j
- 1 > first_old
4343 && MATRIX_ROW (current_matrix
, i
- 1)->enabled_p
4344 && (MATRIX_ROW (current_matrix
, i
- 1)->y
4345 == MATRIX_ROW (desired_matrix
, j
- 1)->y
)
4346 && !MATRIX_ROW (desired_matrix
, j
- 1)->redraw_fringe_bitmaps_p
4347 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4348 MATRIX_ROW (current_matrix
, j
- 1), 1))
4353 /* Nothing to do if all rows are equal. */
4354 if (last_new
== first_new
)
4357 /* Reallocate vectors, tables etc. if necessary. */
4359 if (current_matrix
->nrows
> old_lines_size
)
4361 old_lines_size
= current_matrix
->nrows
;
4362 nbytes
= old_lines_size
* sizeof *old_lines
;
4363 old_lines
= (struct row_entry
**) xrealloc (old_lines
, nbytes
);
4366 if (desired_matrix
->nrows
> new_lines_size
)
4368 new_lines_size
= desired_matrix
->nrows
;
4369 nbytes
= new_lines_size
* sizeof *new_lines
;
4370 new_lines
= (struct row_entry
**) xrealloc (new_lines
, nbytes
);
4373 n
= desired_matrix
->nrows
+ current_matrix
->nrows
;
4374 if (3 * n
> row_table_size
)
4376 row_table_size
= next_almost_prime (3 * n
);
4377 nbytes
= row_table_size
* sizeof *row_table
;
4378 row_table
= (struct row_entry
**) xrealloc (row_table
, nbytes
);
4379 memset (row_table
, 0, nbytes
);
4382 if (n
> row_entry_pool_size
)
4384 row_entry_pool_size
= n
;
4385 nbytes
= row_entry_pool_size
* sizeof *row_entry_pool
;
4386 row_entry_pool
= (struct row_entry
*) xrealloc (row_entry_pool
, nbytes
);
4389 if (desired_matrix
->nrows
> runs_size
)
4391 runs_size
= desired_matrix
->nrows
;
4392 nbytes
= runs_size
* sizeof *runs
;
4393 runs
= (struct run
**) xrealloc (runs
, nbytes
);
4394 nbytes
= runs_size
* sizeof *run_pool
;
4395 run_pool
= (struct run
*) xrealloc (run_pool
, nbytes
);
4398 nruns
= run_idx
= 0;
4401 /* Add rows from the current and desired matrix to the hash table
4402 row_hash_table to be able to find equal ones quickly. */
4404 for (i
= first_old
; i
< last_old
; ++i
)
4406 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4408 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4409 old_lines
[i
] = entry
;
4413 old_lines
[i
] = NULL
;
4416 for (i
= first_new
; i
< last_new
; ++i
)
4418 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4419 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4421 entry
->new_line_number
= i
;
4422 new_lines
[i
] = entry
;
4425 /* Identify moves based on lines that are unique and equal
4426 in both matrices. */
4427 for (i
= first_old
; i
< last_old
;)
4429 && old_lines
[i
]->old_uses
== 1
4430 && old_lines
[i
]->new_uses
== 1)
4433 int new_line
= old_lines
[i
]->new_line_number
;
4434 struct run
*run
= run_pool
+ run_idx
++;
4437 run
->current_vpos
= i
;
4438 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4439 run
->desired_vpos
= new_line
;
4440 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4442 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4444 /* Extend backward. */
4447 while (p
> first_old
4449 && old_lines
[p
] == new_lines
[q
])
4451 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4452 --run
->current_vpos
;
4453 --run
->desired_vpos
;
4456 run
->desired_y
-= h
;
4457 run
->current_y
-= h
;
4461 /* Extend forward. */
4466 && old_lines
[p
] == new_lines
[q
])
4468 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4474 /* Insert run into list of all runs. Order runs by copied
4475 pixel lines. Note that we record runs that don't have to
4476 be copied because they are already in place. This is done
4477 because we can avoid calling update_window_line in this
4479 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4481 for (q
= nruns
; q
> p
; --q
)
4482 runs
[q
] = runs
[q
- 1];
4491 /* Do the moves. Do it in a way that we don't overwrite something
4492 we want to copy later on. This is not solvable in general
4493 because there is only one display and we don't have a way to
4494 exchange areas on this display. Example:
4496 +-----------+ +-----------+
4498 +-----------+ --> +-----------+
4500 +-----------+ +-----------+
4502 Instead, prefer bigger moves, and invalidate moves that would
4503 copy from where we copied to. */
4505 for (i
= 0; i
< nruns
; ++i
)
4506 if (runs
[i
]->nrows
> 0)
4508 struct run
*r
= runs
[i
];
4510 /* Copy on the display. */
4511 if (r
->current_y
!= r
->desired_y
)
4513 rif
->clear_window_mouse_face (w
);
4514 rif
->scroll_run_hook (w
, r
);
4516 /* Invalidate runs that copy from where we copied to. */
4517 for (j
= i
+ 1; j
< nruns
; ++j
)
4519 struct run
*p
= runs
[j
];
4521 if ((p
->current_y
>= r
->desired_y
4522 && p
->current_y
< r
->desired_y
+ r
->height
)
4523 || (p
->current_y
+ p
->height
>= r
->desired_y
4524 && (p
->current_y
+ p
->height
4525 < r
->desired_y
+ r
->height
)))
4530 /* Assign matrix rows. */
4531 for (j
= 0; j
< r
->nrows
; ++j
)
4533 struct glyph_row
*from
, *to
;
4534 int to_overlapped_p
;
4536 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4537 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4538 to_overlapped_p
= to
->overlapped_p
;
4539 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4540 assign_row (to
, from
);
4541 to
->enabled_p
= 1, from
->enabled_p
= 0;
4542 to
->overlapped_p
= to_overlapped_p
;
4546 /* Clear the hash table, for the next time. */
4547 for (i
= 0; i
< row_entry_idx
; ++i
)
4548 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4550 /* Value is 1 to indicate that we scrolled the display. */
4556 /************************************************************************
4558 ************************************************************************/
4560 /* Update the desired frame matrix of frame F.
4562 FORCE_P non-zero means that the update should not be stopped by
4563 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4564 should not be tried.
4566 Value is non-zero if update was stopped due to pending input. */
4569 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4571 /* Frame matrices to work on. */
4572 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4573 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4576 int preempt_count
= baud_rate
/ 2400 + 1;
4578 xassert (current_matrix
&& desired_matrix
);
4580 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4581 calculate_costs (f
);
4583 if (preempt_count
<= 0)
4586 #if !PERIODIC_PREEMPTION_CHECKING
4587 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4594 /* If we cannot insert/delete lines, it's no use trying it. */
4595 if (!FRAME_LINE_INS_DEL_OK (f
))
4598 /* See if any of the desired lines are enabled; don't compute for
4599 i/d line if just want cursor motion. */
4600 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4601 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4604 /* Try doing i/d line, if not yet inhibited. */
4605 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4606 force_p
|= scrolling (f
);
4608 /* Update the individual lines as needed. Do bottom line first. */
4609 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4610 update_frame_line (f
, desired_matrix
->nrows
- 1);
4612 /* Now update the rest of the lines. */
4613 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4615 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4617 if (FRAME_TERMCAP_P (f
))
4619 /* Flush out every so many lines.
4620 Also flush out if likely to have more than 1k buffered
4621 otherwise. I'm told that some telnet connections get
4622 really screwed by more than 1k output at once. */
4623 FILE *display_output
= FRAME_TTY (f
)->output
;
4626 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4628 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4630 fflush (display_output
);
4631 if (preempt_count
== 1)
4633 #ifdef EMACS_OUTQSIZE
4634 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4635 /* Probably not a tty. Ignore the error and reset
4637 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4640 if (baud_rate
<= outq
&& baud_rate
> 0)
4641 sleep (outq
/ baud_rate
);
4647 #if PERIODIC_PREEMPTION_CHECKING
4651 EMACS_GET_TIME (tm
);
4652 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4653 if (EMACS_TIME_NEG_P (dif
))
4655 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4656 if (detect_input_pending_ignore_squeezables ())
4661 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4662 detect_input_pending_ignore_squeezables ();
4665 update_frame_line (f
, i
);
4669 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4671 /* Now just clean up termcap drivers and set cursor, etc. */
4674 if ((cursor_in_echo_area
4675 /* If we are showing a message instead of the mini-buffer,
4676 show the cursor for the message instead of for the
4677 (now hidden) mini-buffer contents. */
4678 || (EQ (minibuf_window
, selected_window
)
4679 && EQ (minibuf_window
, echo_area_window
)
4680 && !NILP (echo_area_buffer
[0])))
4681 /* These cases apply only to the frame that contains
4682 the active mini-buffer window. */
4683 && FRAME_HAS_MINIBUF_P (f
)
4684 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4686 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4689 if (cursor_in_echo_area
< 0)
4691 /* Negative value of cursor_in_echo_area means put
4692 cursor at beginning of line. */
4698 /* Positive value of cursor_in_echo_area means put
4699 cursor at the end of the prompt. If the mini-buffer
4700 is several lines high, find the last line that has
4702 row
= FRAME_LINES (f
);
4708 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4710 /* Frame rows are filled up with spaces that
4711 must be ignored here. */
4712 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4714 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4715 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4718 && (last
- 1)->charpos
< 0)
4724 while (row
> top
&& col
== 0);
4726 /* Make sure COL is not out of range. */
4727 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4729 /* If we have another row, advance cursor into it. */
4730 if (row
< FRAME_LINES (f
) - 1)
4732 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4735 /* Otherwise move it back in range. */
4737 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4741 cursor_to (f
, row
, col
);
4745 /* We have only one cursor on terminal frames. Use it to
4746 display the cursor of the selected window. */
4747 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4748 if (w
->cursor
.vpos
>= 0
4749 /* The cursor vpos may be temporarily out of bounds
4750 in the following situation: There is one window,
4751 with the cursor in the lower half of it. The window
4752 is split, and a message causes a redisplay before
4753 a new cursor position has been computed. */
4754 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4756 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4757 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4759 if (INTEGERP (w
->left_margin_cols
))
4760 x
+= XFASTINT (w
->left_margin_cols
);
4762 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4763 cursor_to (f
, y
, x
);
4768 #if !PERIODIC_PREEMPTION_CHECKING
4772 clear_desired_matrices (f
);
4777 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4780 scrolling (struct frame
*frame
)
4782 int unchanged_at_top
, unchanged_at_bottom
;
4785 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4786 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4787 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4788 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4790 int free_at_end_vpos
= FRAME_LINES (frame
);
4791 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4792 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4794 if (!current_matrix
)
4797 /* Compute hash codes of all the lines. Also calculate number of
4798 changed lines, number of unchanged lines at the beginning, and
4799 number of unchanged lines at the end. */
4801 unchanged_at_top
= 0;
4802 unchanged_at_bottom
= FRAME_LINES (frame
);
4803 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4805 /* Give up on this scrolling if some old lines are not enabled. */
4806 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4808 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4809 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4811 /* This line cannot be redrawn, so don't let scrolling mess it. */
4812 new_hash
[i
] = old_hash
[i
];
4813 #define INFINITY 1000000 /* Taken from scroll.c */
4814 draw_cost
[i
] = INFINITY
;
4818 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4819 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4822 if (old_hash
[i
] != new_hash
[i
])
4825 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4827 else if (i
== unchanged_at_top
)
4829 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4832 /* If changed lines are few, don't allow preemption, don't scroll. */
4833 if ((!FRAME_SCROLL_REGION_OK (frame
)
4834 && changed_lines
< baud_rate
/ 2400)
4835 || unchanged_at_bottom
== FRAME_LINES (frame
))
4838 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4839 - unchanged_at_bottom
);
4841 if (FRAME_SCROLL_REGION_OK (frame
))
4842 free_at_end_vpos
-= unchanged_at_bottom
;
4843 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4844 free_at_end_vpos
= -1;
4846 /* If large window, fast terminal and few lines in common between
4847 current frame and desired frame, don't bother with i/d calc. */
4848 if (!FRAME_SCROLL_REGION_OK (frame
)
4849 && window_size
>= 18 && baud_rate
> 2400
4851 10 * scrolling_max_lines_saved (unchanged_at_top
,
4852 FRAME_LINES (frame
) - unchanged_at_bottom
,
4853 old_hash
, new_hash
, draw_cost
)))
4856 if (window_size
< 2)
4859 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4860 draw_cost
+ unchanged_at_top
- 1,
4861 old_draw_cost
+ unchanged_at_top
- 1,
4862 old_hash
+ unchanged_at_top
- 1,
4863 new_hash
+ unchanged_at_top
- 1,
4864 free_at_end_vpos
- unchanged_at_top
);
4870 /* Count the number of blanks at the start of the vector of glyphs R
4871 which is LEN glyphs long. */
4874 count_blanks (struct glyph
*r
, int len
)
4878 for (i
= 0; i
< len
; ++i
)
4879 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4886 /* Count the number of glyphs in common at the start of the glyph
4887 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4888 of STR2. Value is the number of equal glyphs equal at the start. */
4891 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4893 struct glyph
*p1
= str1
;
4894 struct glyph
*p2
= str2
;
4898 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4905 /* Char insertion/deletion cost vector, from term.c */
4907 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
4910 /* Perform a frame-based update on line VPOS in frame FRAME. */
4913 update_frame_line (struct frame
*f
, int vpos
)
4915 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4917 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4918 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4919 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4920 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4921 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4922 int must_write_whole_line_p
;
4923 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4924 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4925 != FACE_TTY_DEFAULT_BG_COLOR
);
4927 if (colored_spaces_p
)
4930 /* Current row not enabled means it has unknown contents. We must
4931 write the whole desired line in that case. */
4932 must_write_whole_line_p
= !current_row
->enabled_p
;
4933 if (must_write_whole_line_p
)
4940 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4941 olen
= current_row
->used
[TEXT_AREA
];
4943 /* Ignore trailing spaces, if we can. */
4944 if (!write_spaces_p
)
4945 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4949 current_row
->enabled_p
= 1;
4950 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4952 /* If desired line is empty, just clear the line. */
4953 if (!desired_row
->enabled_p
)
4959 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4960 nlen
= desired_row
->used
[TEXT_AREA
];
4961 nend
= nbody
+ nlen
;
4963 /* If display line has unknown contents, write the whole line. */
4964 if (must_write_whole_line_p
)
4966 /* Ignore spaces at the end, if we can. */
4967 if (!write_spaces_p
)
4968 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4971 /* Write the contents of the desired line. */
4974 cursor_to (f
, vpos
, 0);
4975 write_glyphs (f
, nbody
, nlen
);
4978 /* Don't call clear_end_of_line if we already wrote the whole
4979 line. The cursor will not be at the right margin in that
4980 case but in the line below. */
4981 if (nlen
< FRAME_TOTAL_COLS (f
))
4983 cursor_to (f
, vpos
, nlen
);
4984 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4987 /* Make sure we are in the right row, otherwise cursor movement
4988 with cmgoto might use `ch' in the wrong row. */
4989 cursor_to (f
, vpos
, 0);
4991 make_current (desired_matrix
, current_matrix
, vpos
);
4995 /* Pretend trailing spaces are not there at all,
4996 unless for one reason or another we must write all spaces. */
4997 if (!write_spaces_p
)
4998 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5001 /* If there's no i/d char, quickly do the best we can without it. */
5002 if (!FRAME_CHAR_INS_DEL_OK (f
))
5006 /* Find the first glyph in desired row that doesn't agree with
5007 a glyph in the current row, and write the rest from there on. */
5008 for (i
= 0; i
< nlen
; i
++)
5010 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5012 /* Find the end of the run of different glyphs. */
5016 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5017 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5020 /* Output this run of non-matching chars. */
5021 cursor_to (f
, vpos
, i
);
5022 write_glyphs (f
, nbody
+ i
, j
- i
);
5025 /* Now find the next non-match. */
5029 /* Clear the rest of the line, or the non-clear part of it. */
5032 cursor_to (f
, vpos
, nlen
);
5033 clear_end_of_line (f
, olen
);
5036 /* Make current row = desired row. */
5037 make_current (desired_matrix
, current_matrix
, vpos
);
5041 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5042 characters in a row. */
5046 /* If current line is blank, skip over initial spaces, if
5047 possible, and write the rest. */
5051 nsp
= count_blanks (nbody
, nlen
);
5055 cursor_to (f
, vpos
, nsp
);
5056 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5059 /* Exchange contents between current_frame and new_frame. */
5060 make_current (desired_matrix
, current_matrix
, vpos
);
5064 /* Compute number of leading blanks in old and new contents. */
5065 osp
= count_blanks (obody
, olen
);
5066 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5068 /* Compute number of matching chars starting with first non-blank. */
5069 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5070 nbody
+ nsp
, nbody
+ nlen
);
5072 /* Spaces in new match implicit space past the end of old. */
5073 /* A bug causing this to be a no-op was fixed in 18.29. */
5074 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5077 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5081 /* Avoid doing insert/delete char
5082 just cause number of leading spaces differs
5083 when the following text does not match. */
5084 if (begmatch
== 0 && osp
!= nsp
)
5085 osp
= nsp
= min (osp
, nsp
);
5087 /* Find matching characters at end of line */
5090 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5092 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5097 endmatch
= obody
+ olen
- op1
;
5099 /* tem gets the distance to insert or delete.
5100 endmatch is how many characters we save by doing so.
5103 tem
= (nlen
- nsp
) - (olen
- osp
);
5105 && (!FRAME_CHAR_INS_DEL_OK (f
)
5106 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5109 /* nsp - osp is the distance to insert or delete.
5110 If that is nonzero, begmatch is known to be nonzero also.
5111 begmatch + endmatch is how much we save by doing the ins/del.
5115 && (!FRAME_CHAR_INS_DEL_OK (f
)
5116 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5120 osp
= nsp
= min (osp
, nsp
);
5123 /* Now go through the line, inserting, writing and
5124 deleting as appropriate. */
5128 cursor_to (f
, vpos
, nsp
);
5129 delete_glyphs (f
, osp
- nsp
);
5133 /* If going to delete chars later in line
5134 and insert earlier in the line,
5135 must delete first to avoid losing data in the insert */
5136 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5138 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5139 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5140 olen
= nlen
- (nsp
- osp
);
5142 cursor_to (f
, vpos
, osp
);
5143 insert_glyphs (f
, 0, nsp
- osp
);
5147 tem
= nsp
+ begmatch
+ endmatch
;
5148 if (nlen
!= tem
|| olen
!= tem
)
5150 if (!endmatch
|| nlen
== olen
)
5152 /* If new text being written reaches right margin, there is
5153 no need to do clear-to-eol at the end of this function
5154 (and it would not be safe, since cursor is not going to
5155 be "at the margin" after the text is done). */
5156 if (nlen
== FRAME_TOTAL_COLS (f
))
5159 /* Function write_glyphs is prepared to do nothing
5160 if passed a length <= 0. Check it here to avoid
5161 unnecessary cursor movement. */
5164 cursor_to (f
, vpos
, nsp
+ begmatch
);
5165 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5168 else if (nlen
> olen
)
5170 /* Here, we used to have the following simple code:
5171 ----------------------------------------
5172 write_glyphs (nbody + nsp + begmatch, olen - tem);
5173 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5174 ----------------------------------------
5175 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5176 is a padding glyph. */
5177 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5180 cursor_to (f
, vpos
, nsp
+ begmatch
);
5182 /* Calculate columns we can actually overwrite. */
5183 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5185 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5187 /* If we left columns to be overwritten, we must delete them. */
5188 del
= olen
- tem
- out
;
5190 delete_glyphs (f
, del
);
5192 /* At last, we insert columns not yet written out. */
5193 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5196 else if (olen
> nlen
)
5198 cursor_to (f
, vpos
, nsp
+ begmatch
);
5199 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5200 delete_glyphs (f
, olen
- nlen
);
5206 /* If any unerased characters remain after the new line, erase them. */
5209 cursor_to (f
, vpos
, nlen
);
5210 clear_end_of_line (f
, olen
);
5213 /* Exchange contents between current_frame and new_frame. */
5214 make_current (desired_matrix
, current_matrix
, vpos
);
5219 /***********************************************************************
5220 X/Y Position -> Buffer Position
5221 ***********************************************************************/
5223 /* Determine what's under window-relative pixel position (*X, *Y).
5224 Return the OBJECT (string or buffer) that's there.
5225 Return in *POS the position in that object.
5226 Adjust *X and *Y to character positions.
5227 Return in *DX and *DY the pixel coordinates of the click,
5228 relative to the top left corner of OBJECT, or relative to
5229 the top left corner of the character glyph at (*X, *Y)
5231 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5232 if the coordinates point to an empty area of the display. */
5235 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
)
5238 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5239 struct text_pos startp
;
5241 struct glyph_row
*row
;
5242 #ifdef HAVE_WINDOW_SYSTEM
5243 struct image
*img
= 0;
5246 void *itdata
= NULL
;
5248 /* We used to set current_buffer directly here, but that does the
5249 wrong thing with `face-remapping-alist' (bug#2044). */
5250 Fset_buffer (w
->buffer
);
5251 itdata
= bidi_shelve_cache ();
5252 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5253 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5254 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5255 start_display (&it
, w
, startp
);
5259 /* First, move to the beginning of the row corresponding to *Y. We
5260 need to be in that row to get the correct value of base paragraph
5261 direction for the text at (*X, *Y). */
5262 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5264 /* TO_X is the pixel position that the iterator will compute for the
5265 glyph at *X. We add it.first_visible_x because iterator
5266 positions include the hscroll. */
5267 to_x
= x0
+ it
.first_visible_x
;
5268 if (it
.bidi_it
.paragraph_dir
== R2L
)
5269 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5270 text area. This is because the iterator, even in R2L
5271 paragraphs, delivers glyphs as if they started at the left
5272 margin of the window. (When we actually produce glyphs for
5273 display, we reverse their order in PRODUCE_GLYPHS, but the
5274 iterator doesn't know about that.) The following line adjusts
5275 the pixel position to the iterator geometry, which is what
5276 move_it_* routines use. (The -1 is because in a window whose
5277 text-area width is W, the rightmost pixel position is W-1, and
5278 it should be mirrored into zero pixel position.) */
5279 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5281 /* Now move horizontally in the row to the glyph under *X. Second
5282 argument is ZV to prevent move_it_in_display_line from matching
5283 based on buffer positions. */
5284 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5285 bidi_unshelve_cache (itdata
);
5287 Fset_buffer (old_current_buffer
);
5289 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5290 *dy
= *y
- it
.current_y
;
5293 if (STRINGP (it
.string
))
5296 if (it
.what
== IT_COMPOSITION
5297 && it
.cmp_it
.nchars
> 1
5298 && it
.cmp_it
.reversed_p
)
5300 /* The current display element is a grapheme cluster in a
5301 composition. In that case, we need the position of the first
5302 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5303 it.current points to the last character of the cluster, thus
5304 we must move back to the first character of the same
5306 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5307 if (STRINGP (it
.string
))
5308 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5310 BYTEPOS (pos
->pos
) = CHAR_TO_BYTE (CHARPOS (pos
->pos
));
5313 #ifdef HAVE_WINDOW_SYSTEM
5314 if (it
.what
== IT_IMAGE
)
5316 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5317 && !NILP (img
->spec
))
5318 *object
= img
->spec
;
5322 if (it
.vpos
< w
->current_matrix
->nrows
5323 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5326 if (it
.hpos
< row
->used
[TEXT_AREA
])
5328 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5329 #ifdef HAVE_WINDOW_SYSTEM
5332 *dy
-= row
->ascent
- glyph
->ascent
;
5333 *dx
+= glyph
->slice
.img
.x
;
5334 *dy
+= glyph
->slice
.img
.y
;
5335 /* Image slices positions are still relative to the entire image */
5336 *width
= img
->width
;
5337 *height
= img
->height
;
5342 *width
= glyph
->pixel_width
;
5343 *height
= glyph
->ascent
+ glyph
->descent
;
5349 *height
= row
->height
;
5354 *width
= *height
= 0;
5357 /* Add extra (default width) columns if clicked after EOL. */
5358 x1
= max(0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5360 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5369 /* Value is the string under window-relative coordinates X/Y in the
5370 mode line or header line (PART says which) of window W, or nil if none.
5371 *CHARPOS is set to the position in the string returned. */
5374 mode_line_string (struct window
*w
, enum window_part part
,
5375 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5376 int *dx
, int *dy
, int *width
, int *height
)
5378 struct glyph_row
*row
;
5379 struct glyph
*glyph
, *end
;
5381 Lisp_Object string
= Qnil
;
5383 if (part
== ON_MODE_LINE
)
5384 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5386 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5388 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5390 if (row
->mode_line_p
&& row
->enabled_p
)
5392 /* Find the glyph under X. If we find one with a string object,
5393 it's the one we were looking for. */
5394 glyph
= row
->glyphs
[TEXT_AREA
];
5395 end
= glyph
+ row
->used
[TEXT_AREA
];
5396 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5397 x0
-= glyph
->pixel_width
;
5398 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5401 string
= glyph
->object
;
5402 *charpos
= glyph
->charpos
;
5403 *width
= glyph
->pixel_width
;
5404 *height
= glyph
->ascent
+ glyph
->descent
;
5405 #ifdef HAVE_WINDOW_SYSTEM
5406 if (glyph
->type
== IMAGE_GLYPH
)
5409 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5411 *object
= img
->spec
;
5412 y0
-= row
->ascent
- glyph
->ascent
;
5418 /* Add extra (default width) columns if clicked after EOL. */
5419 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5421 *height
= row
->height
;
5428 *width
= *height
= 0;
5438 /* Value is the string under window-relative coordinates X/Y in either
5439 marginal area, or nil if none. *CHARPOS is set to the position in
5440 the string returned. */
5443 marginal_area_string (struct window
*w
, enum window_part part
,
5444 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5445 int *dx
, int *dy
, int *width
, int *height
)
5447 struct glyph_row
*row
= w
->current_matrix
->rows
;
5448 struct glyph
*glyph
, *end
;
5449 int x0
, y0
, i
, wy
= *y
;
5451 Lisp_Object string
= Qnil
;
5453 if (part
== ON_LEFT_MARGIN
)
5454 area
= LEFT_MARGIN_AREA
;
5455 else if (part
== ON_RIGHT_MARGIN
)
5456 area
= RIGHT_MARGIN_AREA
;
5460 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5461 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5464 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5468 /* Find the glyph under X. If we find one with a string object,
5469 it's the one we were looking for. */
5470 if (area
== RIGHT_MARGIN_AREA
)
5471 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5472 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5473 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5474 + window_box_width (w
, LEFT_MARGIN_AREA
)
5475 + window_box_width (w
, TEXT_AREA
));
5477 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5478 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5481 glyph
= row
->glyphs
[area
];
5482 end
= glyph
+ row
->used
[area
];
5483 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5484 x0
-= glyph
->pixel_width
;
5485 *x
= glyph
- row
->glyphs
[area
];
5488 string
= glyph
->object
;
5489 *charpos
= glyph
->charpos
;
5490 *width
= glyph
->pixel_width
;
5491 *height
= glyph
->ascent
+ glyph
->descent
;
5492 #ifdef HAVE_WINDOW_SYSTEM
5493 if (glyph
->type
== IMAGE_GLYPH
)
5496 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5498 *object
= img
->spec
;
5499 y0
-= row
->ascent
- glyph
->ascent
;
5500 x0
+= glyph
->slice
.img
.x
;
5501 y0
+= glyph
->slice
.img
.y
;
5507 /* Add extra (default width) columns if clicked after EOL. */
5508 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5510 *height
= row
->height
;
5517 *width
= *height
= 0;
5527 /***********************************************************************
5528 Changing Frame Sizes
5529 ***********************************************************************/
5534 window_change_signal (int signalnum
) /* If we don't have an argument, */
5535 /* some compilers complain in signal calls. */
5538 int old_errno
= errno
;
5540 struct tty_display_info
*tty
;
5542 signal (SIGWINCH
, window_change_signal
);
5543 SIGNAL_THREAD_CHECK (signalnum
);
5545 /* The frame size change obviously applies to a single
5546 termcap-controlled terminal, but we can't decide which.
5547 Therefore, we resize the frames corresponding to each tty.
5549 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5551 if (! tty
->term_initted
)
5554 /* Suspended tty frames have tty->input == NULL avoid trying to
5559 get_tty_size (fileno (tty
->input
), &width
, &height
);
5561 if (width
> 5 && height
> 2) {
5562 Lisp_Object tail
, frame
;
5564 FOR_EACH_FRAME (tail
, frame
)
5565 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5566 /* Record the new sizes, but don't reallocate the data
5567 structures now. Let that be done later outside of the
5569 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5575 #endif /* SIGWINCH */
5578 /* Do any change in frame size that was requested by a signal. SAFE
5579 non-zero means this function is called from a place where it is
5580 safe to change frame sizes while a redisplay is in progress. */
5583 do_pending_window_change (int safe
)
5585 /* If window_change_signal should have run before, run it now. */
5586 if (redisplaying_p
&& !safe
)
5589 while (delayed_size_change
)
5591 Lisp_Object tail
, frame
;
5593 delayed_size_change
= 0;
5595 FOR_EACH_FRAME (tail
, frame
)
5597 struct frame
*f
= XFRAME (frame
);
5599 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5600 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5607 /* Change the frame height and/or width. Values may be given as zero to
5608 indicate no change is to take place.
5610 If DELAY is non-zero, then assume we're being called from a signal
5611 handler, and queue the change for later - perhaps the next
5612 redisplay. Since this tries to resize windows, we can't call it
5613 from a signal handler.
5615 SAFE non-zero means this function is called from a place where it's
5616 safe to change frame sizes while a redisplay is in progress. */
5619 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5621 Lisp_Object tail
, frame
;
5623 if (FRAME_MSDOS_P (f
))
5625 /* On MS-DOS, all frames use the same screen, so a change in
5626 size affects all frames. Termcap now supports multiple
5628 FOR_EACH_FRAME (tail
, frame
)
5629 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5630 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5631 pretend
, delay
, safe
);
5634 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5638 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5640 int new_frame_total_cols
;
5641 int count
= SPECPDL_INDEX ();
5643 /* If we can't deal with the change now, queue it for later. */
5644 if (delay
|| (redisplaying_p
&& !safe
))
5646 f
->new_text_lines
= newheight
;
5647 f
->new_text_cols
= newwidth
;
5648 delayed_size_change
= 1;
5652 /* This size-change overrides any pending one for this frame. */
5653 f
->new_text_lines
= 0;
5654 f
->new_text_cols
= 0;
5656 /* If an argument is zero, set it to the current value. */
5658 newheight
= FRAME_LINES (f
);
5660 newwidth
= FRAME_COLS (f
);
5662 /* Compute width of windows in F.
5663 This is the width of the frame without vertical scroll bars. */
5664 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5666 /* Round up to the smallest acceptable size. */
5667 check_frame_size (f
, &newheight
, &newwidth
);
5669 /* If we're not changing the frame size, quit now. */
5670 /* Frame width may be unchanged but the text portion may change, for example,
5671 fullscreen and remove/add scroll bar. */
5672 if (newheight
== FRAME_LINES (f
)
5673 && newwidth
== FRAME_COLS (f
) // text portion unchanged
5674 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
)) // frame width unchanged
5680 /* We only can set screen dimensions to certain values supported
5681 by our video hardware. Try to find the smallest size greater
5682 or equal to the requested dimensions. */
5683 dos_set_window_size (&newheight
, &newwidth
);
5686 if (newheight
!= FRAME_LINES (f
))
5688 resize_frame_windows (f
, newheight
, 0);
5690 /* MSDOS frames cannot PRETEND, as they change frame size by
5691 manipulating video hardware. */
5692 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5693 FrameRows (FRAME_TTY (f
)) = newheight
;
5696 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5698 resize_frame_windows (f
, new_frame_total_cols
, 1);
5700 /* MSDOS frames cannot PRETEND, as they change frame size by
5701 manipulating video hardware. */
5702 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5703 FrameCols (FRAME_TTY (f
)) = newwidth
;
5705 if (WINDOWP (f
->tool_bar_window
))
5706 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5709 FRAME_LINES (f
) = newheight
;
5710 SET_FRAME_COLS (f
, newwidth
);
5713 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5714 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5716 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5718 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5719 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5720 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5721 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5725 calculate_costs (f
);
5726 SET_FRAME_GARBAGED (f
);
5731 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5733 run_window_configuration_change_hook (f
);
5735 unbind_to (count
, Qnil
);
5740 /***********************************************************************
5741 Terminal Related Lisp Functions
5742 ***********************************************************************/
5744 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5745 1, 1, "FOpen termscript file: ",
5746 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5747 FILE = nil means just close any termscript file currently open. */)
5750 struct tty_display_info
*tty
;
5752 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5753 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5754 error ("Current frame is not on a tty device");
5758 if (tty
->termscript
!= 0)
5761 fclose (tty
->termscript
);
5764 tty
->termscript
= 0;
5768 file
= Fexpand_file_name (file
, Qnil
);
5769 tty
->termscript
= fopen (SSDATA (file
), "w");
5770 if (tty
->termscript
== 0)
5771 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5777 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5778 Ssend_string_to_terminal
, 1, 2, 0,
5779 doc
: /* Send STRING to the terminal without alteration.
5780 Control characters in STRING will have terminal-dependent effects.
5782 Optional parameter TERMINAL specifies the tty terminal device to use.
5783 It may be a terminal object, a frame, or nil for the terminal used by
5784 the currently selected frame. In batch mode, STRING is sent to stdout
5785 when TERMINAL is nil. */)
5786 (Lisp_Object string
, Lisp_Object terminal
)
5788 struct terminal
*t
= get_terminal (terminal
, 1);
5791 /* ??? Perhaps we should do something special for multibyte strings here. */
5792 CHECK_STRING (string
);
5796 error ("Unknown terminal device");
5798 if (t
->type
== output_initial
)
5800 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5801 error ("Device %d is not a termcap terminal device", t
->id
);
5804 struct tty_display_info
*tty
= t
->display_info
.tty
;
5807 error ("Terminal is currently suspended");
5809 if (tty
->termscript
)
5811 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5812 fflush (tty
->termscript
);
5816 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5823 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5824 doc
: /* Beep, or flash the screen.
5825 Also, unless an argument is given,
5826 terminate any keyboard macro currently executing. */)
5834 ring_bell (XFRAME (selected_frame
));
5843 bitch_at_user (void)
5847 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5848 error ("Keyboard macro terminated by a command ringing the bell");
5850 ring_bell (XFRAME (selected_frame
));
5855 /***********************************************************************
5857 ***********************************************************************/
5859 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5860 doc
: /* Pause, without updating display, for SECONDS seconds.
5861 SECONDS may be a floating-point value, meaning that you can wait for a
5862 fraction of a second. Optional second arg MILLISECONDS specifies an
5863 additional wait period, in milliseconds; this may be useful if your
5864 Emacs was built without floating point support.
5865 \(Not all operating systems support waiting for a fraction of a second.) */)
5866 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5870 if (NILP (milliseconds
))
5871 XSETINT (milliseconds
, 0);
5873 CHECK_NUMBER (milliseconds
);
5874 usec
= XINT (milliseconds
) * 1000;
5877 double duration
= extract_float (seconds
);
5878 sec
= (int) duration
;
5879 usec
+= (duration
- sec
) * 1000000;
5882 #ifndef EMACS_HAS_USECS
5883 if (sec
== 0 && usec
!= 0)
5884 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
5887 /* Assure that 0 <= usec < 1000000. */
5890 /* We can't rely on the rounding being correct if usec is negative. */
5891 if (-1000000 < usec
)
5892 sec
--, usec
+= 1000000;
5894 sec
-= -usec
/ 1000000, usec
= 1000000 - (-usec
% 1000000);
5897 sec
+= usec
/ 1000000, usec
%= 1000000;
5899 if (sec
< 0 || (sec
== 0 && usec
== 0))
5902 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
5908 /* This is just like wait_reading_process_output, except that
5911 TIMEOUT is number of seconds to wait (float or integer),
5912 or t to wait forever.
5913 READING is 1 if reading input.
5914 If DO_DISPLAY is >0 display process output while waiting.
5915 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5919 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5923 swallow_events (do_display
);
5925 if ((detect_input_pending_run_timers (do_display
))
5926 || !NILP (Vexecuting_kbd_macro
))
5929 if (do_display
>= 2)
5930 redisplay_preserve_echo_area (2);
5932 if (INTEGERP (timeout
))
5934 sec
= XINT (timeout
);
5937 else if (FLOATP (timeout
))
5939 double seconds
= XFLOAT_DATA (timeout
);
5940 sec
= (int) seconds
;
5941 usec
= (int) ((seconds
- sec
) * 1000000);
5943 else if (EQ (timeout
, Qt
))
5949 wrong_type_argument (Qnumberp
, timeout
);
5951 if (sec
== 0 && usec
== 0 && !EQ (timeout
, Qt
))
5958 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
5961 return detect_input_pending () ? Qnil
: Qt
;
5965 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5966 doc
: /* Perform redisplay if no input is available.
5967 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
5968 perform a full redisplay even if input is available.
5969 Return t if redisplay was performed, nil otherwise. */)
5975 if ((detect_input_pending_run_timers (1)
5976 && NILP (force
) && !redisplay_dont_pause
)
5977 || !NILP (Vexecuting_kbd_macro
))
5980 count
= SPECPDL_INDEX ();
5981 if (!NILP (force
) && !redisplay_dont_pause
)
5982 specbind (Qredisplay_dont_pause
, Qt
);
5983 redisplay_preserve_echo_area (2);
5984 unbind_to (count
, Qnil
);
5990 /***********************************************************************
5991 Other Lisp Functions
5992 ***********************************************************************/
5994 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5995 session's frames, frame names, buffers, buffer-read-only flags, and
5996 buffer-modified-flags. */
5998 static Lisp_Object frame_and_buffer_state
;
6001 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6002 Sframe_or_buffer_changed_p
, 0, 1, 0,
6003 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6004 VARIABLE is a variable name whose value is either nil or a state vector
6005 that will be updated to contain all frames and buffers,
6006 aside from buffers whose names start with space,
6007 along with the buffers' read-only and modified flags. This allows a fast
6008 check to see whether buffer menus might need to be recomputed.
6009 If this function returns non-nil, it updates the internal vector to reflect
6012 If VARIABLE is nil, an internal variable is used. Users should not
6013 pass nil for VARIABLE. */)
6014 (Lisp_Object variable
)
6016 Lisp_Object state
, tail
, frame
, buf
;
6017 Lisp_Object
*vecp
, *end
;
6020 if (! NILP (variable
))
6022 CHECK_SYMBOL (variable
);
6023 state
= Fsymbol_value (variable
);
6024 if (! VECTORP (state
))
6028 state
= frame_and_buffer_state
;
6030 vecp
= XVECTOR (state
)->contents
;
6031 end
= vecp
+ ASIZE (state
);
6033 FOR_EACH_FRAME (tail
, frame
)
6037 if (!EQ (*vecp
++, frame
))
6041 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6044 /* Check that the buffer info matches. */
6045 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6047 buf
= XCDR (XCAR (tail
));
6048 /* Ignore buffers that aren't included in buffer lists. */
6049 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6053 if (!EQ (*vecp
++, buf
))
6057 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6061 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6066 /* Detect deletion of a buffer at the end of the list. */
6067 if (EQ (*vecp
, Qlambda
))
6070 /* Come here if we decide the data has changed. */
6072 /* Count the size we will need.
6073 Start with 1 so there is room for at least one lambda at the end. */
6075 FOR_EACH_FRAME (tail
, frame
)
6077 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6079 /* Reallocate the vector if data has grown to need it,
6080 or if it has shrunk a lot. */
6081 if (! VECTORP (state
)
6082 || n
> ASIZE (state
)
6083 || n
+ 20 < ASIZE (state
) / 2)
6084 /* Add 20 extra so we grow it less often. */
6086 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6087 if (! NILP (variable
))
6088 Fset (variable
, state
);
6090 frame_and_buffer_state
= state
;
6093 /* Record the new data in the (possibly reallocated) vector. */
6094 vecp
= XVECTOR (state
)->contents
;
6095 FOR_EACH_FRAME (tail
, frame
)
6098 *vecp
++ = XFRAME (frame
)->name
;
6100 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6102 buf
= XCDR (XCAR (tail
));
6103 /* Ignore buffers that aren't included in buffer lists. */
6104 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6107 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6108 *vecp
++ = Fbuffer_modified_p (buf
);
6110 /* Fill up the vector with lambdas (always at least one). */
6112 while (vecp
- XVECTOR (state
)->contents
6115 /* Make sure we didn't overflow the vector. */
6116 if (vecp
- XVECTOR (state
)->contents
6124 /***********************************************************************
6126 ***********************************************************************/
6128 /* Initialization done when Emacs fork is started, before doing stty.
6129 Determine terminal type and set terminal_driver. Then invoke its
6130 decoding routine to set up variables in the terminal package. */
6135 char *terminal_type
;
6137 /* Construct the space glyph. */
6138 space_glyph
.type
= CHAR_GLYPH
;
6139 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6140 space_glyph
.charpos
= -1;
6143 cursor_in_echo_area
= 0;
6144 terminal_type
= (char *) 0;
6146 /* Now is the time to initialize this; it's used by init_sys_modes
6148 Vinitial_window_system
= Qnil
;
6150 /* SIGWINCH needs to be handled no matter what display we start
6151 with. Otherwise newly opened tty frames will not resize
6156 #endif /* CANNOT_DUMP */
6157 signal (SIGWINCH
, window_change_signal
);
6158 #endif /* SIGWINCH */
6160 /* If running as a daemon, no need to initialize any frames/terminal. */
6164 /* If the user wants to use a window system, we shouldn't bother
6165 initializing the terminal. This is especially important when the
6166 terminal is so dumb that emacs gives up before and doesn't bother
6167 using the window system.
6169 If the DISPLAY environment variable is set and nonempty,
6170 try to use X, and die with an error message if that doesn't work. */
6172 #ifdef HAVE_X_WINDOWS
6173 if (! inhibit_window_system
&& ! display_arg
)
6176 display
= getenv ("DISPLAY");
6177 display_arg
= (display
!= 0 && *display
!= 0);
6179 if (display_arg
&& !x_display_ok (display
))
6181 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6183 inhibit_window_system
= 1;
6187 if (!inhibit_window_system
&& display_arg
)
6189 Vinitial_window_system
= Qx
;
6191 Vwindow_system_version
= make_number (11);
6193 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6194 /* In some versions of ncurses,
6195 tputs crashes if we have not called tgetent.
6197 { char b
[2044]; tgetent (b
, "xterm");}
6199 adjust_frame_glyphs_initially ();
6202 #endif /* HAVE_X_WINDOWS */
6205 if (!inhibit_window_system
)
6207 Vinitial_window_system
= Qw32
;
6208 Vwindow_system_version
= make_number (1);
6209 adjust_frame_glyphs_initially ();
6212 #endif /* HAVE_NTGUI */
6215 if (!inhibit_window_system
6221 Vinitial_window_system
= Qns
;
6222 Vwindow_system_version
= make_number(10);
6223 adjust_frame_glyphs_initially ();
6228 /* If no window system has been specified, try to use the terminal. */
6231 fatal ("standard input is not a tty");
6236 terminal_type
= "w32console";
6238 /* Look at the TERM variable. */
6239 terminal_type
= (char *) getenv ("TERM");
6243 #ifdef HAVE_WINDOW_SYSTEM
6244 if (! inhibit_window_system
)
6245 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6247 #endif /* HAVE_WINDOW_SYSTEM */
6248 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6254 struct frame
*f
= XFRAME (selected_frame
);
6256 /* Open a display on the controlling tty. */
6257 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6259 /* Convert the initial frame to use the new display. */
6260 if (f
->output_method
!= output_initial
)
6262 f
->output_method
= t
->type
;
6265 t
->reference_count
++;
6267 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6269 if (f
->output_method
== output_termcap
)
6270 create_tty_output (f
);
6272 t
->display_info
.tty
->top_frame
= selected_frame
;
6273 change_frame_size (XFRAME (selected_frame
),
6274 FrameRows (t
->display_info
.tty
),
6275 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6277 /* Delete the initial terminal. */
6278 if (--initial_terminal
->reference_count
== 0
6279 && initial_terminal
->delete_terminal_hook
)
6280 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6282 /* Update frame parameters to reflect the new type. */
6283 Fmodify_frame_parameters
6284 (selected_frame
, Fcons (Fcons (Qtty_type
,
6285 Ftty_type (selected_frame
)), Qnil
));
6286 if (t
->display_info
.tty
->name
)
6287 Fmodify_frame_parameters (selected_frame
,
6288 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6291 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6296 struct frame
*sf
= SELECTED_FRAME ();
6297 int width
= FRAME_TOTAL_COLS (sf
);
6298 int height
= FRAME_LINES (sf
);
6300 /* If these sizes are so big they cause overflow, just ignore the
6301 change. It's not clear what better we could do. The rest of
6302 the code assumes that (width + 2) * height * sizeof (struct glyph)
6303 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6304 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6305 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6306 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6307 < (width
+ 2) * height
))
6308 fatal ("screen size %dx%d too big", width
, height
);
6311 adjust_frame_glyphs_initially ();
6312 calculate_costs (XFRAME (selected_frame
));
6314 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6317 && NILP (Vinitial_window_system
))
6319 /* For the initial frame, we don't have any way of knowing what
6320 are the foreground and background colors of the terminal. */
6321 struct frame
*sf
= SELECTED_FRAME();
6323 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6324 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6325 call0 (intern ("tty-set-up-initial-frame-faces"));
6331 /***********************************************************************
6333 ***********************************************************************/
6335 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6336 Sinternal_show_cursor
, 2, 2, 0,
6337 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6338 WINDOW nil means use the selected window. SHOW non-nil means
6339 show a cursor in WINDOW in the next redisplay. SHOW nil means
6340 don't show a cursor. */)
6341 (Lisp_Object window
, Lisp_Object show
)
6343 /* Don't change cursor state while redisplaying. This could confuse
6345 if (!redisplaying_p
)
6348 window
= selected_window
;
6350 CHECK_WINDOW (window
);
6352 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6359 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6360 Sinternal_show_cursor_p
, 0, 1, 0,
6361 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6362 WINDOW nil or omitted means report on the selected window. */)
6363 (Lisp_Object window
)
6368 window
= selected_window
;
6370 CHECK_WINDOW (window
);
6372 w
= XWINDOW (window
);
6373 return w
->cursor_off_p
? Qnil
: Qt
;
6376 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6377 Slast_nonminibuf_frame
, 0, 0, 0,
6378 doc
: /* Value is last nonminibuffer frame. */)
6381 Lisp_Object frame
= Qnil
;
6383 if (last_nonminibuf_frame
)
6384 XSETFRAME (frame
, last_nonminibuf_frame
);
6389 /***********************************************************************
6391 ***********************************************************************/
6394 syms_of_display (void)
6396 defsubr (&Sredraw_frame
);
6397 defsubr (&Sredraw_display
);
6398 defsubr (&Sframe_or_buffer_changed_p
);
6399 defsubr (&Sopen_termscript
);
6401 defsubr (&Sredisplay
);
6402 defsubr (&Ssleep_for
);
6403 defsubr (&Ssend_string_to_terminal
);
6404 defsubr (&Sinternal_show_cursor
);
6405 defsubr (&Sinternal_show_cursor_p
);
6406 defsubr (&Slast_nonminibuf_frame
);
6409 defsubr (&Sdump_redisplay_history
);
6412 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6413 staticpro (&frame_and_buffer_state
);
6415 DEFSYM (Qdisplay_table
, "display-table");
6416 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6418 DEFVAR_INT ("baud-rate", baud_rate
,
6419 doc
: /* *The output baud rate of the terminal.
6420 On most systems, changing this value will affect the amount of padding
6421 and the other strategic decisions made during redisplay. */);
6423 DEFVAR_BOOL ("inverse-video", inverse_video
,
6424 doc
: /* *Non-nil means invert the entire frame display.
6425 This means everything is in inverse video which otherwise would not be. */);
6427 DEFVAR_BOOL ("visible-bell", visible_bell
,
6428 doc
: /* *Non-nil means try to flash the frame to represent a bell.
6430 See also `ring-bell-function'. */);
6432 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6433 doc
: /* *Non-nil means no need to redraw entire frame after suspending.
6434 A non-nil value is useful if the terminal can automatically preserve
6435 Emacs's frame display when you reenter Emacs.
6436 It is up to you to set this variable if your terminal can do that. */);
6438 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6439 doc
: /* Name of the window system that Emacs uses for the first frame.
6440 The value is a symbol:
6441 nil for a termcap frame (a character-only terminal),
6442 'x' for an Emacs frame that is really an X window,
6443 'w32' for an Emacs frame that is a window on MS-Windows display,
6444 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6445 'pc' for a direct-write MS-DOS frame.
6447 Use of this variable as a boolean is deprecated. Instead,
6448 use `display-graphic-p' or any of the other `display-*-p'
6449 predicates which report frame's specific UI-related capabilities. */);
6451 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6452 doc
: /* Name of window system through which the selected frame is displayed.
6453 The value is a symbol:
6454 nil for a termcap frame (a character-only terminal),
6455 'x' for an Emacs frame that is really an X window,
6456 'w32' for an Emacs frame that is a window on MS-Windows display,
6457 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6458 'pc' for a direct-write MS-DOS frame.
6460 Use of this variable as a boolean is deprecated. Instead,
6461 use `display-graphic-p' or any of the other `display-*-p'
6462 predicates which report frame's specific UI-related capabilities. */);
6464 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6465 doc
: /* The version number of the window system in use.
6466 For X windows, this is 11. */);
6468 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6469 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6471 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6472 doc
: /* Table defining how to output a glyph code to the frame.
6473 If not nil, this is a vector indexed by glyph code to define the glyph.
6474 Each element can be:
6475 integer: a glyph code which this glyph is an alias for.
6476 string: output this glyph using that string (not impl. in X windows).
6477 nil: this glyph mod 524288 is the code of a character to output,
6478 and this glyph / 524288 is the face number (see `face-id') to use
6479 while outputting it. */);
6480 Vglyph_table
= Qnil
;
6482 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6483 doc
: /* Display table to use for buffers that specify none.
6484 See `buffer-display-table' for more information. */);
6485 Vstandard_display_table
= Qnil
;
6487 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6488 doc
: /* *Non-nil means update isn't paused when input is detected. */);
6489 redisplay_dont_pause
= 0;
6491 #if PERIODIC_PREEMPTION_CHECKING
6492 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6493 doc
: /* *The period in seconds between checking for input during redisplay.
6494 If input is detected, redisplay is pre-empted, and the input is processed.
6495 If nil, never pre-empt redisplay. */);
6496 Vredisplay_preemption_period
= make_float (0.10);
6503 Vinitial_window_system
= Qnil
;
6504 Vwindow_system_version
= Qnil
;