1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 /* cm.h must come after dispextern.h on Windows. */
30 #include "dispextern.h"
33 #include "character.h"
36 #include "termhooks.h"
41 #include "intervals.h"
42 #include "blockinput.h"
45 #include "syssignal.h"
49 #endif /* HAVE_X_WINDOWS */
53 #endif /* HAVE_NTGUI */
59 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
64 /* Get number of chars of output now in the buffer of a stdio stream.
65 This ought to be built in in stdio, but it isn't. Some s- files
66 override this because their stdio internals differ. */
68 #ifdef __GNU_LIBRARY__
70 /* The s- file might have overridden the definition with one that
71 works for the system's C library. But we are using the GNU C
72 library, so this is the right definition for every system. */
74 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
75 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
77 #undef PENDING_OUTPUT_COUNT
78 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
80 #else /* not __GNU_LIBRARY__ */
81 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
82 #include <stdio_ext.h>
83 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
85 #ifndef PENDING_OUTPUT_COUNT
86 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
88 #endif /* not __GNU_LIBRARY__ */
90 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
91 #include <term.h> /* for tgetent */
94 /* Structure to pass dimensions around. Used for character bounding
95 boxes, glyph matrix dimensions and alike. */
104 /* Function prototypes. */
106 static struct glyph_matrix
*save_current_matrix (struct frame
*);
107 static void restore_current_matrix (struct frame
*, struct glyph_matrix
*);
108 static int showing_window_margins_p (struct window
*);
109 static void fake_current_matrices (Lisp_Object
);
110 static void redraw_overlapping_rows (struct window
*, int);
111 static void redraw_overlapped_rows (struct window
*, int);
112 static int count_blanks (struct glyph
*, int);
113 static int count_match (struct glyph
*, struct glyph
*,
114 struct glyph
*, struct glyph
*);
115 static unsigned line_draw_cost (struct glyph_matrix
*, int);
116 static void update_frame_line (struct frame
*, int);
117 static struct dim allocate_matrices_for_frame_redisplay
118 (Lisp_Object
, int, int, int, int *);
119 static int required_matrix_height (struct window
*);
120 static int required_matrix_width (struct window
*);
121 static void allocate_matrices_for_window_redisplay (struct window
*);
122 static int realloc_glyph_pool (struct glyph_pool
*, struct dim
);
123 static void adjust_frame_glyphs (struct frame
*);
124 struct glyph_matrix
*new_glyph_matrix (struct glyph_pool
*);
125 static void free_glyph_matrix (struct glyph_matrix
*);
126 static void adjust_glyph_matrix (struct window
*, struct glyph_matrix
*,
127 int, int, struct dim
);
128 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
129 static void swap_glyph_pointers (struct glyph_row
*, struct glyph_row
*);
131 static int glyph_row_slice_p (struct glyph_row
*, struct glyph_row
*);
133 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
134 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
136 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
138 static struct glyph_pool
*new_glyph_pool (void);
139 static void free_glyph_pool (struct glyph_pool
*);
140 static void adjust_frame_glyphs_initially (void);
141 static void adjust_frame_message_buffer (struct frame
*);
142 static void adjust_decode_mode_spec_buffer (struct frame
*);
143 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
144 static void build_frame_matrix (struct frame
*);
145 void clear_current_matrices (struct frame
*);
146 void scroll_glyph_matrix_range (struct glyph_matrix
*, int, int,
148 static void clear_window_matrices (struct window
*, int);
149 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
150 static int scrolling_window (struct window
*, int);
151 static int update_window_line (struct window
*, int, int *);
152 static void update_marginal_area (struct window
*, int, int);
153 static int update_text_area (struct window
*, int);
154 static void make_current (struct glyph_matrix
*, struct glyph_matrix
*,
156 static void mirror_make_current (struct window
*, int);
157 void check_window_matrix_pointers (struct window
*);
159 static void check_matrix_pointers (struct glyph_matrix
*,
160 struct glyph_matrix
*);
162 static void mirror_line_dance (struct window
*, int, int, int *, char *);
163 static int update_window_tree (struct window
*, int);
164 static int update_window (struct window
*, int);
165 static int update_frame_1 (struct frame
*, int, int);
166 static void set_window_cursor_after_update (struct window
*);
167 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
168 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
171 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
172 are supported, so we can check for input during redisplay at
173 regular intervals. */
174 #ifdef EMACS_HAS_USECS
175 #define PERIODIC_PREEMPTION_CHECKING 1
177 #define PERIODIC_PREEMPTION_CHECKING 0
180 #if PERIODIC_PREEMPTION_CHECKING
182 /* Redisplay preemption timers. */
184 static EMACS_TIME preemption_period
;
185 static EMACS_TIME preemption_next_check
;
189 /* Nonzero upon entry to redisplay means do not assume anything about
190 current contents of actual terminal frame; clear and redraw it. */
194 /* Nonzero means last display completed. Zero means it was preempted. */
196 int display_completed
;
198 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
201 /* The currently selected frame. In a single-frame version, this
202 variable always equals the_only_frame. */
204 Lisp_Object selected_frame
;
206 /* A frame which is not just a mini-buffer, or 0 if there are no such
207 frames. This is usually the most recent such frame that was
208 selected. In a single-frame version, this variable always holds
209 the address of the_only_frame. */
211 struct frame
*last_nonminibuf_frame
;
213 /* 1 means SIGWINCH happened when not safe. */
215 int delayed_size_change
;
217 /* 1 means glyph initialization has been completed at startup. */
219 static int glyphs_initialized_initially_p
;
221 /* Updated window if != 0. Set by update_window. */
223 struct window
*updated_window
;
225 /* Glyph row updated in update_window_line, and area that is updated. */
227 struct glyph_row
*updated_row
;
230 /* A glyph for a space. */
232 struct glyph space_glyph
;
234 /* Counts of allocated structures. These counts serve to diagnose
235 memory leaks and double frees. */
237 int glyph_matrix_count
;
238 int glyph_pool_count
;
240 /* If non-null, the frame whose frame matrices are manipulated. If
241 null, window matrices are worked on. */
243 static struct frame
*frame_matrix_frame
;
245 /* Non-zero means that fonts have been loaded since the last glyph
246 matrix adjustments. Redisplay must stop, and glyph matrices must
247 be adjusted when this flag becomes non-zero during display. The
248 reason fonts can be loaded so late is that fonts of fontsets are
249 loaded on demand. Another reason is that a line contains many
250 characters displayed by zero width or very narrow glyphs of
251 variable-width fonts. */
255 /* Convert vpos and hpos from frame to window and vice versa.
256 This may only be used for terminal frames. */
260 static int window_to_frame_vpos (struct window
*, int);
261 static int window_to_frame_hpos (struct window
*, int);
262 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
263 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
265 /* One element of the ring buffer containing redisplay history
268 struct redisplay_history
270 char trace
[512 + 100];
273 /* The size of the history buffer. */
275 #define REDISPLAY_HISTORY_SIZE 30
277 /* The redisplay history buffer. */
279 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
281 /* Next free entry in redisplay_history. */
283 static int history_idx
;
285 /* A tick that's incremented each time something is added to the
288 static unsigned history_tick
;
290 static void add_frame_display_history (struct frame
*, int);
291 static void add_window_display_history (struct window
*, char *, int);
293 /* Add to the redisplay history how window W has been displayed.
294 MSG is a trace containing the information how W's glyph matrix
295 has been constructed. PAUSED_P non-zero means that the update
296 has been interrupted for pending input. */
299 add_window_display_history (struct window
*w
, char *msg
, int paused_p
)
303 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
305 buf
= redisplay_history
[history_idx
].trace
;
308 sprintf (buf
, "%d: window %p (`%s')%s\n",
311 ((BUFFERP (w
->buffer
)
312 && STRINGP (XBUFFER (w
->buffer
)->name
))
313 ? SSDATA (XBUFFER (w
->buffer
)->name
)
315 paused_p
? " ***paused***" : "");
320 /* Add to the redisplay history that frame F has been displayed.
321 PAUSED_P non-zero means that the update has been interrupted for
325 add_frame_display_history (struct frame
*f
, int paused_p
)
329 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
331 buf
= redisplay_history
[history_idx
].trace
;
334 sprintf (buf
, "%d: update frame %p%s",
336 f
, paused_p
? " ***paused***" : "");
340 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
341 Sdump_redisplay_history
, 0, 0, "",
342 doc
: /* Dump redisplay history to stderr. */)
347 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
350 i
= REDISPLAY_HISTORY_SIZE
- 1;
351 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
358 #else /* GLYPH_DEBUG == 0 */
360 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
361 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
363 #endif /* GLYPH_DEBUG == 0 */
366 #if defined PROFILING && !HAVE___EXECUTABLE_START
367 /* FIXME: only used to find text start for profiling. */
370 safe_bcopy (const char *from
, char *to
, int size
)
376 /***********************************************************************
378 ***********************************************************************/
380 /* Allocate and return a glyph_matrix structure. POOL is the glyph
381 pool from which memory for the matrix should be allocated, or null
382 for window-based redisplay where no glyph pools are used. The
383 member `pool' of the glyph matrix structure returned is set to
384 POOL, the structure is otherwise zeroed. */
386 struct glyph_matrix
*
387 new_glyph_matrix (struct glyph_pool
*pool
)
389 struct glyph_matrix
*result
;
391 /* Allocate and clear. */
392 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
393 memset (result
, 0, sizeof *result
);
395 /* Increment number of allocated matrices. This count is used
396 to detect memory leaks. */
397 ++glyph_matrix_count
;
399 /* Set pool and return. */
405 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
407 The global counter glyph_matrix_count is decremented when a matrix
408 is freed. If the count gets negative, more structures were freed
409 than allocated, i.e. one matrix was freed more than once or a bogus
410 pointer was passed to this function.
412 If MATRIX->pool is null, this means that the matrix manages its own
413 glyph memory---this is done for matrices on X frames. Freeing the
414 matrix also frees the glyph memory in this case. */
417 free_glyph_matrix (struct glyph_matrix
*matrix
)
423 /* Detect the case that more matrices are freed than were
425 if (--glyph_matrix_count
< 0)
428 /* Free glyph memory if MATRIX owns it. */
429 if (matrix
->pool
== NULL
)
430 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
431 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
433 /* Free row structures and the matrix itself. */
434 xfree (matrix
->rows
);
440 /* Return the number of glyphs to reserve for a marginal area of
441 window W. TOTAL_GLYPHS is the number of glyphs in a complete
442 display line of window W. MARGIN gives the width of the marginal
443 area in canonical character units. MARGIN should be an integer
447 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
451 if (NUMBERP (margin
))
453 int width
= XFASTINT (w
->total_cols
);
454 double d
= max (0, XFLOATINT (margin
));
455 d
= min (width
/ 2 - 1, d
);
456 n
= (int) ((double) total_glyphs
/ width
* d
);
465 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
468 W is null if the function is called for a frame glyph matrix.
469 Otherwise it is the window MATRIX is a member of. X and Y are the
470 indices of the first column and row of MATRIX within the frame
471 matrix, if such a matrix exists. They are zero for purely
472 window-based redisplay. DIM is the needed size of the matrix.
474 In window-based redisplay, where no frame matrices exist, glyph
475 matrices manage their own glyph storage. Otherwise, they allocate
476 storage from a common frame glyph pool which can be found in
479 The reason for this memory management strategy is to avoid complete
480 frame redraws if possible. When we allocate from a common pool, a
481 change of the location or size of a sub-matrix within the pool
482 requires a complete redisplay of the frame because we cannot easily
483 make sure that the current matrices of all windows still agree with
484 what is displayed on the screen. While this is usually fast, it
485 leads to screen flickering. */
488 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
492 int marginal_areas_changed_p
= 0;
493 int header_line_changed_p
= 0;
494 int header_line_p
= 0;
495 int left
= -1, right
= -1;
496 int window_width
= -1, window_height
= -1;
498 /* See if W had a header line that has disappeared now, or vice versa.
502 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
504 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
505 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
507 matrix
->header_line_p
= header_line_p
;
509 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
510 Do nothing if MATRIX' size, position, vscroll, and marginal areas
511 haven't changed. This optimization is important because preserving
512 the matrix means preventing redisplay. */
513 if (matrix
->pool
== NULL
)
515 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
516 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
517 xassert (left
>= 0 && right
>= 0);
518 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
519 || right
!= matrix
->right_margin_glyphs
);
521 if (!marginal_areas_changed_p
523 && !header_line_changed_p
524 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
525 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
526 && matrix
->window_height
== window_height
527 && matrix
->window_vscroll
== w
->vscroll
528 && matrix
->window_width
== window_width
)
532 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
533 if (matrix
->rows_allocated
< dim
.height
)
535 int size
= dim
.height
* sizeof (struct glyph_row
);
536 new_rows
= dim
.height
- matrix
->rows_allocated
;
537 matrix
->rows
= (struct glyph_row
*) xrealloc (matrix
->rows
, size
);
538 memset (matrix
->rows
+ matrix
->rows_allocated
, 0,
539 new_rows
* sizeof *matrix
->rows
);
540 matrix
->rows_allocated
= dim
.height
;
545 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
546 on a frame not using window-based redisplay. Set up pointers for
547 each row into the glyph pool. */
550 xassert (matrix
->pool
->glyphs
);
554 left
= margin_glyphs_to_reserve (w
, dim
.width
,
555 w
->left_margin_cols
);
556 right
= margin_glyphs_to_reserve (w
, dim
.width
,
557 w
->right_margin_cols
);
562 for (i
= 0; i
< dim
.height
; ++i
)
564 struct glyph_row
*row
= &matrix
->rows
[i
];
566 row
->glyphs
[LEFT_MARGIN_AREA
]
567 = (matrix
->pool
->glyphs
568 + (y
+ i
) * matrix
->pool
->ncolumns
572 || row
== matrix
->rows
+ dim
.height
- 1
573 || (row
== matrix
->rows
&& matrix
->header_line_p
))
575 row
->glyphs
[TEXT_AREA
]
576 = row
->glyphs
[LEFT_MARGIN_AREA
];
577 row
->glyphs
[RIGHT_MARGIN_AREA
]
578 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
579 row
->glyphs
[LAST_AREA
]
580 = row
->glyphs
[RIGHT_MARGIN_AREA
];
584 row
->glyphs
[TEXT_AREA
]
585 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
586 row
->glyphs
[RIGHT_MARGIN_AREA
]
587 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
588 row
->glyphs
[LAST_AREA
]
589 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
593 matrix
->left_margin_glyphs
= left
;
594 matrix
->right_margin_glyphs
= right
;
598 /* If MATRIX->pool is null, MATRIX is responsible for managing
599 its own memory. It is a window matrix for window-based redisplay.
600 Allocate glyph memory from the heap. */
601 if (dim
.width
> matrix
->matrix_w
603 || header_line_changed_p
604 || marginal_areas_changed_p
)
606 struct glyph_row
*row
= matrix
->rows
;
607 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
611 row
->glyphs
[LEFT_MARGIN_AREA
]
612 = (struct glyph
*) xrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
614 * sizeof (struct glyph
)));
616 /* The mode line never has marginal areas. */
617 if (row
== matrix
->rows
+ dim
.height
- 1
618 || (row
== matrix
->rows
&& matrix
->header_line_p
))
620 row
->glyphs
[TEXT_AREA
]
621 = row
->glyphs
[LEFT_MARGIN_AREA
];
622 row
->glyphs
[RIGHT_MARGIN_AREA
]
623 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
624 row
->glyphs
[LAST_AREA
]
625 = row
->glyphs
[RIGHT_MARGIN_AREA
];
629 row
->glyphs
[TEXT_AREA
]
630 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
631 row
->glyphs
[RIGHT_MARGIN_AREA
]
632 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
633 row
->glyphs
[LAST_AREA
]
634 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
640 xassert (left
>= 0 && right
>= 0);
641 matrix
->left_margin_glyphs
= left
;
642 matrix
->right_margin_glyphs
= right
;
645 /* Number of rows to be used by MATRIX. */
646 matrix
->nrows
= dim
.height
;
647 xassert (matrix
->nrows
>= 0);
651 if (matrix
== w
->current_matrix
)
653 /* Mark rows in a current matrix of a window as not having
654 valid contents. It's important to not do this for
655 desired matrices. When Emacs starts, it may already be
656 building desired matrices when this function runs. */
657 if (window_width
< 0)
658 window_width
= window_box_width (w
, -1);
660 /* Optimize the case that only the height has changed (C-x 2,
661 upper window). Invalidate all rows that are no longer part
663 if (!marginal_areas_changed_p
664 && !header_line_changed_p
666 && dim
.width
== matrix
->matrix_w
667 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
668 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
669 && matrix
->window_width
== window_width
)
671 /* Find the last row in the window. */
672 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
673 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
679 /* Window end is invalid, if inside of the rows that
680 are invalidated below. */
681 if (INTEGERP (w
->window_end_vpos
)
682 && XFASTINT (w
->window_end_vpos
) >= i
)
683 w
->window_end_valid
= Qnil
;
685 while (i
< matrix
->nrows
)
686 matrix
->rows
[i
++].enabled_p
= 0;
690 for (i
= 0; i
< matrix
->nrows
; ++i
)
691 matrix
->rows
[i
].enabled_p
= 0;
694 else if (matrix
== w
->desired_matrix
)
696 /* Rows in desired matrices always have to be cleared;
697 redisplay expects this is the case when it runs, so it
698 had better be the case when we adjust matrices between
700 for (i
= 0; i
< matrix
->nrows
; ++i
)
701 matrix
->rows
[i
].enabled_p
= 0;
706 /* Remember last values to be able to optimize frame redraws. */
707 matrix
->matrix_x
= x
;
708 matrix
->matrix_y
= y
;
709 matrix
->matrix_w
= dim
.width
;
710 matrix
->matrix_h
= dim
.height
;
712 /* Record the top y location and height of W at the time the matrix
713 was last adjusted. This is used to optimize redisplay above. */
716 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
717 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
718 matrix
->window_height
= window_height
;
719 matrix
->window_width
= window_width
;
720 matrix
->window_vscroll
= w
->vscroll
;
725 /* Reverse the contents of rows in MATRIX between START and END. The
726 contents of the row at END - 1 end up at START, END - 2 at START +
727 1 etc. This is part of the implementation of rotate_matrix (see
731 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
735 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
737 /* Non-ISO HP/UX compiler doesn't like auto struct
739 struct glyph_row temp
;
740 temp
= matrix
->rows
[i
];
741 matrix
->rows
[i
] = matrix
->rows
[j
];
742 matrix
->rows
[j
] = temp
;
747 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
748 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
749 indices. (Note: this does not copy glyphs, only glyph pointers in
750 row structures are moved around).
752 The algorithm used for rotating the vector was, I believe, first
753 described by Kernighan. See the vector R as consisting of two
754 sub-vectors AB, where A has length BY for BY >= 0. The result
755 after rotating is then BA. Reverse both sub-vectors to get ArBr
756 and reverse the result to get (ArBr)r which is BA. Similar for
760 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
764 /* Up (rotate left, i.e. towards lower indices). */
766 reverse_rows (matrix
, first
, first
+ by
);
767 reverse_rows (matrix
, first
+ by
, last
);
768 reverse_rows (matrix
, first
, last
);
772 /* Down (rotate right, i.e. towards higher indices). */
773 reverse_rows (matrix
, last
- by
, last
);
774 reverse_rows (matrix
, first
, last
- by
);
775 reverse_rows (matrix
, first
, last
);
780 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
781 with indices START <= index < END. Increment positions by DELTA/
785 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
786 EMACS_INT delta
, EMACS_INT delta_bytes
)
788 /* Check that START and END are reasonable values. */
789 xassert (start
>= 0 && start
<= matrix
->nrows
);
790 xassert (end
>= 0 && end
<= matrix
->nrows
);
791 xassert (start
<= end
);
793 for (; start
< end
; ++start
)
794 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
798 /* Enable a range of rows in glyph matrix MATRIX. START and END are
799 the row indices of the first and last + 1 row to enable. If
800 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
803 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
805 xassert (start
<= end
);
806 xassert (start
>= 0 && start
< matrix
->nrows
);
807 xassert (end
>= 0 && end
<= matrix
->nrows
);
809 for (; start
< end
; ++start
)
810 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
816 This empties all rows in MATRIX by setting the enabled_p flag for
817 all rows of the matrix to zero. The function prepare_desired_row
818 will eventually really clear a row when it sees one with a zero
821 Resets update hints to defaults value. The only update hint
822 currently present is the flag MATRIX->no_scrolling_p. */
825 clear_glyph_matrix (struct glyph_matrix
*matrix
)
829 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
830 matrix
->no_scrolling_p
= 0;
835 /* Shift part of the glyph matrix MATRIX of window W up or down.
836 Increment y-positions in glyph rows between START and END by DY,
837 and recompute their visible height. */
840 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
844 xassert (start
<= end
);
845 xassert (start
>= 0 && start
< matrix
->nrows
);
846 xassert (end
>= 0 && end
<= matrix
->nrows
);
848 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
849 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
851 for (; start
< end
; ++start
)
853 struct glyph_row
*row
= &matrix
->rows
[start
];
856 row
->visible_height
= row
->height
;
859 row
->visible_height
-= min_y
- row
->y
;
860 if (row
->y
+ row
->height
> max_y
)
861 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
866 /* Mark all rows in current matrices of frame F as invalid. Marking
867 invalid is done by setting enabled_p to zero for all rows in a
871 clear_current_matrices (register struct frame
*f
)
873 /* Clear frame current matrix, if we have one. */
874 if (f
->current_matrix
)
875 clear_glyph_matrix (f
->current_matrix
);
877 /* Clear the matrix of the menu bar window, if such a window exists.
878 The menu bar window is currently used to display menus on X when
879 no toolkit support is compiled in. */
880 if (WINDOWP (f
->menu_bar_window
))
881 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
883 /* Clear the matrix of the tool-bar window, if any. */
884 if (WINDOWP (f
->tool_bar_window
))
885 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
887 /* Clear current window matrices. */
888 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
889 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
893 /* Clear out all display lines of F for a coming redisplay. */
896 clear_desired_matrices (register struct frame
*f
)
898 if (f
->desired_matrix
)
899 clear_glyph_matrix (f
->desired_matrix
);
901 if (WINDOWP (f
->menu_bar_window
))
902 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
904 if (WINDOWP (f
->tool_bar_window
))
905 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
907 /* Do it for window matrices. */
908 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
909 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
913 /* Clear matrices in window tree rooted in W. If DESIRED_P is
914 non-zero clear desired matrices, otherwise clear current matrices. */
917 clear_window_matrices (struct window
*w
, int desired_p
)
921 if (!NILP (w
->hchild
))
923 xassert (WINDOWP (w
->hchild
));
924 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
926 else if (!NILP (w
->vchild
))
928 xassert (WINDOWP (w
->vchild
));
929 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
934 clear_glyph_matrix (w
->desired_matrix
);
937 clear_glyph_matrix (w
->current_matrix
);
938 w
->window_end_valid
= Qnil
;
942 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
948 /***********************************************************************
951 See dispextern.h for an overall explanation of glyph rows.
952 ***********************************************************************/
954 /* Clear glyph row ROW. Do it in a way that makes it robust against
955 changes in the glyph_row structure, i.e. addition or removal of
956 structure members. */
958 static struct glyph_row null_row
;
961 clear_glyph_row (struct glyph_row
*row
)
963 struct glyph
*p
[1 + LAST_AREA
];
966 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
967 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
968 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
969 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
974 /* Restore pointers. */
975 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
976 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
977 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
978 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
980 #if 0 /* At some point, some bit-fields of struct glyph were not set,
981 which made glyphs unequal when compared with GLYPH_EQUAL_P.
982 Redisplay outputs such glyphs, and flickering effects were
983 the result. This also depended on the contents of memory
984 returned by xmalloc. If flickering happens again, activate
985 the code below. If the flickering is gone with that, chances
986 are that the flickering has the same reason as here. */
987 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
992 /* Make ROW an empty, enabled row of canonical character height,
993 in window W starting at y-position Y. */
996 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
1000 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1001 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
1003 clear_glyph_row (row
);
1005 row
->ascent
= row
->phys_ascent
= 0;
1006 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
1007 row
->visible_height
= row
->height
;
1010 row
->visible_height
-= min_y
- row
->y
;
1011 if (row
->y
+ row
->height
> max_y
)
1012 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
1018 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1019 are the amounts by which to change positions. Note that the first
1020 glyph of the text area of a row can have a buffer position even if
1021 the used count of the text area is zero. Such rows display line
1025 increment_row_positions (struct glyph_row
*row
,
1026 EMACS_INT delta
, EMACS_INT delta_bytes
)
1030 /* Increment start and end positions. */
1031 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1032 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1033 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1034 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1035 CHARPOS (row
->start
.pos
) += delta
;
1036 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1037 CHARPOS (row
->end
.pos
) += delta
;
1038 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1040 if (!row
->enabled_p
)
1043 /* Increment positions in glyphs. */
1044 for (area
= 0; area
< LAST_AREA
; ++area
)
1045 for (i
= 0; i
< row
->used
[area
]; ++i
)
1046 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1047 && row
->glyphs
[area
][i
].charpos
> 0)
1048 row
->glyphs
[area
][i
].charpos
+= delta
;
1050 /* Capture the case of rows displaying a line end. */
1051 if (row
->used
[TEXT_AREA
] == 0
1052 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1053 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1058 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1059 contents, i.e. glyph structure contents are exchanged between A and
1060 B without changing glyph pointers in A and B. */
1063 swap_glyphs_in_rows (a
, b
)
1064 struct glyph_row
*a
, *b
;
1068 for (area
= 0; area
< LAST_AREA
; ++area
)
1070 /* Number of glyphs to swap. */
1071 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1073 /* Start of glyphs in area of row A. */
1074 struct glyph
*glyph_a
= a
->glyphs
[area
];
1076 /* End + 1 of glyphs in area of row A. */
1077 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1079 /* Start of glyphs in area of row B. */
1080 struct glyph
*glyph_b
= b
->glyphs
[area
];
1082 while (glyph_a
< glyph_a_end
)
1084 /* Non-ISO HP/UX compiler doesn't like auto struct
1088 *glyph_a
= *glyph_b
;
1098 /* Exchange pointers to glyph memory between glyph rows A and B. */
1101 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1104 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1106 struct glyph
*temp
= a
->glyphs
[i
];
1107 a
->glyphs
[i
] = b
->glyphs
[i
];
1108 b
->glyphs
[i
] = temp
;
1113 /* Copy glyph row structure FROM to glyph row structure TO, except
1114 that glyph pointers in the structures are left unchanged. */
1117 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1119 struct glyph
*pointers
[1 + LAST_AREA
];
1121 /* Save glyph pointers of TO. */
1122 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1124 /* Do a structure assignment. */
1127 /* Restore original pointers of TO. */
1128 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1132 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1133 TO and FROM are left unchanged. Glyph contents are copied from the
1134 glyph memory of FROM to the glyph memory of TO. Increment buffer
1135 positions in row TO by DELTA/ DELTA_BYTES. */
1138 copy_glyph_row_contents (struct glyph_row
*to
, struct glyph_row
*from
,
1139 EMACS_INT delta
, EMACS_INT delta_bytes
)
1143 /* This is like a structure assignment TO = FROM, except that
1144 glyph pointers in the rows are left unchanged. */
1145 copy_row_except_pointers (to
, from
);
1147 /* Copy glyphs from FROM to TO. */
1148 for (area
= 0; area
< LAST_AREA
; ++area
)
1149 if (from
->used
[area
])
1150 memcpy (to
->glyphs
[area
], from
->glyphs
[area
],
1151 from
->used
[area
] * sizeof (struct glyph
));
1153 /* Increment buffer positions in TO by DELTA. */
1154 increment_row_positions (to
, delta
, delta_bytes
);
1158 /* Assign glyph row FROM to glyph row TO. This works like a structure
1159 assignment TO = FROM, except that glyph pointers are not copied but
1160 exchanged between TO and FROM. Pointers must be exchanged to avoid
1164 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1166 swap_glyph_pointers (to
, from
);
1167 copy_row_except_pointers (to
, from
);
1171 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1172 a row in a window matrix, is a slice of the glyph memory of the
1173 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1174 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1175 memory of FRAME_ROW. */
1180 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1182 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1183 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1184 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1186 return (frame_glyph_start
<= window_glyph_start
1187 && window_glyph_start
< frame_glyph_end
);
1190 #endif /* GLYPH_DEBUG */
1194 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1195 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1196 in WINDOW_MATRIX is found satisfying the condition. */
1198 static struct glyph_row
*
1199 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1200 struct glyph_matrix
*frame_matrix
, int row
)
1204 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1206 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1207 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1208 frame_matrix
->rows
+ row
))
1211 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1216 /* Prepare ROW for display. Desired rows are cleared lazily,
1217 i.e. they are only marked as to be cleared by setting their
1218 enabled_p flag to zero. When a row is to be displayed, a prior
1219 call to this function really clears it. */
1222 prepare_desired_row (struct glyph_row
*row
)
1224 if (!row
->enabled_p
)
1226 unsigned rp
= row
->reversed_p
;
1228 clear_glyph_row (row
);
1230 row
->reversed_p
= rp
;
1235 /* Return a hash code for glyph row ROW. */
1238 line_hash_code (struct glyph_row
*row
)
1244 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1245 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1249 int c
= glyph
->u
.ch
;
1250 int face_id
= glyph
->face_id
;
1251 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1253 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1254 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1266 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1267 the number of characters in the line. If must_write_spaces is
1268 zero, leading and trailing spaces are ignored. */
1271 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1273 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1274 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1275 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1277 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1278 int glyph_table_len
= GLYPH_TABLE_LENGTH
;
1280 /* Ignore trailing and leading spaces if we can. */
1281 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1283 /* Skip from the end over trailing spaces. */
1284 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1287 /* All blank line. */
1291 /* Skip over leading spaces. */
1292 while (CHAR_GLYPH_SPACE_P (*beg
))
1296 /* If we don't have a glyph-table, each glyph is one character,
1297 so return the number of glyphs. */
1298 if (glyph_table_base
== 0)
1302 /* Otherwise, scan the glyphs and accumulate their total length
1309 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1311 if (GLYPH_INVALID_P (g
)
1312 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1315 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1325 /* Test two glyph rows A and B for equality. Value is non-zero if A
1326 and B have equal contents. W is the window to which the glyphs
1327 rows A and B belong. It is needed here to test for partial row
1328 visibility. MOUSE_FACE_P non-zero means compare the mouse_face_p
1329 flags of A and B, too. */
1332 row_equal_p (struct window
*w
, struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1336 else if (a
->hash
!= b
->hash
)
1340 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1343 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1346 /* Compare glyphs. */
1347 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1349 if (a
->used
[area
] != b
->used
[area
])
1352 a_glyph
= a
->glyphs
[area
];
1353 a_end
= a_glyph
+ a
->used
[area
];
1354 b_glyph
= b
->glyphs
[area
];
1356 while (a_glyph
< a_end
1357 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1358 ++a_glyph
, ++b_glyph
;
1360 if (a_glyph
!= a_end
)
1364 if (a
->fill_line_p
!= b
->fill_line_p
1365 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1366 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1367 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1368 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1369 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1370 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1371 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1372 || a
->overlapped_p
!= b
->overlapped_p
1373 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1374 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1375 || a
->reversed_p
!= b
->reversed_p
1376 /* Different partially visible characters on left margin. */
1378 /* Different height. */
1379 || a
->ascent
!= b
->ascent
1380 || a
->phys_ascent
!= b
->phys_ascent
1381 || a
->phys_height
!= b
->phys_height
1382 || a
->visible_height
!= b
->visible_height
)
1391 /***********************************************************************
1394 See dispextern.h for an overall explanation of glyph pools.
1395 ***********************************************************************/
1397 /* Allocate a glyph_pool structure. The structure returned is
1398 initialized with zeros. The global variable glyph_pool_count is
1399 incremented for each pool allocated. */
1401 static struct glyph_pool
*
1402 new_glyph_pool (void)
1404 struct glyph_pool
*result
;
1406 /* Allocate a new glyph_pool and clear it. */
1407 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1408 memset (result
, 0, sizeof *result
);
1410 /* For memory leak and double deletion checking. */
1417 /* Free a glyph_pool structure POOL. The function may be called with
1418 a null POOL pointer. The global variable glyph_pool_count is
1419 decremented with every pool structure freed. If this count gets
1420 negative, more structures were freed than allocated, i.e. one
1421 structure must have been freed more than once or a bogus pointer
1422 was passed to free_glyph_pool. */
1425 free_glyph_pool (struct glyph_pool
*pool
)
1429 /* More freed than allocated? */
1431 xassert (glyph_pool_count
>= 0);
1433 xfree (pool
->glyphs
);
1439 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1440 columns we need. This function never shrinks a pool. The only
1441 case in which this would make sense, would be when a frame's size
1442 is changed from a large value to a smaller one. But, if someone
1443 does it once, we can expect that he will do it again.
1445 Value is non-zero if the pool changed in a way which makes
1446 re-adjusting window glyph matrices necessary. */
1449 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1454 changed_p
= (pool
->glyphs
== 0
1455 || matrix_dim
.height
!= pool
->nrows
1456 || matrix_dim
.width
!= pool
->ncolumns
);
1458 /* Enlarge the glyph pool. */
1459 needed
= matrix_dim
.width
* matrix_dim
.height
;
1460 if (needed
> pool
->nglyphs
)
1462 int size
= needed
* sizeof (struct glyph
);
1466 pool
->glyphs
= (struct glyph
*) xrealloc (pool
->glyphs
, size
);
1467 memset (pool
->glyphs
+ pool
->nglyphs
, 0,
1468 size
- pool
->nglyphs
* sizeof (struct glyph
));
1472 pool
->glyphs
= (struct glyph
*) xmalloc (size
);
1473 memset (pool
->glyphs
, 0, size
);
1476 pool
->nglyphs
= needed
;
1479 /* Remember the number of rows and columns because (a) we use them
1480 to do sanity checks, and (b) the number of columns determines
1481 where rows in the frame matrix start---this must be available to
1482 determine pointers to rows of window sub-matrices. */
1483 pool
->nrows
= matrix_dim
.height
;
1484 pool
->ncolumns
= matrix_dim
.width
;
1491 /***********************************************************************
1493 ***********************************************************************/
1498 /* Flush standard output. This is sometimes useful to call from the debugger.
1499 XXX Maybe this should be changed to flush the current terminal instead of
1510 /* Check that no glyph pointers have been lost in MATRIX. If a
1511 pointer has been lost, e.g. by using a structure assignment between
1512 rows, at least one pointer must occur more than once in the rows of
1516 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1520 for (i
= 0; i
< matrix
->nrows
; ++i
)
1521 for (j
= 0; j
< matrix
->nrows
; ++j
)
1523 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1524 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1528 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1531 matrix_row (struct glyph_matrix
*matrix
, int row
)
1533 xassert (matrix
&& matrix
->rows
);
1534 xassert (row
>= 0 && row
< matrix
->nrows
);
1536 /* That's really too slow for normal testing because this function
1537 is called almost everywhere. Although---it's still astonishingly
1538 fast, so it is valuable to have for debugging purposes. */
1540 check_matrix_pointer_lossage (matrix
);
1543 return matrix
->rows
+ row
;
1547 #if 0 /* This function makes invalid assumptions when text is
1548 partially invisible. But it might come handy for debugging
1551 /* Check invariants that must hold for an up to date current matrix of
1555 check_matrix_invariants (struct window
*w
)
1557 struct glyph_matrix
*matrix
= w
->current_matrix
;
1558 int yb
= window_text_bottom_y (w
);
1559 struct glyph_row
*row
= matrix
->rows
;
1560 struct glyph_row
*last_text_row
= NULL
;
1561 struct buffer
*saved
= current_buffer
;
1562 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1565 /* This can sometimes happen for a fresh window. */
1566 if (matrix
->nrows
< 2)
1569 set_buffer_temp (buffer
);
1571 /* Note: last row is always reserved for the mode line. */
1572 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1573 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1575 struct glyph_row
*next
= row
+ 1;
1577 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1578 last_text_row
= row
;
1580 /* Check that character and byte positions are in sync. */
1581 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1582 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1583 xassert (BYTEPOS (row
->start
.pos
)
1584 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1586 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1587 have such a position temporarily in case of a minibuffer
1588 displaying something like `[Sole completion]' at its end. */
1589 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1591 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1592 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1593 xassert (BYTEPOS (row
->end
.pos
)
1594 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1597 /* Check that end position of `row' is equal to start position
1599 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1601 xassert (MATRIX_ROW_END_CHARPOS (row
)
1602 == MATRIX_ROW_START_CHARPOS (next
));
1603 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1604 == MATRIX_ROW_START_BYTEPOS (next
));
1605 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1606 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1611 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1612 xassert (w
->desired_matrix
->rows
!= NULL
);
1613 set_buffer_temp (saved
);
1618 #endif /* GLYPH_DEBUG != 0 */
1622 /**********************************************************************
1623 Allocating/ Adjusting Glyph Matrices
1624 **********************************************************************/
1626 /* Allocate glyph matrices over a window tree for a frame-based
1629 X and Y are column/row within the frame glyph matrix where
1630 sub-matrices for the window tree rooted at WINDOW must be
1631 allocated. DIM_ONLY_P non-zero means that the caller of this
1632 function is only interested in the result matrix dimension, and
1633 matrix adjustments should not be performed.
1635 The function returns the total width/height of the sub-matrices of
1636 the window tree. If called on a frame root window, the computation
1637 will take the mini-buffer window into account.
1639 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1641 NEW_LEAF_MATRIX set if any window in the tree did not have a
1642 glyph matrices yet, and
1644 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1645 any window in the tree will be changed or have been changed (see
1648 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1651 Windows are arranged into chains of windows on the same level
1652 through the next fields of window structures. Such a level can be
1653 either a sequence of horizontally adjacent windows from left to
1654 right, or a sequence of vertically adjacent windows from top to
1655 bottom. Each window in a horizontal sequence can be either a leaf
1656 window or a vertical sequence; a window in a vertical sequence can
1657 be either a leaf or a horizontal sequence. All windows in a
1658 horizontal sequence have the same height, and all windows in a
1659 vertical sequence have the same width.
1661 This function uses, for historical reasons, a more general
1662 algorithm to determine glyph matrix dimensions that would be
1665 The matrix height of a horizontal sequence is determined by the
1666 maximum height of any matrix in the sequence. The matrix width of
1667 a horizontal sequence is computed by adding up matrix widths of
1668 windows in the sequence.
1670 |<------- result width ------->|
1671 +---------+----------+---------+ ---
1674 +---------+ | | result height
1679 The matrix width of a vertical sequence is the maximum matrix width
1680 of any window in the sequence. Its height is computed by adding up
1681 matrix heights of windows in the sequence.
1683 |<---- result width -->|
1691 +------------+---------+ |
1694 +------------+---------+ --- */
1696 /* Bit indicating that a new matrix will be allocated or has been
1699 #define NEW_LEAF_MATRIX (1 << 0)
1701 /* Bit indicating that a matrix will or has changed its location or
1704 #define CHANGED_LEAF_MATRIX (1 << 1)
1707 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1708 int dim_only_p
, int *window_change_flags
)
1710 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1712 int wmax
= 0, hmax
= 0;
1716 int in_horz_combination_p
;
1718 /* What combination is WINDOW part of? Compute this once since the
1719 result is the same for all windows in the `next' chain. The
1720 special case of a root window (parent equal to nil) is treated
1721 like a vertical combination because a root window's `next'
1722 points to the mini-buffer window, if any, which is arranged
1723 vertically below other windows. */
1724 in_horz_combination_p
1725 = (!NILP (XWINDOW (window
)->parent
)
1726 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1728 /* For WINDOW and all windows on the same level. */
1731 w
= XWINDOW (window
);
1733 /* Get the dimension of the window sub-matrix for W, depending
1734 on whether this is a combination or a leaf window. */
1735 if (!NILP (w
->hchild
))
1736 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1738 window_change_flags
);
1739 else if (!NILP (w
->vchild
))
1740 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1742 window_change_flags
);
1745 /* If not already done, allocate sub-matrix structures. */
1746 if (w
->desired_matrix
== NULL
)
1748 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1749 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1750 *window_change_flags
|= NEW_LEAF_MATRIX
;
1753 /* Width and height MUST be chosen so that there are no
1754 holes in the frame matrix. */
1755 dim
.width
= required_matrix_width (w
);
1756 dim
.height
= required_matrix_height (w
);
1758 /* Will matrix be re-allocated? */
1759 if (x
!= w
->desired_matrix
->matrix_x
1760 || y
!= w
->desired_matrix
->matrix_y
1761 || dim
.width
!= w
->desired_matrix
->matrix_w
1762 || dim
.height
!= w
->desired_matrix
->matrix_h
1763 || (margin_glyphs_to_reserve (w
, dim
.width
,
1764 w
->left_margin_cols
)
1765 != w
->desired_matrix
->left_margin_glyphs
)
1766 || (margin_glyphs_to_reserve (w
, dim
.width
,
1767 w
->right_margin_cols
)
1768 != w
->desired_matrix
->right_margin_glyphs
))
1769 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1771 /* Actually change matrices, if allowed. Do not consider
1772 CHANGED_LEAF_MATRIX computed above here because the pool
1773 may have been changed which we don't now here. We trust
1774 that we only will be called with DIM_ONLY_P != 0 when
1778 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1779 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1783 /* If we are part of a horizontal combination, advance x for
1784 windows to the right of W; otherwise advance y for windows
1786 if (in_horz_combination_p
)
1791 /* Remember maximum glyph matrix dimensions. */
1792 wmax
= max (wmax
, dim
.width
);
1793 hmax
= max (hmax
, dim
.height
);
1795 /* Next window on same level. */
1798 while (!NILP (window
));
1800 /* Set `total' to the total glyph matrix dimension of this window
1801 level. In a vertical combination, the width is the width of the
1802 widest window; the height is the y we finally reached, corrected
1803 by the y we started with. In a horizontal combination, the total
1804 height is the height of the tallest window, and the width is the
1805 x we finally reached, corrected by the x we started with. */
1806 if (in_horz_combination_p
)
1808 total
.width
= x
- x0
;
1809 total
.height
= hmax
;
1814 total
.height
= y
- y0
;
1821 /* Return the required height of glyph matrices for window W. */
1824 required_matrix_height (struct window
*w
)
1826 #ifdef HAVE_WINDOW_SYSTEM
1827 struct frame
*f
= XFRAME (w
->frame
);
1829 if (FRAME_WINDOW_P (f
))
1831 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1832 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1833 return (((window_pixel_height
+ ch_height
- 1)
1834 / ch_height
) * w
->nrows_scale_factor
1835 /* One partially visible line at the top and
1836 bottom of the window. */
1838 /* 2 for header and mode line. */
1841 #endif /* HAVE_WINDOW_SYSTEM */
1843 return WINDOW_TOTAL_LINES (w
);
1847 /* Return the required width of glyph matrices for window W. */
1850 required_matrix_width (struct window
*w
)
1852 #ifdef HAVE_WINDOW_SYSTEM
1853 struct frame
*f
= XFRAME (w
->frame
);
1854 if (FRAME_WINDOW_P (f
))
1856 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1857 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1859 /* Compute number of glyphs needed in a glyph row. */
1860 return (((window_pixel_width
+ ch_width
- 1)
1861 / ch_width
) * w
->ncols_scale_factor
1862 /* 2 partially visible columns in the text area. */
1864 /* One partially visible column at the right
1865 edge of each marginal area. */
1868 #endif /* HAVE_WINDOW_SYSTEM */
1870 return XINT (w
->total_cols
);
1874 /* Allocate window matrices for window-based redisplay. W is the
1875 window whose matrices must be allocated/reallocated. */
1878 allocate_matrices_for_window_redisplay (struct window
*w
)
1882 if (!NILP (w
->vchild
))
1883 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1884 else if (!NILP (w
->hchild
))
1885 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1888 /* W is a leaf window. */
1891 /* If matrices are not yet allocated, allocate them now. */
1892 if (w
->desired_matrix
== NULL
)
1894 w
->desired_matrix
= new_glyph_matrix (NULL
);
1895 w
->current_matrix
= new_glyph_matrix (NULL
);
1898 dim
.width
= required_matrix_width (w
);
1899 dim
.height
= required_matrix_height (w
);
1900 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1901 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1904 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1909 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1910 do it for all frames; otherwise do it just for the given frame.
1911 This function must be called when a new frame is created, its size
1912 changes, or its window configuration changes. */
1915 adjust_glyphs (struct frame
*f
)
1917 /* Block input so that expose events and other events that access
1918 glyph matrices are not processed while we are changing them. */
1922 adjust_frame_glyphs (f
);
1925 Lisp_Object tail
, lisp_frame
;
1927 FOR_EACH_FRAME (tail
, lisp_frame
)
1928 adjust_frame_glyphs (XFRAME (lisp_frame
));
1935 /* Adjust frame glyphs when Emacs is initialized.
1937 To be called from init_display.
1939 We need a glyph matrix because redraw will happen soon.
1940 Unfortunately, window sizes on selected_frame are not yet set to
1941 meaningful values. I believe we can assume that there are only two
1942 windows on the frame---the mini-buffer and the root window. Frame
1943 height and width seem to be correct so far. So, set the sizes of
1944 windows to estimated values. */
1947 adjust_frame_glyphs_initially (void)
1949 struct frame
*sf
= SELECTED_FRAME ();
1950 struct window
*root
= XWINDOW (sf
->root_window
);
1951 struct window
*mini
= XWINDOW (root
->next
);
1952 int frame_lines
= FRAME_LINES (sf
);
1953 int frame_cols
= FRAME_COLS (sf
);
1954 int top_margin
= FRAME_TOP_MARGIN (sf
);
1956 /* Do it for the root window. */
1957 XSETFASTINT (root
->top_line
, top_margin
);
1958 XSETFASTINT (root
->total_cols
, frame_cols
);
1959 set_window_height (sf
->root_window
, frame_lines
- 1 - top_margin
, 0);
1961 /* Do it for the mini-buffer window. */
1962 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1963 XSETFASTINT (mini
->total_cols
, frame_cols
);
1964 set_window_height (root
->next
, 1, 0);
1966 adjust_frame_glyphs (sf
);
1967 glyphs_initialized_initially_p
= 1;
1971 /* Allocate/reallocate glyph matrices of a single frame F. */
1974 adjust_frame_glyphs (struct frame
*f
)
1976 if (FRAME_WINDOW_P (f
))
1977 adjust_frame_glyphs_for_window_redisplay (f
);
1979 adjust_frame_glyphs_for_frame_redisplay (f
);
1981 /* Don't forget the message buffer and the buffer for
1982 decode_mode_spec. */
1983 adjust_frame_message_buffer (f
);
1984 adjust_decode_mode_spec_buffer (f
);
1986 f
->glyphs_initialized_p
= 1;
1989 /* Return 1 if any window in the tree has nonzero window margins. See
1990 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1992 showing_window_margins_p (struct window
*w
)
1996 if (!NILP (w
->hchild
))
1998 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
2001 else if (!NILP (w
->vchild
))
2003 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
2006 else if (!NILP (w
->left_margin_cols
)
2007 || !NILP (w
->right_margin_cols
))
2010 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2016 /* In the window tree with root W, build current matrices of leaf
2017 windows from the frame's current matrix. */
2020 fake_current_matrices (Lisp_Object window
)
2024 for (; !NILP (window
); window
= w
->next
)
2026 w
= XWINDOW (window
);
2028 if (!NILP (w
->hchild
))
2029 fake_current_matrices (w
->hchild
);
2030 else if (!NILP (w
->vchild
))
2031 fake_current_matrices (w
->vchild
);
2035 struct frame
*f
= XFRAME (w
->frame
);
2036 struct glyph_matrix
*m
= w
->current_matrix
;
2037 struct glyph_matrix
*fm
= f
->current_matrix
;
2039 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
2040 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
2042 for (i
= 0; i
< m
->matrix_h
; ++i
)
2044 struct glyph_row
*r
= m
->rows
+ i
;
2045 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2047 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2048 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2050 r
->enabled_p
= fr
->enabled_p
;
2053 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2054 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2055 r
->used
[TEXT_AREA
] = (m
->matrix_w
2056 - r
->used
[LEFT_MARGIN_AREA
]
2057 - r
->used
[RIGHT_MARGIN_AREA
]);
2066 /* Save away the contents of frame F's current frame matrix. Value is
2067 a glyph matrix holding the contents of F's current frame matrix. */
2069 static struct glyph_matrix
*
2070 save_current_matrix (struct frame
*f
)
2073 struct glyph_matrix
*saved
;
2075 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2076 memset (saved
, 0, sizeof *saved
);
2077 saved
->nrows
= f
->current_matrix
->nrows
;
2078 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2079 * sizeof *saved
->rows
);
2080 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2082 for (i
= 0; i
< saved
->nrows
; ++i
)
2084 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2085 struct glyph_row
*to
= saved
->rows
+ i
;
2086 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2087 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2088 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2089 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2096 /* Restore the contents of frame F's current frame matrix from SAVED,
2097 and free memory associated with SAVED. */
2100 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2104 for (i
= 0; i
< saved
->nrows
; ++i
)
2106 struct glyph_row
*from
= saved
->rows
+ i
;
2107 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2108 size_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2109 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2110 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2111 xfree (from
->glyphs
[TEXT_AREA
]);
2114 xfree (saved
->rows
);
2120 /* Allocate/reallocate glyph matrices of a single frame F for
2121 frame-based redisplay. */
2124 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2126 struct dim matrix_dim
;
2128 int window_change_flags
;
2131 if (!FRAME_LIVE_P (f
))
2134 top_window_y
= FRAME_TOP_MARGIN (f
);
2136 /* Allocate glyph pool structures if not already done. */
2137 if (f
->desired_pool
== NULL
)
2139 f
->desired_pool
= new_glyph_pool ();
2140 f
->current_pool
= new_glyph_pool ();
2143 /* Allocate frames matrix structures if needed. */
2144 if (f
->desired_matrix
== NULL
)
2146 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2147 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2150 /* Compute window glyph matrices. (This takes the mini-buffer
2151 window into account). The result is the size of the frame glyph
2152 matrix needed. The variable window_change_flags is set to a bit
2153 mask indicating whether new matrices will be allocated or
2154 existing matrices change their size or location within the frame
2156 window_change_flags
= 0;
2158 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2161 &window_change_flags
);
2163 /* Add in menu bar lines, if any. */
2164 matrix_dim
.height
+= top_window_y
;
2166 /* Enlarge pools as necessary. */
2167 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2168 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2170 /* Set up glyph pointers within window matrices. Do this only if
2171 absolutely necessary since it requires a frame redraw. */
2172 if (pool_changed_p
|| window_change_flags
)
2174 /* Do it for window matrices. */
2175 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2177 &window_change_flags
);
2179 /* Size of frame matrices must equal size of frame. Note
2180 that we are called for X frames with window widths NOT equal
2181 to the frame width (from CHANGE_FRAME_SIZE_1). */
2182 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2183 && matrix_dim
.height
== FRAME_LINES (f
));
2185 /* Pointers to glyph memory in glyph rows are exchanged during
2186 the update phase of redisplay, which means in general that a
2187 frame's current matrix consists of pointers into both the
2188 desired and current glyph pool of the frame. Adjusting a
2189 matrix sets the frame matrix up so that pointers are all into
2190 the same pool. If we want to preserve glyph contents of the
2191 current matrix over a call to adjust_glyph_matrix, we must
2192 make a copy of the current glyphs, and restore the current
2193 matrix' contents from that copy. */
2194 if (display_completed
2195 && !FRAME_GARBAGED_P (f
)
2196 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2197 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2198 /* For some reason, the frame glyph matrix gets corrupted if
2199 any of the windows contain margins. I haven't been able
2200 to hunt down the reason, but for the moment this prevents
2201 the problem from manifesting. -- cyd */
2202 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2204 struct glyph_matrix
*copy
= save_current_matrix (f
);
2205 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2206 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2207 restore_current_matrix (f
, copy
);
2208 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2212 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2213 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2214 SET_FRAME_GARBAGED (f
);
2220 /* Allocate/reallocate glyph matrices of a single frame F for
2221 window-based redisplay. */
2224 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2228 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2230 /* Allocate/reallocate window matrices. */
2231 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2233 #ifdef HAVE_X_WINDOWS
2234 /* Allocate/ reallocate matrices of the dummy window used to display
2235 the menu bar under X when no X toolkit support is available. */
2236 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2238 /* Allocate a dummy window if not already done. */
2239 if (NILP (f
->menu_bar_window
))
2241 f
->menu_bar_window
= make_window ();
2242 w
= XWINDOW (f
->menu_bar_window
);
2243 XSETFRAME (w
->frame
, f
);
2244 w
->pseudo_window_p
= 1;
2247 w
= XWINDOW (f
->menu_bar_window
);
2249 /* Set window dimensions to frame dimensions and allocate or
2250 adjust glyph matrices of W. */
2251 XSETFASTINT (w
->top_line
, 0);
2252 XSETFASTINT (w
->left_col
, 0);
2253 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2254 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2255 allocate_matrices_for_window_redisplay (w
);
2257 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2258 #endif /* HAVE_X_WINDOWS */
2261 /* Allocate/ reallocate matrices of the tool bar window. If we
2262 don't have a tool bar window yet, make one. */
2263 if (NILP (f
->tool_bar_window
))
2265 f
->tool_bar_window
= make_window ();
2266 w
= XWINDOW (f
->tool_bar_window
);
2267 XSETFRAME (w
->frame
, f
);
2268 w
->pseudo_window_p
= 1;
2271 w
= XWINDOW (f
->tool_bar_window
);
2273 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2274 XSETFASTINT (w
->left_col
, 0);
2275 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2276 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2277 allocate_matrices_for_window_redisplay (w
);
2282 /* Adjust/ allocate message buffer of frame F.
2284 Note that the message buffer is never freed. Since I could not
2285 find a free in 19.34, I assume that freeing it would be
2286 problematic in some way and don't do it either.
2288 (Implementation note: It should be checked if we can free it
2289 eventually without causing trouble). */
2292 adjust_frame_message_buffer (struct frame
*f
)
2294 int size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2296 if (FRAME_MESSAGE_BUF (f
))
2298 char *buffer
= FRAME_MESSAGE_BUF (f
);
2299 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2300 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2303 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2307 /* Re-allocate buffer for decode_mode_spec on frame F. */
2310 adjust_decode_mode_spec_buffer (struct frame
*f
)
2312 f
->decode_mode_spec_buffer
2313 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2314 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2319 /**********************************************************************
2320 Freeing Glyph Matrices
2321 **********************************************************************/
2323 /* Free glyph memory for a frame F. F may be null. This function can
2324 be called for the same frame more than once. The root window of
2325 F may be nil when this function is called. This is the case when
2326 the function is called when F is destroyed. */
2329 free_glyphs (struct frame
*f
)
2331 if (f
&& f
->glyphs_initialized_p
)
2333 /* Block interrupt input so that we don't get surprised by an X
2334 event while we're in an inconsistent state. */
2336 f
->glyphs_initialized_p
= 0;
2338 /* Release window sub-matrices. */
2339 if (!NILP (f
->root_window
))
2340 free_window_matrices (XWINDOW (f
->root_window
));
2342 /* Free the dummy window for menu bars without X toolkit and its
2344 if (!NILP (f
->menu_bar_window
))
2346 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2347 free_glyph_matrix (w
->desired_matrix
);
2348 free_glyph_matrix (w
->current_matrix
);
2349 w
->desired_matrix
= w
->current_matrix
= NULL
;
2350 f
->menu_bar_window
= Qnil
;
2353 /* Free the tool bar window and its glyph matrices. */
2354 if (!NILP (f
->tool_bar_window
))
2356 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2357 free_glyph_matrix (w
->desired_matrix
);
2358 free_glyph_matrix (w
->current_matrix
);
2359 w
->desired_matrix
= w
->current_matrix
= NULL
;
2360 f
->tool_bar_window
= Qnil
;
2363 /* Release frame glyph matrices. Reset fields to zero in
2364 case we are called a second time. */
2365 if (f
->desired_matrix
)
2367 free_glyph_matrix (f
->desired_matrix
);
2368 free_glyph_matrix (f
->current_matrix
);
2369 f
->desired_matrix
= f
->current_matrix
= NULL
;
2372 /* Release glyph pools. */
2373 if (f
->desired_pool
)
2375 free_glyph_pool (f
->desired_pool
);
2376 free_glyph_pool (f
->current_pool
);
2377 f
->desired_pool
= f
->current_pool
= NULL
;
2385 /* Free glyph sub-matrices in the window tree rooted at W. This
2386 function may be called with a null pointer, and it may be called on
2387 the same tree more than once. */
2390 free_window_matrices (struct window
*w
)
2394 if (!NILP (w
->hchild
))
2395 free_window_matrices (XWINDOW (w
->hchild
));
2396 else if (!NILP (w
->vchild
))
2397 free_window_matrices (XWINDOW (w
->vchild
));
2400 /* This is a leaf window. Free its memory and reset fields
2401 to zero in case this function is called a second time for
2403 free_glyph_matrix (w
->current_matrix
);
2404 free_glyph_matrix (w
->desired_matrix
);
2405 w
->current_matrix
= w
->desired_matrix
= NULL
;
2408 /* Next window on same level. */
2409 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2414 /* Check glyph memory leaks. This function is called from
2415 shut_down_emacs. Note that frames are not destroyed when Emacs
2416 exits. We therefore free all glyph memory for all active frames
2417 explicitly and check that nothing is left allocated. */
2420 check_glyph_memory (void)
2422 Lisp_Object tail
, frame
;
2424 /* Free glyph memory for all frames. */
2425 FOR_EACH_FRAME (tail
, frame
)
2426 free_glyphs (XFRAME (frame
));
2428 /* Check that nothing is left allocated. */
2429 if (glyph_matrix_count
)
2431 if (glyph_pool_count
)
2437 /**********************************************************************
2438 Building a Frame Matrix
2439 **********************************************************************/
2441 /* Most of the redisplay code works on glyph matrices attached to
2442 windows. This is a good solution most of the time, but it is not
2443 suitable for terminal code. Terminal output functions cannot rely
2444 on being able to set an arbitrary terminal window. Instead they
2445 must be provided with a view of the whole frame, i.e. the whole
2446 screen. We build such a view by constructing a frame matrix from
2447 window matrices in this section.
2449 Windows that must be updated have their must_be_update_p flag set.
2450 For all such windows, their desired matrix is made part of the
2451 desired frame matrix. For other windows, their current matrix is
2452 made part of the desired frame matrix.
2454 +-----------------+----------------+
2455 | desired | desired |
2457 +-----------------+----------------+
2460 +----------------------------------+
2462 Desired window matrices can be made part of the frame matrix in a
2463 cheap way: We exploit the fact that the desired frame matrix and
2464 desired window matrices share their glyph memory. This is not
2465 possible for current window matrices. Their glyphs are copied to
2466 the desired frame matrix. The latter is equivalent to
2467 preserve_other_columns in the old redisplay.
2469 Used glyphs counters for frame matrix rows are the result of adding
2470 up glyph lengths of the window matrices. A line in the frame
2471 matrix is enabled, if a corresponding line in a window matrix is
2474 After building the desired frame matrix, it will be passed to
2475 terminal code, which will manipulate both the desired and current
2476 frame matrix. Changes applied to the frame's current matrix have
2477 to be visible in current window matrices afterwards, of course.
2479 This problem is solved like this:
2481 1. Window and frame matrices share glyphs. Window matrices are
2482 constructed in a way that their glyph contents ARE the glyph
2483 contents needed in a frame matrix. Thus, any modification of
2484 glyphs done in terminal code will be reflected in window matrices
2487 2. Exchanges of rows in a frame matrix done by terminal code are
2488 intercepted by hook functions so that corresponding row operations
2489 on window matrices can be performed. This is necessary because we
2490 use pointers to glyphs in glyph row structures. To satisfy the
2491 assumption of point 1 above that glyphs are updated implicitly in
2492 window matrices when they are manipulated via the frame matrix,
2493 window and frame matrix must of course agree where to find the
2494 glyphs for their rows. Possible manipulations that must be
2495 mirrored are assignments of rows of the desired frame matrix to the
2496 current frame matrix and scrolling the current frame matrix. */
2498 /* Build frame F's desired matrix from window matrices. Only windows
2499 which have the flag must_be_updated_p set have to be updated. Menu
2500 bar lines of a frame are not covered by window matrices, so make
2501 sure not to touch them in this function. */
2504 build_frame_matrix (struct frame
*f
)
2508 /* F must have a frame matrix when this function is called. */
2509 xassert (!FRAME_WINDOW_P (f
));
2511 /* Clear all rows in the frame matrix covered by window matrices.
2512 Menu bar lines are not covered by windows. */
2513 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2514 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2516 /* Build the matrix by walking the window tree. */
2517 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2518 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2522 /* Walk a window tree, building a frame matrix MATRIX from window
2523 matrices. W is the root of a window tree. */
2526 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2530 if (!NILP (w
->hchild
))
2531 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2532 else if (!NILP (w
->vchild
))
2533 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2535 build_frame_matrix_from_leaf_window (matrix
, w
);
2537 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2542 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2543 desired frame matrix built. W is a leaf window whose desired or
2544 current matrix is to be added to FRAME_MATRIX. W's flag
2545 must_be_updated_p determines which matrix it contributes to
2546 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2547 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2548 Adding a desired matrix means setting up used counters and such in
2549 frame rows, while adding a current window matrix to FRAME_MATRIX
2550 means copying glyphs. The latter case corresponds to
2551 preserve_other_columns in the old redisplay. */
2554 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2556 struct glyph_matrix
*window_matrix
;
2557 int window_y
, frame_y
;
2558 /* If non-zero, a glyph to insert at the right border of W. */
2559 GLYPH right_border_glyph
;
2561 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2563 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2564 if (w
->must_be_updated_p
)
2566 window_matrix
= w
->desired_matrix
;
2568 /* Decide whether we want to add a vertical border glyph. */
2569 if (!WINDOW_RIGHTMOST_P (w
))
2571 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2574 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2576 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
))
2577 && GLYPH_CODE_CHAR_VALID_P (gc
))
2579 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2580 spec_glyph_lookup_face (w
, &right_border_glyph
);
2583 if (GLYPH_FACE (right_border_glyph
) <= 0)
2584 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2588 window_matrix
= w
->current_matrix
;
2590 /* For all rows in the window matrix and corresponding rows in the
2593 frame_y
= window_matrix
->matrix_y
;
2594 while (window_y
< window_matrix
->nrows
)
2596 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2597 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2598 int current_row_p
= window_matrix
== w
->current_matrix
;
2600 /* Fill up the frame row with spaces up to the left margin of the
2602 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2604 /* Fill up areas in the window matrix row with spaces. */
2605 fill_up_glyph_row_with_spaces (window_row
);
2607 /* If only part of W's desired matrix has been built, and
2608 window_row wasn't displayed, use the corresponding current
2610 if (window_matrix
== w
->desired_matrix
2611 && !window_row
->enabled_p
)
2613 window_row
= w
->current_matrix
->rows
+ window_y
;
2619 /* Copy window row to frame row. */
2620 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2621 window_row
->glyphs
[0],
2622 window_matrix
->matrix_w
* sizeof (struct glyph
));
2626 xassert (window_row
->enabled_p
);
2628 /* Only when a desired row has been displayed, we want
2629 the corresponding frame row to be updated. */
2630 frame_row
->enabled_p
= 1;
2632 /* Maybe insert a vertical border between horizontally adjacent
2634 if (GLYPH_CHAR (right_border_glyph
) != 0)
2636 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2637 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2641 /* Window row window_y must be a slice of frame row
2643 xassert (glyph_row_slice_p (window_row
, frame_row
));
2645 /* If rows are in sync, we don't have to copy glyphs because
2646 frame and window share glyphs. */
2648 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2649 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2653 /* Set number of used glyphs in the frame matrix. Since we fill
2654 up with spaces, and visit leaf windows from left to right it
2655 can be done simply. */
2656 frame_row
->used
[TEXT_AREA
]
2657 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2665 /* Given a user-specified glyph, possibly including a Lisp-level face
2666 ID, return a glyph that has a realized face ID.
2667 This is used for glyphs displayed specially and not part of the text;
2668 for instance, vertical separators, truncation markers, etc. */
2671 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2673 int lface_id
= GLYPH_FACE (*glyph
);
2674 /* Convert the glyph's specified face to a realized (cache) face. */
2677 int face_id
= merge_faces (XFRAME (w
->frame
),
2678 Qt
, lface_id
, DEFAULT_FACE_ID
);
2679 SET_GLYPH_FACE (*glyph
, face_id
);
2683 /* Add spaces to a glyph row ROW in a window matrix.
2685 Each row has the form:
2687 +---------+-----------------------------+------------+
2688 | left | text | right |
2689 +---------+-----------------------------+------------+
2691 Left and right marginal areas are optional. This function adds
2692 spaces to areas so that there are no empty holes between areas.
2693 In other words: If the right area is not empty, the text area
2694 is filled up with spaces up to the right area. If the text area
2695 is not empty, the left area is filled up.
2697 To be called for frame-based redisplay, only. */
2700 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2702 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2703 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2704 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2708 /* Fill area AREA of glyph row ROW with spaces. To be called for
2709 frame-based redisplay only. */
2712 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2714 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2716 struct glyph
*end
= row
->glyphs
[area
+ 1];
2717 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2720 *text
++ = space_glyph
;
2721 row
->used
[area
] = text
- row
->glyphs
[area
];
2726 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2727 reached. In frame matrices only one area, TEXT_AREA, is used. */
2730 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2732 int i
= row
->used
[TEXT_AREA
];
2733 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2736 glyph
[i
++] = space_glyph
;
2738 row
->used
[TEXT_AREA
] = i
;
2743 /**********************************************************************
2744 Mirroring operations on frame matrices in window matrices
2745 **********************************************************************/
2747 /* Set frame being updated via frame-based redisplay to F. This
2748 function must be called before updates to make explicit that we are
2749 working on frame matrices or not. */
2752 set_frame_matrix_frame (struct frame
*f
)
2754 frame_matrix_frame
= f
;
2758 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2759 DESIRED_MATRIX is the desired matrix corresponding to
2760 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2761 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2762 frame_matrix_frame is non-null, this indicates that the exchange is
2763 done in frame matrices, and that we have to perform analogous
2764 operations in window matrices of frame_matrix_frame. */
2767 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2769 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2770 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2771 int mouse_face_p
= current_row
->mouse_face_p
;
2773 /* Do current_row = desired_row. This exchanges glyph pointers
2774 between both rows, and does a structure assignment otherwise. */
2775 assign_row (current_row
, desired_row
);
2777 /* Enable current_row to mark it as valid. */
2778 current_row
->enabled_p
= 1;
2779 current_row
->mouse_face_p
= mouse_face_p
;
2781 /* If we are called on frame matrices, perform analogous operations
2782 for window matrices. */
2783 if (frame_matrix_frame
)
2784 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2788 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2789 W's frame which has been made current (by swapping pointers between
2790 current and desired matrix). Perform analogous operations in the
2791 matrices of leaf windows in the window tree rooted at W. */
2794 mirror_make_current (struct window
*w
, int frame_row
)
2798 if (!NILP (w
->hchild
))
2799 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2800 else if (!NILP (w
->vchild
))
2801 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2804 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2805 here because the checks performed in debug mode there
2806 will not allow the conversion. */
2807 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2809 /* If FRAME_ROW is within W, assign the desired row to the
2810 current row (exchanging glyph pointers). */
2811 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2813 struct glyph_row
*current_row
2814 = MATRIX_ROW (w
->current_matrix
, row
);
2815 struct glyph_row
*desired_row
2816 = MATRIX_ROW (w
->desired_matrix
, row
);
2818 if (desired_row
->enabled_p
)
2819 assign_row (current_row
, desired_row
);
2821 swap_glyph_pointers (desired_row
, current_row
);
2822 current_row
->enabled_p
= 1;
2824 /* Set the Y coordinate of the mode/header line's row.
2825 It is needed in draw_row_with_mouse_face to find the
2826 screen coordinates. (Window-based redisplay sets
2827 this in update_window, but no one seems to do that
2828 for frame-based redisplay.) */
2829 if (current_row
->mode_line_p
)
2830 current_row
->y
= row
;
2834 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2839 /* Perform row dance after scrolling. We are working on the range of
2840 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2841 including) in MATRIX. COPY_FROM is a vector containing, for each
2842 row I in the range 0 <= I < NLINES, the index of the original line
2843 to move to I. This index is relative to the row range, i.e. 0 <=
2844 index < NLINES. RETAINED_P is a vector containing zero for each
2845 row 0 <= I < NLINES which is empty.
2847 This function is called from do_scrolling and do_direct_scrolling. */
2850 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2851 int *copy_from
, char *retained_p
)
2853 /* A copy of original rows. */
2854 struct glyph_row
*old_rows
;
2856 /* Rows to assign to. */
2857 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2861 /* Make a copy of the original rows. */
2862 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2863 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2865 /* Assign new rows, maybe clear lines. */
2866 for (i
= 0; i
< nlines
; ++i
)
2868 int enabled_before_p
= new_rows
[i
].enabled_p
;
2870 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2871 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2872 new_rows
[i
] = old_rows
[copy_from
[i
]];
2873 new_rows
[i
].enabled_p
= enabled_before_p
;
2875 /* RETAINED_P is zero for empty lines. */
2876 if (!retained_p
[copy_from
[i
]])
2877 new_rows
[i
].enabled_p
= 0;
2880 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2881 if (frame_matrix_frame
)
2882 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2883 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2887 /* Synchronize glyph pointers in the current matrix of window W with
2888 the current frame matrix. */
2891 sync_window_with_frame_matrix_rows (struct window
*w
)
2893 struct frame
*f
= XFRAME (w
->frame
);
2894 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2895 int left
, right
, x
, width
;
2897 /* Preconditions: W must be a leaf window on a tty frame. */
2898 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2899 xassert (!FRAME_WINDOW_P (f
));
2901 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2902 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2903 x
= w
->current_matrix
->matrix_x
;
2904 width
= w
->current_matrix
->matrix_w
;
2906 window_row
= w
->current_matrix
->rows
;
2907 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2908 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2910 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2912 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2913 = frame_row
->glyphs
[0] + x
;
2914 window_row
->glyphs
[TEXT_AREA
]
2915 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2916 window_row
->glyphs
[LAST_AREA
]
2917 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2918 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2919 = window_row
->glyphs
[LAST_AREA
] - right
;
2924 /* Return the window in the window tree rooted in W containing frame
2925 row ROW. Value is null if none is found. */
2928 frame_row_to_window (struct window
*w
, int row
)
2930 struct window
*found
= NULL
;
2934 if (!NILP (w
->hchild
))
2935 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2936 else if (!NILP (w
->vchild
))
2937 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2938 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2939 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2942 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2949 /* Perform a line dance in the window tree rooted at W, after
2950 scrolling a frame matrix in mirrored_line_dance.
2952 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2953 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2954 COPY_FROM is a vector containing, for each row I in the range 0 <=
2955 I < NLINES, the index of the original line to move to I. This
2956 index is relative to the row range, i.e. 0 <= index < NLINES.
2957 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2961 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2965 if (!NILP (w
->hchild
))
2966 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2967 nlines
, copy_from
, retained_p
);
2968 else if (!NILP (w
->vchild
))
2969 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2970 nlines
, copy_from
, retained_p
);
2973 /* W is a leaf window, and we are working on its current
2975 struct glyph_matrix
*m
= w
->current_matrix
;
2977 struct glyph_row
*old_rows
;
2979 /* Make a copy of the original rows of matrix m. */
2980 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2981 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2983 for (i
= 0; i
< nlines
; ++i
)
2985 /* Frame relative line assigned to. */
2986 int frame_to
= i
+ unchanged_at_top
;
2988 /* Frame relative line assigned. */
2989 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2991 /* Window relative line assigned to. */
2992 int window_to
= frame_to
- m
->matrix_y
;
2994 /* Window relative line assigned. */
2995 int window_from
= frame_from
- m
->matrix_y
;
2997 /* Is assigned line inside window? */
2998 int from_inside_window_p
2999 = window_from
>= 0 && window_from
< m
->matrix_h
;
3001 /* Is assigned to line inside window? */
3002 int to_inside_window_p
3003 = window_to
>= 0 && window_to
< m
->matrix_h
;
3005 if (from_inside_window_p
&& to_inside_window_p
)
3007 /* Enabled setting before assignment. */
3008 int enabled_before_p
;
3010 /* Do the assignment. The enabled_p flag is saved
3011 over the assignment because the old redisplay did
3013 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
3014 m
->rows
[window_to
] = old_rows
[window_from
];
3015 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
3017 /* If frame line is empty, window line is empty, too. */
3018 if (!retained_p
[copy_from
[i
]])
3019 m
->rows
[window_to
].enabled_p
= 0;
3021 else if (to_inside_window_p
)
3023 /* A copy between windows. This is an infrequent
3024 case not worth optimizing. */
3025 struct frame
*f
= XFRAME (w
->frame
);
3026 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3028 struct glyph_matrix
*m2
;
3031 w2
= frame_row_to_window (root
, frame_from
);
3032 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3033 -nw', FROM_FRAME sometimes has no associated window.
3034 This check avoids a segfault if W2 is null. */
3037 m2
= w2
->current_matrix
;
3038 m2_from
= frame_from
- m2
->matrix_y
;
3039 copy_row_except_pointers (m
->rows
+ window_to
,
3040 m2
->rows
+ m2_from
);
3042 /* If frame line is empty, window line is empty, too. */
3043 if (!retained_p
[copy_from
[i
]])
3044 m
->rows
[window_to
].enabled_p
= 0;
3048 else if (from_inside_window_p
)
3052 /* If there was a copy between windows, make sure glyph
3053 pointers are in sync with the frame matrix. */
3055 sync_window_with_frame_matrix_rows (w
);
3057 /* Check that no pointers are lost. */
3061 /* Next window on same level. */
3062 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3069 /* Check that window and frame matrices agree about their
3070 understanding where glyphs of the rows are to find. For each
3071 window in the window tree rooted at W, check that rows in the
3072 matrices of leaf window agree with their frame matrices about
3076 check_window_matrix_pointers (struct window
*w
)
3080 if (!NILP (w
->hchild
))
3081 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3082 else if (!NILP (w
->vchild
))
3083 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3086 struct frame
*f
= XFRAME (w
->frame
);
3087 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3088 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3091 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3096 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3097 a window and FRAME_MATRIX is the corresponding frame matrix. For
3098 each row in WINDOW_MATRIX check that it's a slice of the
3099 corresponding frame row. If it isn't, abort. */
3102 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3103 struct glyph_matrix
*frame_matrix
)
3105 /* Row number in WINDOW_MATRIX. */
3108 /* Row number corresponding to I in FRAME_MATRIX. */
3109 int j
= window_matrix
->matrix_y
;
3111 /* For all rows check that the row in the window matrix is a
3112 slice of the row in the frame matrix. If it isn't we didn't
3113 mirror an operation on the frame matrix correctly. */
3114 while (i
< window_matrix
->nrows
)
3116 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3117 frame_matrix
->rows
+ j
))
3123 #endif /* GLYPH_DEBUG != 0 */
3127 /**********************************************************************
3128 VPOS and HPOS translations
3129 **********************************************************************/
3133 /* Translate vertical position VPOS which is relative to window W to a
3134 vertical position relative to W's frame. */
3137 window_to_frame_vpos (struct window
*w
, int vpos
)
3139 struct frame
*f
= XFRAME (w
->frame
);
3141 xassert (!FRAME_WINDOW_P (f
));
3142 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3143 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3144 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (f
));
3149 /* Translate horizontal position HPOS which is relative to window W to
3150 a horizontal position relative to W's frame. */
3153 window_to_frame_hpos (struct window
*w
, int hpos
)
3155 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3156 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3160 #endif /* GLYPH_DEBUG */
3164 /**********************************************************************
3166 **********************************************************************/
3168 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3169 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3174 CHECK_LIVE_FRAME (frame
);
3177 /* Ignore redraw requests, if frame has no glyphs yet.
3178 (Implementation note: It still has to be checked why we are
3179 called so early here). */
3180 if (!glyphs_initialized_initially_p
)
3185 if (FRAME_MSDOS_P (f
))
3186 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3189 clear_current_matrices (f
);
3191 if (FRAME_TERMCAP_P (f
))
3192 fflush (FRAME_TTY (f
)->output
);
3193 windows_or_buffers_changed
++;
3194 /* Mark all windows as inaccurate, so that every window will have
3195 its redisplay done. */
3196 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3197 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3203 /* Redraw frame F. This is nothing more than a call to the Lisp
3204 function redraw-frame. */
3207 redraw_frame (struct frame
*f
)
3210 XSETFRAME (frame
, f
);
3211 Fredraw_frame (frame
);
3215 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3216 doc
: /* Clear and redisplay all visible frames. */)
3219 Lisp_Object tail
, frame
;
3221 FOR_EACH_FRAME (tail
, frame
)
3222 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3223 Fredraw_frame (frame
);
3229 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3230 visible frames marked as garbaged. */
3233 redraw_garbaged_frames (void)
3235 Lisp_Object tail
, frame
;
3237 FOR_EACH_FRAME (tail
, frame
)
3238 if (FRAME_VISIBLE_P (XFRAME (frame
))
3239 && FRAME_GARBAGED_P (XFRAME (frame
)))
3240 Fredraw_frame (frame
);
3245 /***********************************************************************
3247 ***********************************************************************/
3249 /* Update frame F based on the data in desired matrices.
3251 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3252 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3255 Value is non-zero if redisplay was stopped due to pending input. */
3258 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3260 /* 1 means display has been paused because of pending input. */
3262 struct window
*root_window
= XWINDOW (f
->root_window
);
3264 if (redisplay_dont_pause
)
3266 #if PERIODIC_PREEMPTION_CHECKING
3267 else if (NILP (Vredisplay_preemption_period
))
3269 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3272 double p
= XFLOATINT (Vredisplay_preemption_period
);
3275 if (detect_input_pending_ignore_squeezables ())
3282 usec
= (p
- sec
) * 1000000;
3284 EMACS_GET_TIME (tm
);
3285 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3286 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3290 if (FRAME_WINDOW_P (f
))
3292 /* We are working on window matrix basis. All windows whose
3293 flag must_be_updated_p is set have to be updated. */
3295 /* Record that we are not working on frame matrices. */
3296 set_frame_matrix_frame (NULL
);
3298 /* Update all windows in the window tree of F, maybe stopping
3299 when pending input is detected. */
3302 /* Update the menu bar on X frames that don't have toolkit
3304 if (WINDOWP (f
->menu_bar_window
))
3305 update_window (XWINDOW (f
->menu_bar_window
), 1);
3307 /* Update the tool-bar window, if present. */
3308 if (WINDOWP (f
->tool_bar_window
))
3310 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3312 /* Update tool-bar window. */
3313 if (w
->must_be_updated_p
)
3317 update_window (w
, 1);
3318 w
->must_be_updated_p
= 0;
3320 /* Swap tool-bar strings. We swap because we want to
3322 tem
= f
->current_tool_bar_string
;
3323 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3324 f
->desired_tool_bar_string
= tem
;
3329 /* Update windows. */
3330 paused_p
= update_window_tree (root_window
, force_p
);
3333 /* This flush is a performance bottleneck under X,
3334 and it doesn't seem to be necessary anyway (in general).
3335 It is necessary when resizing the window with the mouse, or
3336 at least the fringes are not redrawn in a timely manner. ++kfs */
3337 if (f
->force_flush_display_p
)
3339 FRAME_RIF (f
)->flush_display (f
);
3340 f
->force_flush_display_p
= 0;
3345 /* We are working on frame matrix basis. Set the frame on whose
3346 frame matrix we operate. */
3347 set_frame_matrix_frame (f
);
3349 /* Build F's desired matrix from window matrices. */
3350 build_frame_matrix (f
);
3352 /* Update the display */
3354 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3357 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3359 if (FRAME_TTY (f
)->termscript
)
3360 fflush (FRAME_TTY (f
)->termscript
);
3361 if (FRAME_TERMCAP_P (f
))
3362 fflush (FRAME_TTY (f
)->output
);
3365 /* Check window matrices for lost pointers. */
3367 check_window_matrix_pointers (root_window
);
3368 add_frame_display_history (f
, paused_p
);
3372 #if PERIODIC_PREEMPTION_CHECKING
3375 /* Reset flags indicating that a window should be updated. */
3376 set_window_update_flags (root_window
, 0);
3378 display_completed
= !paused_p
;
3384 /************************************************************************
3385 Window-based updates
3386 ************************************************************************/
3388 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3389 don't stop updating when input is pending. */
3392 update_window_tree (struct window
*w
, int force_p
)
3396 while (w
&& !paused_p
)
3398 if (!NILP (w
->hchild
))
3399 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3400 else if (!NILP (w
->vchild
))
3401 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3402 else if (w
->must_be_updated_p
)
3403 paused_p
|= update_window (w
, force_p
);
3405 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3412 /* Update window W if its flag must_be_updated_p is non-zero. If
3413 FORCE_P is non-zero, don't stop updating if input is pending. */
3416 update_single_window (struct window
*w
, int force_p
)
3418 if (w
->must_be_updated_p
)
3420 printf("window %d must be updated\n");
3421 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3423 /* Record that this is not a frame-based redisplay. */
3424 set_frame_matrix_frame (NULL
);
3426 if (redisplay_dont_pause
)
3428 #if PERIODIC_PREEMPTION_CHECKING
3429 else if (NILP (Vredisplay_preemption_period
))
3431 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3434 double p
= XFLOATINT (Vredisplay_preemption_period
);
3438 usec
= (p
- sec
) * 1000000;
3440 EMACS_GET_TIME (tm
);
3441 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3442 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3448 update_window (w
, force_p
);
3451 /* Reset flag in W. */
3452 w
->must_be_updated_p
= 0;
3456 #ifdef HAVE_WINDOW_SYSTEM
3458 /* Redraw lines from the current matrix of window W that are
3459 overlapped by other rows. YB is bottom-most y-position in W. */
3462 redraw_overlapped_rows (struct window
*w
, int yb
)
3465 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3467 /* If rows overlapping others have been changed, the rows being
3468 overlapped have to be redrawn. This won't draw lines that have
3469 already been drawn in update_window_line because overlapped_p in
3470 desired rows is 0, so after row assignment overlapped_p in
3471 current rows is 0. */
3472 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3474 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3476 if (!row
->enabled_p
)
3478 else if (row
->mode_line_p
)
3481 if (row
->overlapped_p
)
3483 enum glyph_row_area area
;
3485 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3488 updated_area
= area
;
3489 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3490 area
== TEXT_AREA
? row
->x
: 0);
3491 if (row
->used
[area
])
3492 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3494 FRAME_RIF (f
)->clear_end_of_line (-1);
3497 row
->overlapped_p
= 0;
3500 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3506 /* Redraw lines from the current matrix of window W that overlap
3507 others. YB is bottom-most y-position in W. */
3510 redraw_overlapping_rows (struct window
*w
, int yb
)
3513 struct glyph_row
*row
;
3514 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3516 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3518 row
= w
->current_matrix
->rows
+ i
;
3520 if (!row
->enabled_p
)
3522 else if (row
->mode_line_p
)
3525 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3527 if (row
->overlapping_p
)
3531 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3532 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3533 overlaps
|= OVERLAPS_PRED
;
3534 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3535 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3536 overlaps
|= OVERLAPS_SUCC
;
3540 if (row
->used
[LEFT_MARGIN_AREA
])
3541 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3543 if (row
->used
[TEXT_AREA
])
3544 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3546 if (row
->used
[RIGHT_MARGIN_AREA
])
3547 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3549 /* Record in neighbour rows that ROW overwrites part of
3551 if (overlaps
& OVERLAPS_PRED
)
3552 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3553 if (overlaps
& OVERLAPS_SUCC
)
3554 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3563 #endif /* HAVE_WINDOW_SYSTEM */
3568 /* Check that no row in the current matrix of window W is enabled
3569 which is below what's displayed in the window. */
3572 check_current_matrix_flags (struct window
*w
)
3574 int last_seen_p
= 0;
3575 int i
, yb
= window_text_bottom_y (w
);
3577 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3579 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3580 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3582 else if (last_seen_p
&& row
->enabled_p
)
3587 #endif /* GLYPH_DEBUG */
3590 /* Update display of window W. FORCE_P non-zero means that we should
3591 not stop when detecting pending input. */
3594 update_window (struct window
*w
, int force_p
)
3596 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3598 #if !PERIODIC_PREEMPTION_CHECKING
3599 int preempt_count
= baud_rate
/ 2400 + 1;
3601 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3603 /* Check that W's frame doesn't have glyph matrices. */
3604 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3607 /* Check pending input the first time so that we can quickly return. */
3608 #if !PERIODIC_PREEMPTION_CHECKING
3610 detect_input_pending_ignore_squeezables ();
3613 /* If forced to complete the update, or if no input is pending, do
3615 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3617 struct glyph_row
*row
, *end
;
3618 struct glyph_row
*mode_line_row
;
3619 struct glyph_row
*header_line_row
;
3620 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0, n_updated
;
3622 rif
->update_window_begin_hook (w
);
3623 yb
= window_text_bottom_y (w
);
3625 /* If window has a header line, update it before everything else.
3626 Adjust y-positions of other rows by the header line height. */
3627 row
= desired_matrix
->rows
;
3628 end
= row
+ desired_matrix
->nrows
- 1;
3630 if (row
->mode_line_p
)
3632 header_line_row
= row
;
3636 header_line_row
= NULL
;
3638 /* Update the mode line, if necessary. */
3639 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3640 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3642 mode_line_row
->y
= yb
;
3643 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3645 &mouse_face_overwritten_p
);
3648 /* Find first enabled row. Optimizations in redisplay_internal
3649 may lead to an update with only one row enabled. There may
3650 be also completely empty matrices. */
3651 while (row
< end
&& !row
->enabled_p
)
3654 /* Try reusing part of the display by copying. */
3655 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3657 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3660 /* All rows were found to be equal. */
3666 /* We've scrolled the display. */
3672 /* Update the rest of the lines. */
3673 for (n_updated
= 0; row
< end
&& (force_p
|| !input_pending
); ++row
)
3676 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3679 /* We'll have to play a little bit with when to
3680 detect_input_pending. If it's done too often,
3681 scrolling large windows with repeated scroll-up
3682 commands will too quickly pause redisplay. */
3683 #if PERIODIC_PREEMPTION_CHECKING
3687 EMACS_GET_TIME (tm
);
3688 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3689 if (EMACS_TIME_NEG_P (dif
))
3691 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3692 if (detect_input_pending_ignore_squeezables ())
3697 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3698 detect_input_pending_ignore_squeezables ();
3700 changed_p
|= update_window_line (w
, vpos
,
3701 &mouse_face_overwritten_p
);
3703 /* Mark all rows below the last visible one in the current
3704 matrix as invalid. This is necessary because of
3705 variable line heights. Consider the case of three
3706 successive redisplays, where the first displays 5
3707 lines, the second 3 lines, and the third 5 lines again.
3708 If the second redisplay wouldn't mark rows in the
3709 current matrix invalid, the third redisplay might be
3710 tempted to optimize redisplay based on lines displayed
3711 in the first redisplay. */
3712 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3713 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3714 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3717 /* Was display preempted? */
3718 paused_p
= row
< end
;
3722 /* Update the header line after scrolling because a new header
3723 line would otherwise overwrite lines at the top of the window
3724 that can be scrolled. */
3725 if (header_line_row
&& header_line_row
->enabled_p
)
3727 header_line_row
->y
= 0;
3728 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3731 /* Fix the appearance of overlapping/overlapped rows. */
3732 if (!paused_p
&& !w
->pseudo_window_p
)
3734 #ifdef HAVE_WINDOW_SYSTEM
3735 if (changed_p
&& rif
->fix_overlapping_area
)
3737 redraw_overlapped_rows (w
, yb
);
3738 redraw_overlapping_rows (w
, yb
);
3742 /* Make cursor visible at cursor position of W. */
3743 set_window_cursor_after_update (w
);
3745 #if 0 /* Check that current matrix invariants are satisfied. This is
3746 for debugging only. See the comment of check_matrix_invariants. */
3747 IF_DEBUG (check_matrix_invariants (w
));
3752 /* Remember the redisplay method used to display the matrix. */
3753 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3756 #ifdef HAVE_WINDOW_SYSTEM
3757 update_window_fringes (w
, 0);
3760 /* End the update of window W. Don't set the cursor if we
3761 paused updating the display because in this case,
3762 set_window_cursor_after_update hasn't been called, and
3763 output_cursor doesn't contain the cursor location. */
3764 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3770 /* check_current_matrix_flags (w); */
3771 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3775 if ((XWINDOW(FRAME_SELECTED_WINDOW (SELECTED_FRAME()))) == (w
))
3776 xwidget_end_redisplay(w
->current_matrix
);
3778 clear_glyph_matrix (desired_matrix
);
3784 /* Update the display of area AREA in window W, row number VPOS.
3785 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3788 update_marginal_area (struct window
*w
, int area
, int vpos
)
3790 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3791 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3793 /* Let functions in xterm.c know what area subsequent X positions
3794 will be relative to. */
3795 updated_area
= area
;
3797 /* Set cursor to start of glyphs, write them, and clear to the end
3798 of the area. I don't think that something more sophisticated is
3799 necessary here, since marginal areas will not be the default. */
3800 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3801 if (desired_row
->used
[area
])
3802 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3803 rif
->clear_end_of_line (-1);
3807 /* Update the display of the text area of row VPOS in window W.
3808 Value is non-zero if display has changed. */
3811 update_text_area (struct window
*w
, int vpos
)
3813 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3814 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3815 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3818 /* Let functions in xterm.c know what area subsequent X positions
3819 will be relative to. */
3820 updated_area
= TEXT_AREA
;
3822 /* If rows are at different X or Y, or rows have different height,
3823 or the current row is marked invalid, write the entire line. */
3824 if (!current_row
->enabled_p
3825 || desired_row
->y
!= current_row
->y
3826 || desired_row
->ascent
!= current_row
->ascent
3827 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3828 || desired_row
->phys_height
!= current_row
->phys_height
3829 || desired_row
->visible_height
!= current_row
->visible_height
3830 || current_row
->overlapped_p
3831 /* This next line is necessary for correctly redrawing
3832 mouse-face areas after scrolling and other operations.
3833 However, it causes excessive flickering when mouse is moved
3834 across the mode line. Luckily, turning it off for the mode
3835 line doesn't seem to hurt anything. -- cyd.
3836 But it is still needed for the header line. -- kfs. */
3837 || (current_row
->mouse_face_p
3838 && !(current_row
->mode_line_p
&& vpos
> 0))
3839 || current_row
->x
!= desired_row
->x
)
3841 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3843 if (desired_row
->used
[TEXT_AREA
])
3844 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3845 desired_row
->used
[TEXT_AREA
]);
3847 /* Clear to end of window. */
3848 rif
->clear_end_of_line (-1);
3851 /* This erases the cursor. We do this here because
3852 notice_overwritten_cursor cannot easily check this, which
3853 might indicate that the whole functionality of
3854 notice_overwritten_cursor would better be implemented here.
3855 On the other hand, we need notice_overwritten_cursor as long
3856 as mouse highlighting is done asynchronously outside of
3858 if (vpos
== w
->phys_cursor
.vpos
)
3859 w
->phys_cursor_on_p
= 0;
3864 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3865 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3866 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3867 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3868 int abort_skipping
= 0;
3870 /* If the desired row extends its face to the text area end, and
3871 unless the current row also does so at the same position,
3872 make sure we write at least one glyph, so that the face
3873 extension actually takes place. */
3874 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3875 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3876 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3877 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3880 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3884 /* Loop over glyphs that current and desired row may have
3888 int can_skip_p
= !abort_skipping
;
3890 /* Skip over glyphs that both rows have in common. These
3891 don't have to be written. We can't skip if the last
3892 current glyph overlaps the glyph to its right. For
3893 example, consider a current row of `if ' with the `f' in
3894 Courier bold so that it overlaps the ` ' to its right.
3895 If the desired row is ` ', we would skip over the space
3896 after the `if' and there would remain a pixel from the
3897 `f' on the screen. */
3898 if (overlapping_glyphs_p
&& i
> 0)
3900 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3903 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3905 can_skip_p
= (right
== 0 && !abort_skipping
);
3913 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3915 x
+= desired_glyph
->pixel_width
;
3916 ++desired_glyph
, ++current_glyph
, ++i
;
3919 /* Consider the case that the current row contains "xxx
3920 ppp ggg" in italic Courier font, and the desired row
3921 is "xxx ggg". The character `p' has lbearing, `g'
3922 has not. The loop above will stop in front of the
3923 first `p' in the current row. If we would start
3924 writing glyphs there, we wouldn't erase the lbearing
3925 of the `p'. The rest of the lbearing problem is then
3926 taken care of by draw_glyphs. */
3927 if (overlapping_glyphs_p
3929 && i
< current_row
->used
[TEXT_AREA
]
3930 && (current_row
->used
[TEXT_AREA
]
3931 != desired_row
->used
[TEXT_AREA
]))
3935 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3937 while (left
> 0 && i
> 0)
3939 --i
, --desired_glyph
, --current_glyph
;
3940 x
-= desired_glyph
->pixel_width
;
3941 left
-= desired_glyph
->pixel_width
;
3944 /* Abort the skipping algorithm if we end up before
3945 our starting point, to avoid looping (bug#1070).
3946 This can happen when the lbearing is larger than
3948 abort_skipping
= (i
< start_hpos
);
3952 /* Try to avoid writing the entire rest of the desired row
3953 by looking for a resync point. This mainly prevents
3954 mode line flickering in the case the mode line is in
3955 fixed-pitch font, which it usually will be. */
3956 if (i
< desired_row
->used
[TEXT_AREA
])
3958 int start_x
= x
, start_hpos
= i
;
3959 struct glyph
*start
= desired_glyph
;
3961 int skip_first_p
= !can_skip_p
;
3963 /* Find the next glyph that's equal again. */
3966 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3969 x
+= desired_glyph
->pixel_width
;
3970 current_x
+= current_glyph
->pixel_width
;
3971 ++desired_glyph
, ++current_glyph
, ++i
;
3975 if (i
== start_hpos
|| x
!= current_x
)
3979 desired_glyph
= start
;
3983 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3984 rif
->write_glyphs (start
, i
- start_hpos
);
3989 /* Write the rest. */
3990 if (i
< desired_row
->used
[TEXT_AREA
])
3992 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3993 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3997 /* Maybe clear to end of line. */
3998 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
4000 /* If new row extends to the end of the text area, nothing
4001 has to be cleared, if and only if we did a write_glyphs
4002 above. This is made sure by setting desired_stop_pos
4003 appropriately above. */
4004 xassert (i
< desired_row
->used
[TEXT_AREA
]
4005 || ((desired_row
->used
[TEXT_AREA
]
4006 == current_row
->used
[TEXT_AREA
])
4007 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
4009 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
4011 /* If old row extends to the end of the text area, clear. */
4012 if (i
>= desired_row
->used
[TEXT_AREA
])
4013 rif
->cursor_to (vpos
, i
, desired_row
->y
,
4014 desired_row
->pixel_width
);
4015 rif
->clear_end_of_line (-1);
4018 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
4020 /* Otherwise clear to the end of the old row. Everything
4021 after that position should be clear already. */
4024 if (i
>= desired_row
->used
[TEXT_AREA
])
4025 rif
->cursor_to (vpos
, i
, desired_row
->y
,
4026 desired_row
->pixel_width
);
4028 /* If cursor is displayed at the end of the line, make sure
4029 it's cleared. Nowadays we don't have a phys_cursor_glyph
4030 with which to erase the cursor (because this method
4031 doesn't work with lbearing/rbearing), so we must do it
4033 if (vpos
== w
->phys_cursor
.vpos
4034 && (desired_row
->reversed_p
4035 ? (w
->phys_cursor
.hpos
< 0)
4036 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
4038 w
->phys_cursor_on_p
= 0;
4042 x
= current_row
->pixel_width
;
4043 rif
->clear_end_of_line (x
);
4052 /* Update row VPOS in window W. Value is non-zero if display has been
4056 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
4058 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
4059 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
4060 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4063 /* Set the row being updated. This is important to let xterm.c
4064 know what line height values are in effect. */
4065 updated_row
= desired_row
;
4067 /* A row can be completely invisible in case a desired matrix was
4068 built with a vscroll and then make_cursor_line_fully_visible shifts
4069 the matrix. Make sure to make such rows current anyway, since
4070 we need the correct y-position, for example, in the current matrix. */
4071 if (desired_row
->mode_line_p
4072 || desired_row
->visible_height
> 0)
4074 xassert (desired_row
->enabled_p
);
4076 /* Update display of the left margin area, if there is one. */
4077 if (!desired_row
->full_width_p
4078 && !NILP (w
->left_margin_cols
))
4081 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4084 /* Update the display of the text area. */
4085 if (update_text_area (w
, vpos
))
4088 if (current_row
->mouse_face_p
)
4089 *mouse_face_overwritten_p
= 1;
4092 /* Update display of the right margin area, if there is one. */
4093 if (!desired_row
->full_width_p
4094 && !NILP (w
->right_margin_cols
))
4097 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4100 /* Draw truncation marks etc. */
4101 if (!current_row
->enabled_p
4102 || desired_row
->y
!= current_row
->y
4103 || desired_row
->visible_height
!= current_row
->visible_height
4104 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4105 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4106 || current_row
->redraw_fringe_bitmaps_p
4107 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4108 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4109 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4110 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4111 rif
->after_update_window_line_hook (desired_row
);
4114 /* Update current_row from desired_row. */
4115 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4121 /* Set the cursor after an update of window W. This function may only
4122 be called from update_window. */
4125 set_window_cursor_after_update (struct window
*w
)
4127 struct frame
*f
= XFRAME (w
->frame
);
4128 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4129 int cx
, cy
, vpos
, hpos
;
4131 /* Not intended for frame matrix updates. */
4132 xassert (FRAME_WINDOW_P (f
));
4134 if (cursor_in_echo_area
4135 && !NILP (echo_area_buffer
[0])
4136 /* If we are showing a message instead of the mini-buffer,
4137 show the cursor for the message instead. */
4138 && XWINDOW (minibuf_window
) == w
4139 && EQ (minibuf_window
, echo_area_window
)
4140 /* These cases apply only to the frame that contains
4141 the active mini-buffer window. */
4142 && FRAME_HAS_MINIBUF_P (f
)
4143 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4145 cx
= cy
= vpos
= hpos
= 0;
4147 if (cursor_in_echo_area
>= 0)
4149 /* If the mini-buffer is several lines high, find the last
4150 line that has any text on it. Note: either all lines
4151 are enabled or none. Otherwise we wouldn't be able to
4153 struct glyph_row
*row
, *last_row
;
4154 struct glyph
*glyph
;
4155 int yb
= window_text_bottom_y (w
);
4158 row
= w
->current_matrix
->rows
;
4159 while (row
->enabled_p
4160 && (last_row
== NULL
4161 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4163 if (row
->used
[TEXT_AREA
]
4164 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4171 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4172 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4174 while (last
> start
&& last
->charpos
< 0)
4177 for (glyph
= start
; glyph
< last
; ++glyph
)
4179 cx
+= glyph
->pixel_width
;
4184 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4192 hpos
= w
->cursor
.hpos
;
4193 vpos
= w
->cursor
.vpos
;
4196 /* Window cursor can be out of sync for horizontally split windows. */
4197 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4198 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4199 vpos
= max (0, vpos
);
4200 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4201 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4205 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4206 tree rooted at W. */
4209 set_window_update_flags (struct window
*w
, int on_p
)
4213 if (!NILP (w
->hchild
))
4214 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4215 else if (!NILP (w
->vchild
))
4216 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4218 w
->must_be_updated_p
= on_p
;
4220 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4226 /***********************************************************************
4227 Window-Based Scrolling
4228 ***********************************************************************/
4230 /* Structure describing rows in scrolling_window. */
4234 /* Number of occurrences of this row in desired and current matrix. */
4235 int old_uses
, new_uses
;
4237 /* Vpos of row in new matrix. */
4238 int new_line_number
;
4240 /* Bucket index of this row_entry in the hash table row_table. */
4243 /* The row described by this entry. */
4244 struct glyph_row
*row
;
4246 /* Hash collision chain. */
4247 struct row_entry
*next
;
4250 /* A pool to allocate row_entry structures from, and the size of the
4251 pool. The pool is reallocated in scrolling_window when we find
4252 that we need a larger one. */
4254 static struct row_entry
*row_entry_pool
;
4255 static int row_entry_pool_size
;
4257 /* Index of next free entry in row_entry_pool. */
4259 static int row_entry_idx
;
4261 /* The hash table used during scrolling, and the table's size. This
4262 table is used to quickly identify equal rows in the desired and
4265 static struct row_entry
**row_table
;
4266 static int row_table_size
;
4268 /* Vectors of pointers to row_entry structures belonging to the
4269 current and desired matrix, and the size of the vectors. */
4271 static struct row_entry
**old_lines
, **new_lines
;
4272 static int old_lines_size
, new_lines_size
;
4274 /* A pool to allocate run structures from, and its size. */
4276 static struct run
*run_pool
;
4277 static int runs_size
;
4279 /* A vector of runs of lines found during scrolling. */
4281 static struct run
**runs
;
4283 /* Add glyph row ROW to the scrolling hash table during the scrolling
4286 static INLINE
struct row_entry
*
4287 add_row_entry (struct window
*w
, struct glyph_row
*row
)
4289 struct row_entry
*entry
;
4290 int i
= row
->hash
% row_table_size
;
4292 entry
= row_table
[i
];
4293 while (entry
&& !row_equal_p (w
, entry
->row
, row
, 1))
4294 entry
= entry
->next
;
4298 entry
= row_entry_pool
+ row_entry_idx
++;
4300 entry
->old_uses
= entry
->new_uses
= 0;
4301 entry
->new_line_number
= 0;
4303 entry
->next
= row_table
[i
];
4304 row_table
[i
] = entry
;
4311 /* Try to reuse part of the current display of W by scrolling lines.
4312 HEADER_LINE_P non-zero means W has a header line.
4314 The algorithm is taken from Communications of the ACM, Apr78 "A
4315 Technique for Isolating Differences Between Files." It should take
4318 A short outline of the steps of the algorithm
4320 1. Skip lines equal at the start and end of both matrices.
4322 2. Enter rows in the current and desired matrix into a symbol
4323 table, counting how often they appear in both matrices.
4325 3. Rows that appear exactly once in both matrices serve as anchors,
4326 i.e. we assume that such lines are likely to have been moved.
4328 4. Starting from anchor lines, extend regions to be scrolled both
4329 forward and backward.
4333 -1 if all rows were found to be equal.
4334 0 to indicate that we did not scroll the display, or
4335 1 if we did scroll. */
4338 scrolling_window (struct window
*w
, int header_line_p
)
4340 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4341 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4342 int yb
= window_text_bottom_y (w
);
4343 int i
, j
, first_old
, first_new
, last_old
, last_new
;
4344 int nruns
, nbytes
, n
, run_idx
;
4345 struct row_entry
*entry
;
4346 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4348 /* Skip over rows equal at the start. */
4349 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4351 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4352 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4356 && !d
->redraw_fringe_bitmaps_p
4358 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4359 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4360 && row_equal_p (w
, c
, d
, 1))
4369 /* Give up if some rows in the desired matrix are not enabled. */
4370 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4373 first_old
= first_new
= i
;
4375 /* Set last_new to the index + 1 of the last enabled row in the
4378 while (i
< desired_matrix
->nrows
- 1
4379 && MATRIX_ROW (desired_matrix
, i
)->enabled_p
4380 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
)) <= yb
)
4383 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4388 /* Set last_old to the index + 1 of the last enabled row in the
4389 current matrix. We don't look at the enabled flag here because
4390 we plan to reuse part of the display even if other parts are
4393 while (i
< current_matrix
->nrows
- 1)
4395 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4404 /* Skip over rows equal at the bottom. */
4407 while (i
- 1 > first_new
4408 && j
- 1 > first_old
4409 && MATRIX_ROW (current_matrix
, i
- 1)->enabled_p
4410 && (MATRIX_ROW (current_matrix
, i
- 1)->y
4411 == MATRIX_ROW (desired_matrix
, j
- 1)->y
)
4412 && !MATRIX_ROW (desired_matrix
, j
- 1)->redraw_fringe_bitmaps_p
4414 MATRIX_ROW (desired_matrix
, i
- 1),
4415 MATRIX_ROW (current_matrix
, j
- 1), 1))
4420 /* Nothing to do if all rows are equal. */
4421 if (last_new
== first_new
)
4424 /* Reallocate vectors, tables etc. if necessary. */
4426 if (current_matrix
->nrows
> old_lines_size
)
4428 old_lines_size
= current_matrix
->nrows
;
4429 nbytes
= old_lines_size
* sizeof *old_lines
;
4430 old_lines
= (struct row_entry
**) xrealloc (old_lines
, nbytes
);
4433 if (desired_matrix
->nrows
> new_lines_size
)
4435 new_lines_size
= desired_matrix
->nrows
;
4436 nbytes
= new_lines_size
* sizeof *new_lines
;
4437 new_lines
= (struct row_entry
**) xrealloc (new_lines
, nbytes
);
4440 n
= desired_matrix
->nrows
+ current_matrix
->nrows
;
4441 if (3 * n
> row_table_size
)
4443 row_table_size
= next_almost_prime (3 * n
);
4444 nbytes
= row_table_size
* sizeof *row_table
;
4445 row_table
= (struct row_entry
**) xrealloc (row_table
, nbytes
);
4446 memset (row_table
, 0, nbytes
);
4449 if (n
> row_entry_pool_size
)
4451 row_entry_pool_size
= n
;
4452 nbytes
= row_entry_pool_size
* sizeof *row_entry_pool
;
4453 row_entry_pool
= (struct row_entry
*) xrealloc (row_entry_pool
, nbytes
);
4456 if (desired_matrix
->nrows
> runs_size
)
4458 runs_size
= desired_matrix
->nrows
;
4459 nbytes
= runs_size
* sizeof *runs
;
4460 runs
= (struct run
**) xrealloc (runs
, nbytes
);
4461 nbytes
= runs_size
* sizeof *run_pool
;
4462 run_pool
= (struct run
*) xrealloc (run_pool
, nbytes
);
4465 nruns
= run_idx
= 0;
4468 /* Add rows from the current and desired matrix to the hash table
4469 row_hash_table to be able to find equal ones quickly. */
4471 for (i
= first_old
; i
< last_old
; ++i
)
4473 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4475 entry
= add_row_entry (w
, MATRIX_ROW (current_matrix
, i
));
4476 old_lines
[i
] = entry
;
4480 old_lines
[i
] = NULL
;
4483 for (i
= first_new
; i
< last_new
; ++i
)
4485 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4486 entry
= add_row_entry (w
, MATRIX_ROW (desired_matrix
, i
));
4488 entry
->new_line_number
= i
;
4489 new_lines
[i
] = entry
;
4492 /* Identify moves based on lines that are unique and equal
4493 in both matrices. */
4494 for (i
= first_old
; i
< last_old
;)
4496 && old_lines
[i
]->old_uses
== 1
4497 && old_lines
[i
]->new_uses
== 1)
4500 int new_line
= old_lines
[i
]->new_line_number
;
4501 struct run
*run
= run_pool
+ run_idx
++;
4504 run
->current_vpos
= i
;
4505 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4506 run
->desired_vpos
= new_line
;
4507 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4509 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4511 /* Extend backward. */
4514 while (j
> first_old
4516 && old_lines
[j
] == new_lines
[k
])
4518 int h
= MATRIX_ROW (current_matrix
, j
)->height
;
4519 --run
->current_vpos
;
4520 --run
->desired_vpos
;
4523 run
->desired_y
-= h
;
4524 run
->current_y
-= h
;
4528 /* Extend forward. */
4533 && old_lines
[j
] == new_lines
[k
])
4535 int h
= MATRIX_ROW (current_matrix
, j
)->height
;
4541 /* Insert run into list of all runs. Order runs by copied
4542 pixel lines. Note that we record runs that don't have to
4543 be copied because they are already in place. This is done
4544 because we can avoid calling update_window_line in this
4546 for (j
= 0; j
< nruns
&& runs
[j
]->height
> run
->height
; ++j
)
4548 for (k
= nruns
; k
> j
; --k
)
4549 runs
[k
] = runs
[k
- 1];
4558 /* Do the moves. Do it in a way that we don't overwrite something
4559 we want to copy later on. This is not solvable in general
4560 because there is only one display and we don't have a way to
4561 exchange areas on this display. Example:
4563 +-----------+ +-----------+
4565 +-----------+ --> +-----------+
4567 +-----------+ +-----------+
4569 Instead, prefer bigger moves, and invalidate moves that would
4570 copy from where we copied to. */
4572 for (i
= 0; i
< nruns
; ++i
)
4573 if (runs
[i
]->nrows
> 0)
4575 struct run
*r
= runs
[i
];
4577 /* Copy on the display. */
4578 if (r
->current_y
!= r
->desired_y
)
4580 rif
->scroll_run_hook (w
, r
);
4582 /* Invalidate runs that copy from where we copied to. */
4583 for (j
= i
+ 1; j
< nruns
; ++j
)
4585 struct run
*p
= runs
[j
];
4587 if ((p
->current_y
>= r
->desired_y
4588 && p
->current_y
< r
->desired_y
+ r
->height
)
4589 || (p
->current_y
+ p
->height
>= r
->desired_y
4590 && (p
->current_y
+ p
->height
4591 < r
->desired_y
+ r
->height
)))
4596 /* Assign matrix rows. */
4597 for (j
= 0; j
< r
->nrows
; ++j
)
4599 struct glyph_row
*from
, *to
;
4600 int to_overlapped_p
;
4602 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4603 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4604 to_overlapped_p
= to
->overlapped_p
;
4605 if (!from
->mode_line_p
&& !w
->pseudo_window_p
4606 && (to
->left_fringe_bitmap
!= from
->left_fringe_bitmap
4607 || to
->right_fringe_bitmap
!= from
->right_fringe_bitmap
4608 || to
->left_fringe_face_id
!= from
->left_fringe_face_id
4609 || to
->right_fringe_face_id
!= from
->right_fringe_face_id
4610 || to
->overlay_arrow_bitmap
!= from
->overlay_arrow_bitmap
))
4611 from
->redraw_fringe_bitmaps_p
= 1;
4612 assign_row (to
, from
);
4613 to
->enabled_p
= 1, from
->enabled_p
= 0;
4614 to
->overlapped_p
= to_overlapped_p
;
4618 /* Clear the hash table, for the next time. */
4619 for (i
= 0; i
< row_entry_idx
; ++i
)
4620 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4622 /* Value is > 0 to indicate that we scrolled the display. */
4628 /************************************************************************
4630 ************************************************************************/
4632 /* Update the desired frame matrix of frame F.
4634 FORCE_P non-zero means that the update should not be stopped by
4635 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4636 should not be tried.
4638 Value is non-zero if update was stopped due to pending input. */
4641 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4643 /* Frame matrices to work on. */
4644 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4645 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4648 int preempt_count
= baud_rate
/ 2400 + 1;
4650 xassert (current_matrix
&& desired_matrix
);
4652 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4653 calculate_costs (f
);
4655 if (preempt_count
<= 0)
4658 #if !PERIODIC_PREEMPTION_CHECKING
4659 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4666 /* If we cannot insert/delete lines, it's no use trying it. */
4667 if (!FRAME_LINE_INS_DEL_OK (f
))
4670 /* See if any of the desired lines are enabled; don't compute for
4671 i/d line if just want cursor motion. */
4672 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4673 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4676 /* Try doing i/d line, if not yet inhibited. */
4677 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4678 force_p
|= scrolling (f
);
4680 /* Update the individual lines as needed. Do bottom line first. */
4681 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4682 update_frame_line (f
, desired_matrix
->nrows
- 1);
4684 /* Now update the rest of the lines. */
4685 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4687 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4689 if (FRAME_TERMCAP_P (f
))
4691 /* Flush out every so many lines.
4692 Also flush out if likely to have more than 1k buffered
4693 otherwise. I'm told that some telnet connections get
4694 really screwed by more than 1k output at once. */
4695 FILE *display_output
= FRAME_TTY (f
)->output
;
4698 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4700 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4702 fflush (display_output
);
4703 if (preempt_count
== 1)
4705 #ifdef EMACS_OUTQSIZE
4706 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4707 /* Probably not a tty. Ignore the error and reset
4709 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4712 if (baud_rate
<= outq
&& baud_rate
> 0)
4713 sleep (outq
/ baud_rate
);
4719 #if PERIODIC_PREEMPTION_CHECKING
4723 EMACS_GET_TIME (tm
);
4724 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4725 if (EMACS_TIME_NEG_P (dif
))
4727 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4728 if (detect_input_pending_ignore_squeezables ())
4733 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4734 detect_input_pending_ignore_squeezables ();
4737 update_frame_line (f
, i
);
4741 pause
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4743 /* Now just clean up termcap drivers and set cursor, etc. */
4746 if ((cursor_in_echo_area
4747 /* If we are showing a message instead of the mini-buffer,
4748 show the cursor for the message instead of for the
4749 (now hidden) mini-buffer contents. */
4750 || (EQ (minibuf_window
, selected_window
)
4751 && EQ (minibuf_window
, echo_area_window
)
4752 && !NILP (echo_area_buffer
[0])))
4753 /* These cases apply only to the frame that contains
4754 the active mini-buffer window. */
4755 && FRAME_HAS_MINIBUF_P (f
)
4756 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4758 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4761 if (cursor_in_echo_area
< 0)
4763 /* Negative value of cursor_in_echo_area means put
4764 cursor at beginning of line. */
4770 /* Positive value of cursor_in_echo_area means put
4771 cursor at the end of the prompt. If the mini-buffer
4772 is several lines high, find the last line that has
4774 row
= FRAME_LINES (f
);
4780 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4782 /* Frame rows are filled up with spaces that
4783 must be ignored here. */
4784 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4786 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4787 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4790 && (last
- 1)->charpos
< 0)
4796 while (row
> top
&& col
== 0);
4798 /* Make sure COL is not out of range. */
4799 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4801 /* If we have another row, advance cursor into it. */
4802 if (row
< FRAME_LINES (f
) - 1)
4804 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4807 /* Otherwise move it back in range. */
4809 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4813 cursor_to (f
, row
, col
);
4817 /* We have only one cursor on terminal frames. Use it to
4818 display the cursor of the selected window. */
4819 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4820 if (w
->cursor
.vpos
>= 0
4821 /* The cursor vpos may be temporarily out of bounds
4822 in the following situation: There is one window,
4823 with the cursor in the lower half of it. The window
4824 is split, and a message causes a redisplay before
4825 a new cursor position has been computed. */
4826 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4828 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4829 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4831 if (INTEGERP (w
->left_margin_cols
))
4832 x
+= XFASTINT (w
->left_margin_cols
);
4834 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4835 cursor_to (f
, y
, x
);
4840 #if !PERIODIC_PREEMPTION_CHECKING
4844 clear_desired_matrices (f
);
4849 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4852 scrolling (struct frame
*frame
)
4854 int unchanged_at_top
, unchanged_at_bottom
;
4857 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4858 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4859 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4860 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4862 int free_at_end_vpos
= FRAME_LINES (frame
);
4863 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4864 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4866 if (!current_matrix
)
4869 /* Compute hash codes of all the lines. Also calculate number of
4870 changed lines, number of unchanged lines at the beginning, and
4871 number of unchanged lines at the end. */
4873 unchanged_at_top
= 0;
4874 unchanged_at_bottom
= FRAME_LINES (frame
);
4875 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4877 /* Give up on this scrolling if some old lines are not enabled. */
4878 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4880 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4881 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4883 /* This line cannot be redrawn, so don't let scrolling mess it. */
4884 new_hash
[i
] = old_hash
[i
];
4885 #define INFINITY 1000000 /* Taken from scroll.c */
4886 draw_cost
[i
] = INFINITY
;
4890 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4891 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4894 if (old_hash
[i
] != new_hash
[i
])
4897 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4899 else if (i
== unchanged_at_top
)
4901 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4904 /* If changed lines are few, don't allow preemption, don't scroll. */
4905 if ((!FRAME_SCROLL_REGION_OK (frame
)
4906 && changed_lines
< baud_rate
/ 2400)
4907 || unchanged_at_bottom
== FRAME_LINES (frame
))
4910 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4911 - unchanged_at_bottom
);
4913 if (FRAME_SCROLL_REGION_OK (frame
))
4914 free_at_end_vpos
-= unchanged_at_bottom
;
4915 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4916 free_at_end_vpos
= -1;
4918 /* If large window, fast terminal and few lines in common between
4919 current frame and desired frame, don't bother with i/d calc. */
4920 if (!FRAME_SCROLL_REGION_OK (frame
)
4921 && window_size
>= 18 && baud_rate
> 2400
4923 10 * scrolling_max_lines_saved (unchanged_at_top
,
4924 FRAME_LINES (frame
) - unchanged_at_bottom
,
4925 old_hash
, new_hash
, draw_cost
)))
4928 if (window_size
< 2)
4931 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4932 draw_cost
+ unchanged_at_top
- 1,
4933 old_draw_cost
+ unchanged_at_top
- 1,
4934 old_hash
+ unchanged_at_top
- 1,
4935 new_hash
+ unchanged_at_top
- 1,
4936 free_at_end_vpos
- unchanged_at_top
);
4942 /* Count the number of blanks at the start of the vector of glyphs R
4943 which is LEN glyphs long. */
4946 count_blanks (struct glyph
*r
, int len
)
4950 for (i
= 0; i
< len
; ++i
)
4951 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4958 /* Count the number of glyphs in common at the start of the glyph
4959 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4960 of STR2. Value is the number of equal glyphs equal at the start. */
4963 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4965 struct glyph
*p1
= str1
;
4966 struct glyph
*p2
= str2
;
4970 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4977 /* Char insertion/deletion cost vector, from term.c */
4979 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
4982 /* Perform a frame-based update on line VPOS in frame FRAME. */
4985 update_frame_line (struct frame
*f
, int vpos
)
4987 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4989 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4990 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4991 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4992 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4993 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4994 int must_write_whole_line_p
;
4995 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4996 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4997 != FACE_TTY_DEFAULT_BG_COLOR
);
4999 if (colored_spaces_p
)
5002 /* Current row not enabled means it has unknown contents. We must
5003 write the whole desired line in that case. */
5004 must_write_whole_line_p
= !current_row
->enabled_p
;
5005 if (must_write_whole_line_p
)
5012 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
5013 olen
= current_row
->used
[TEXT_AREA
];
5015 /* Ignore trailing spaces, if we can. */
5016 if (!write_spaces_p
)
5017 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
5021 current_row
->enabled_p
= 1;
5022 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
5024 /* If desired line is empty, just clear the line. */
5025 if (!desired_row
->enabled_p
)
5031 nbody
= desired_row
->glyphs
[TEXT_AREA
];
5032 nlen
= desired_row
->used
[TEXT_AREA
];
5033 nend
= nbody
+ nlen
;
5035 /* If display line has unknown contents, write the whole line. */
5036 if (must_write_whole_line_p
)
5038 /* Ignore spaces at the end, if we can. */
5039 if (!write_spaces_p
)
5040 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5043 /* Write the contents of the desired line. */
5046 cursor_to (f
, vpos
, 0);
5047 write_glyphs (f
, nbody
, nlen
);
5050 /* Don't call clear_end_of_line if we already wrote the whole
5051 line. The cursor will not be at the right margin in that
5052 case but in the line below. */
5053 if (nlen
< FRAME_TOTAL_COLS (f
))
5055 cursor_to (f
, vpos
, nlen
);
5056 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5059 /* Make sure we are in the right row, otherwise cursor movement
5060 with cmgoto might use `ch' in the wrong row. */
5061 cursor_to (f
, vpos
, 0);
5063 make_current (desired_matrix
, current_matrix
, vpos
);
5067 /* Pretend trailing spaces are not there at all,
5068 unless for one reason or another we must write all spaces. */
5069 if (!write_spaces_p
)
5070 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5073 /* If there's no i/d char, quickly do the best we can without it. */
5074 if (!FRAME_CHAR_INS_DEL_OK (f
))
5078 /* Find the first glyph in desired row that doesn't agree with
5079 a glyph in the current row, and write the rest from there on. */
5080 for (i
= 0; i
< nlen
; i
++)
5082 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5084 /* Find the end of the run of different glyphs. */
5088 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5089 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5092 /* Output this run of non-matching chars. */
5093 cursor_to (f
, vpos
, i
);
5094 write_glyphs (f
, nbody
+ i
, j
- i
);
5097 /* Now find the next non-match. */
5101 /* Clear the rest of the line, or the non-clear part of it. */
5104 cursor_to (f
, vpos
, nlen
);
5105 clear_end_of_line (f
, olen
);
5108 /* Make current row = desired row. */
5109 make_current (desired_matrix
, current_matrix
, vpos
);
5113 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5114 characters in a row. */
5118 /* If current line is blank, skip over initial spaces, if
5119 possible, and write the rest. */
5123 nsp
= count_blanks (nbody
, nlen
);
5127 cursor_to (f
, vpos
, nsp
);
5128 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5131 /* Exchange contents between current_frame and new_frame. */
5132 make_current (desired_matrix
, current_matrix
, vpos
);
5136 /* Compute number of leading blanks in old and new contents. */
5137 osp
= count_blanks (obody
, olen
);
5138 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5140 /* Compute number of matching chars starting with first non-blank. */
5141 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5142 nbody
+ nsp
, nbody
+ nlen
);
5144 /* Spaces in new match implicit space past the end of old. */
5145 /* A bug causing this to be a no-op was fixed in 18.29. */
5146 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5149 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5153 /* Avoid doing insert/delete char
5154 just cause number of leading spaces differs
5155 when the following text does not match. */
5156 if (begmatch
== 0 && osp
!= nsp
)
5157 osp
= nsp
= min (osp
, nsp
);
5159 /* Find matching characters at end of line */
5162 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5164 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5169 endmatch
= obody
+ olen
- op1
;
5171 /* tem gets the distance to insert or delete.
5172 endmatch is how many characters we save by doing so.
5175 tem
= (nlen
- nsp
) - (olen
- osp
);
5177 && (!FRAME_CHAR_INS_DEL_OK (f
)
5178 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5181 /* nsp - osp is the distance to insert or delete.
5182 If that is nonzero, begmatch is known to be nonzero also.
5183 begmatch + endmatch is how much we save by doing the ins/del.
5187 && (!FRAME_CHAR_INS_DEL_OK (f
)
5188 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5192 osp
= nsp
= min (osp
, nsp
);
5195 /* Now go through the line, inserting, writing and
5196 deleting as appropriate. */
5200 cursor_to (f
, vpos
, nsp
);
5201 delete_glyphs (f
, osp
- nsp
);
5205 /* If going to delete chars later in line
5206 and insert earlier in the line,
5207 must delete first to avoid losing data in the insert */
5208 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5210 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5211 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5212 olen
= nlen
- (nsp
- osp
);
5214 cursor_to (f
, vpos
, osp
);
5215 insert_glyphs (f
, 0, nsp
- osp
);
5219 tem
= nsp
+ begmatch
+ endmatch
;
5220 if (nlen
!= tem
|| olen
!= tem
)
5222 if (!endmatch
|| nlen
== olen
)
5224 /* If new text being written reaches right margin, there is
5225 no need to do clear-to-eol at the end of this function
5226 (and it would not be safe, since cursor is not going to
5227 be "at the margin" after the text is done). */
5228 if (nlen
== FRAME_TOTAL_COLS (f
))
5231 /* Function write_glyphs is prepared to do nothing
5232 if passed a length <= 0. Check it here to avoid
5233 unnecessary cursor movement. */
5236 cursor_to (f
, vpos
, nsp
+ begmatch
);
5237 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5240 else if (nlen
> olen
)
5242 /* Here, we used to have the following simple code:
5243 ----------------------------------------
5244 write_glyphs (nbody + nsp + begmatch, olen - tem);
5245 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5246 ----------------------------------------
5247 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5248 is a padding glyph. */
5249 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5252 cursor_to (f
, vpos
, nsp
+ begmatch
);
5254 /* Calculate columns we can actually overwrite. */
5255 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5257 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5259 /* If we left columns to be overwritten, we must delete them. */
5260 del
= olen
- tem
- out
;
5262 delete_glyphs (f
, del
);
5264 /* At last, we insert columns not yet written out. */
5265 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5268 else if (olen
> nlen
)
5270 cursor_to (f
, vpos
, nsp
+ begmatch
);
5271 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5272 delete_glyphs (f
, olen
- nlen
);
5278 /* If any unerased characters remain after the new line, erase them. */
5281 cursor_to (f
, vpos
, nlen
);
5282 clear_end_of_line (f
, olen
);
5285 /* Exchange contents between current_frame and new_frame. */
5286 make_current (desired_matrix
, current_matrix
, vpos
);
5291 /***********************************************************************
5292 X/Y Position -> Buffer Position
5293 ***********************************************************************/
5295 /* Determine what's under window-relative pixel position (*X, *Y).
5296 Return the OBJECT (string or buffer) that's there.
5297 Return in *POS the position in that object.
5298 Adjust *X and *Y to character positions.
5299 Return in *DX and *DY the pixel coordinates of the click,
5300 relative to the top left corner of OBJECT, or relative to
5301 the top left corner of the character glyph at (*X, *Y)
5303 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5304 if the coordinates point to an empty area of the display. */
5307 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
)
5310 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5311 struct text_pos startp
;
5313 struct glyph_row
*row
;
5314 #ifdef HAVE_WINDOW_SYSTEM
5315 struct image
*img
= 0;
5319 /* We used to set current_buffer directly here, but that does the
5320 wrong thing with `face-remapping-alist' (bug#2044). */
5321 Fset_buffer (w
->buffer
);
5322 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5323 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5324 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5325 start_display (&it
, w
, startp
);
5329 /* First, move to the beginning of the row corresponding to *Y. We
5330 need to be in that row to get the correct value of base paragraph
5331 direction for the text at (*X, *Y). */
5332 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5334 /* TO_X is the pixel position that the iterator will compute for the
5335 glyph at *X. We add it.first_visible_x because iterator
5336 positions include the hscroll. */
5337 to_x
= x0
+ it
.first_visible_x
;
5338 if (it
.bidi_it
.paragraph_dir
== R2L
)
5339 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5340 text area. This is because the iterator, even in R2L
5341 paragraphs, delivers glyphs as if they started at the left
5342 margin of the window. (When we actually produce glyphs for
5343 display, we reverse their order in PRODUCE_GLYPHS, but the
5344 iterator doesn't know about that.) The following line adjusts
5345 the pixel position to the iterator geometry, which is what
5346 move_it_* routines use. (The -1 is because in a window whose
5347 text-area width is W, the rightmost pixel position is W-1, and
5348 it should be mirrored into zero pixel position.) */
5349 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5351 /* Now move horizontally in the row to the glyph under *X. Second
5352 argument is ZV to prevent move_it_in_display_line from matching
5353 based on buffer positions. */
5354 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5356 Fset_buffer (old_current_buffer
);
5358 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5359 *dy
= *y
- it
.current_y
;
5362 if (STRINGP (it
.string
))
5365 if (it
.what
== IT_COMPOSITION
5366 && it
.cmp_it
.nchars
> 1
5367 && it
.cmp_it
.reversed_p
)
5369 /* The current display element is a grapheme cluster in a
5370 composition. In that case, we need the position of the first
5371 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5372 it.current points to the last character of the cluster, thus
5373 we must move back to the first character of the same
5375 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5376 if (STRINGP (it
.string
))
5377 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5379 BYTEPOS (pos
->pos
) = CHAR_TO_BYTE (CHARPOS (pos
->pos
));
5382 #ifdef HAVE_WINDOW_SYSTEM
5383 if (it
.what
== IT_IMAGE
)
5385 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5386 && !NILP (img
->spec
))
5387 *object
= img
->spec
;
5391 if (it
.vpos
< w
->current_matrix
->nrows
5392 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5395 if (it
.hpos
< row
->used
[TEXT_AREA
])
5397 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5398 #ifdef HAVE_WINDOW_SYSTEM
5401 *dy
-= row
->ascent
- glyph
->ascent
;
5402 *dx
+= glyph
->slice
.img
.x
;
5403 *dy
+= glyph
->slice
.img
.y
;
5404 /* Image slices positions are still relative to the entire image */
5405 *width
= img
->width
;
5406 *height
= img
->height
;
5411 *width
= glyph
->pixel_width
;
5412 *height
= glyph
->ascent
+ glyph
->descent
;
5418 *height
= row
->height
;
5423 *width
= *height
= 0;
5426 /* Add extra (default width) columns if clicked after EOL. */
5427 x1
= max(0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5429 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5438 /* Value is the string under window-relative coordinates X/Y in the
5439 mode line or header line (PART says which) of window W, or nil if none.
5440 *CHARPOS is set to the position in the string returned. */
5443 mode_line_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
;
5448 struct glyph
*glyph
, *end
;
5450 Lisp_Object string
= Qnil
;
5452 if (part
== ON_MODE_LINE
)
5453 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5455 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5457 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5459 if (row
->mode_line_p
&& row
->enabled_p
)
5461 /* Find the glyph under X. If we find one with a string object,
5462 it's the one we were looking for. */
5463 glyph
= row
->glyphs
[TEXT_AREA
];
5464 end
= glyph
+ row
->used
[TEXT_AREA
];
5465 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5466 x0
-= glyph
->pixel_width
;
5467 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5470 string
= glyph
->object
;
5471 *charpos
= glyph
->charpos
;
5472 *width
= glyph
->pixel_width
;
5473 *height
= glyph
->ascent
+ glyph
->descent
;
5474 #ifdef HAVE_WINDOW_SYSTEM
5475 if (glyph
->type
== IMAGE_GLYPH
)
5478 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5480 *object
= img
->spec
;
5481 y0
-= row
->ascent
- glyph
->ascent
;
5487 /* Add extra (default width) columns if clicked after EOL. */
5488 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5490 *height
= row
->height
;
5497 *width
= *height
= 0;
5507 /* Value is the string under window-relative coordinates X/Y in either
5508 marginal area, or nil if none. *CHARPOS is set to the position in
5509 the string returned. */
5512 marginal_area_string (struct window
*w
, enum window_part part
,
5513 int *x
, int *y
, EMACS_INT
*charpos
, Lisp_Object
*object
,
5514 int *dx
, int *dy
, int *width
, int *height
)
5516 struct glyph_row
*row
= w
->current_matrix
->rows
;
5517 struct glyph
*glyph
, *end
;
5518 int x0
, y0
, i
, wy
= *y
;
5520 Lisp_Object string
= Qnil
;
5522 if (part
== ON_LEFT_MARGIN
)
5523 area
= LEFT_MARGIN_AREA
;
5524 else if (part
== ON_RIGHT_MARGIN
)
5525 area
= RIGHT_MARGIN_AREA
;
5529 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5530 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5533 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5537 /* Find the glyph under X. If we find one with a string object,
5538 it's the one we were looking for. */
5539 if (area
== RIGHT_MARGIN_AREA
)
5540 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5541 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5542 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5543 + window_box_width (w
, LEFT_MARGIN_AREA
)
5544 + window_box_width (w
, TEXT_AREA
));
5546 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5547 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5550 glyph
= row
->glyphs
[area
];
5551 end
= glyph
+ row
->used
[area
];
5552 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5553 x0
-= glyph
->pixel_width
;
5554 *x
= glyph
- row
->glyphs
[area
];
5557 string
= glyph
->object
;
5558 *charpos
= glyph
->charpos
;
5559 *width
= glyph
->pixel_width
;
5560 *height
= glyph
->ascent
+ glyph
->descent
;
5561 #ifdef HAVE_WINDOW_SYSTEM
5562 if (glyph
->type
== IMAGE_GLYPH
)
5565 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5567 *object
= img
->spec
;
5568 y0
-= row
->ascent
- glyph
->ascent
;
5569 x0
+= glyph
->slice
.img
.x
;
5570 y0
+= glyph
->slice
.img
.y
;
5576 /* Add extra (default width) columns if clicked after EOL. */
5577 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5579 *height
= row
->height
;
5586 *width
= *height
= 0;
5596 /***********************************************************************
5597 Changing Frame Sizes
5598 ***********************************************************************/
5603 window_change_signal (int signalnum
) /* If we don't have an argument, */
5604 /* some compilers complain in signal calls. */
5607 int old_errno
= errno
;
5609 struct tty_display_info
*tty
;
5611 signal (SIGWINCH
, window_change_signal
);
5612 SIGNAL_THREAD_CHECK (signalnum
);
5614 /* The frame size change obviously applies to a single
5615 termcap-controlled terminal, but we can't decide which.
5616 Therefore, we resize the frames corresponding to each tty.
5618 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5620 if (! tty
->term_initted
)
5623 /* Suspended tty frames have tty->input == NULL avoid trying to
5628 get_tty_size (fileno (tty
->input
), &width
, &height
);
5630 if (width
> 5 && height
> 2) {
5631 Lisp_Object tail
, frame
;
5633 FOR_EACH_FRAME (tail
, frame
)
5634 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5635 /* Record the new sizes, but don't reallocate the data
5636 structures now. Let that be done later outside of the
5638 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5644 #endif /* SIGWINCH */
5647 /* Do any change in frame size that was requested by a signal. SAFE
5648 non-zero means this function is called from a place where it is
5649 safe to change frame sizes while a redisplay is in progress. */
5652 do_pending_window_change (int safe
)
5654 /* If window_change_signal should have run before, run it now. */
5655 if (redisplaying_p
&& !safe
)
5658 while (delayed_size_change
)
5660 Lisp_Object tail
, frame
;
5662 delayed_size_change
= 0;
5664 FOR_EACH_FRAME (tail
, frame
)
5666 struct frame
*f
= XFRAME (frame
);
5668 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5669 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5676 /* Change the frame height and/or width. Values may be given as zero to
5677 indicate no change is to take place.
5679 If DELAY is non-zero, then assume we're being called from a signal
5680 handler, and queue the change for later - perhaps the next
5681 redisplay. Since this tries to resize windows, we can't call it
5682 from a signal handler.
5684 SAFE non-zero means this function is called from a place where it's
5685 safe to change frame sizes while a redisplay is in progress. */
5688 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5690 Lisp_Object tail
, frame
;
5692 if (FRAME_MSDOS_P (f
))
5694 /* On MS-DOS, all frames use the same screen, so a change in
5695 size affects all frames. Termcap now supports multiple
5697 FOR_EACH_FRAME (tail
, frame
)
5698 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5699 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5700 pretend
, delay
, safe
);
5703 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5707 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5709 int new_frame_total_cols
;
5710 int count
= SPECPDL_INDEX ();
5712 /* If we can't deal with the change now, queue it for later. */
5713 if (delay
|| (redisplaying_p
&& !safe
))
5715 f
->new_text_lines
= newheight
;
5716 f
->new_text_cols
= newwidth
;
5717 delayed_size_change
= 1;
5721 /* This size-change overrides any pending one for this frame. */
5722 f
->new_text_lines
= 0;
5723 f
->new_text_cols
= 0;
5725 /* If an argument is zero, set it to the current value. */
5727 newheight
= FRAME_LINES (f
);
5729 newwidth
= FRAME_COLS (f
);
5731 /* Compute width of windows in F.
5732 This is the width of the frame without vertical scroll bars. */
5733 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5735 /* Round up to the smallest acceptable size. */
5736 check_frame_size (f
, &newheight
, &newwidth
);
5738 /* If we're not changing the frame size, quit now. */
5739 /* Frame width may be unchanged but the text portion may change, for example,
5740 fullscreen and remove/add scroll bar. */
5741 if (newheight
== FRAME_LINES (f
)
5742 && newwidth
== FRAME_COLS (f
) // text portion unchanged
5743 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
)) // frame width unchanged
5749 /* We only can set screen dimensions to certain values supported
5750 by our video hardware. Try to find the smallest size greater
5751 or equal to the requested dimensions. */
5752 dos_set_window_size (&newheight
, &newwidth
);
5755 if (newheight
!= FRAME_LINES (f
))
5757 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
5759 /* Frame has both root and mini-buffer. */
5760 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f
))->top_line
,
5761 FRAME_TOP_MARGIN (f
));
5762 set_window_height (FRAME_ROOT_WINDOW (f
),
5765 - FRAME_TOP_MARGIN (f
)),
5767 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f
))->top_line
,
5769 set_window_height (FRAME_MINIBUF_WINDOW (f
), 1, 0);
5772 /* Frame has just one top-level window. */
5773 set_window_height (FRAME_ROOT_WINDOW (f
),
5774 newheight
- FRAME_TOP_MARGIN (f
), 2);
5776 /* MSDOS frames cannot PRETEND, as they change frame size by
5777 manipulating video hardware. */
5778 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5779 FrameRows (FRAME_TTY (f
)) = newheight
;
5782 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5784 set_window_width (FRAME_ROOT_WINDOW (f
), new_frame_total_cols
, 2);
5785 if (FRAME_HAS_MINIBUF_P (f
))
5786 set_window_width (FRAME_MINIBUF_WINDOW (f
), new_frame_total_cols
, 0);
5788 /* MSDOS frames cannot PRETEND, as they change frame size by
5789 manipulating video hardware. */
5790 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5791 FrameCols (FRAME_TTY (f
)) = newwidth
;
5793 if (WINDOWP (f
->tool_bar_window
))
5794 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5797 FRAME_LINES (f
) = newheight
;
5798 SET_FRAME_COLS (f
, newwidth
);
5801 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5802 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5804 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5806 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5807 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5808 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5809 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5813 calculate_costs (f
);
5814 SET_FRAME_GARBAGED (f
);
5819 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5821 run_window_configuration_change_hook (f
);
5823 unbind_to (count
, Qnil
);
5828 /***********************************************************************
5829 Terminal Related Lisp Functions
5830 ***********************************************************************/
5832 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5833 1, 1, "FOpen termscript file: ",
5834 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5835 FILE = nil means just close any termscript file currently open. */)
5838 struct tty_display_info
*tty
;
5840 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5841 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5842 error ("Current frame is not on a tty device");
5846 if (tty
->termscript
!= 0)
5849 fclose (tty
->termscript
);
5852 tty
->termscript
= 0;
5856 file
= Fexpand_file_name (file
, Qnil
);
5857 tty
->termscript
= fopen (SSDATA (file
), "w");
5858 if (tty
->termscript
== 0)
5859 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5865 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5866 Ssend_string_to_terminal
, 1, 2, 0,
5867 doc
: /* Send STRING to the terminal without alteration.
5868 Control characters in STRING will have terminal-dependent effects.
5870 Optional parameter TERMINAL specifies the tty terminal device to use.
5871 It may be a terminal object, a frame, or nil for the terminal used by
5872 the currently selected frame. In batch mode, STRING is sent to stdout
5873 when TERMINAL is nil. */)
5874 (Lisp_Object string
, Lisp_Object terminal
)
5876 struct terminal
*t
= get_terminal (terminal
, 1);
5879 /* ??? Perhaps we should do something special for multibyte strings here. */
5880 CHECK_STRING (string
);
5884 error ("Unknown terminal device");
5886 if (t
->type
== output_initial
)
5888 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5889 error ("Device %d is not a termcap terminal device", t
->id
);
5892 struct tty_display_info
*tty
= t
->display_info
.tty
;
5895 error ("Terminal is currently suspended");
5897 if (tty
->termscript
)
5899 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5900 fflush (tty
->termscript
);
5904 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5911 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5912 doc
: /* Beep, or flash the screen.
5913 Also, unless an argument is given,
5914 terminate any keyboard macro currently executing. */)
5922 ring_bell (XFRAME (selected_frame
));
5931 bitch_at_user (void)
5935 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5936 error ("Keyboard macro terminated by a command ringing the bell");
5938 ring_bell (XFRAME (selected_frame
));
5943 /***********************************************************************
5945 ***********************************************************************/
5947 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5948 doc
: /* Pause, without updating display, for SECONDS seconds.
5949 SECONDS may be a floating-point value, meaning that you can wait for a
5950 fraction of a second. Optional second arg MILLISECONDS specifies an
5951 additional wait period, in milliseconds; this may be useful if your
5952 Emacs was built without floating point support.
5953 \(Not all operating systems support waiting for a fraction of a second.) */)
5954 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5958 if (NILP (milliseconds
))
5959 XSETINT (milliseconds
, 0);
5961 CHECK_NUMBER (milliseconds
);
5962 usec
= XINT (milliseconds
) * 1000;
5965 double duration
= extract_float (seconds
);
5966 sec
= (int) duration
;
5967 usec
+= (duration
- sec
) * 1000000;
5970 #ifndef EMACS_HAS_USECS
5971 if (sec
== 0 && usec
!= 0)
5972 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
5975 /* Assure that 0 <= usec < 1000000. */
5978 /* We can't rely on the rounding being correct if usec is negative. */
5979 if (-1000000 < usec
)
5980 sec
--, usec
+= 1000000;
5982 sec
-= -usec
/ 1000000, usec
= 1000000 - (-usec
% 1000000);
5985 sec
+= usec
/ 1000000, usec
%= 1000000;
5987 if (sec
< 0 || (sec
== 0 && usec
== 0))
5990 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
5996 /* This is just like wait_reading_process_output, except that
5999 TIMEOUT is number of seconds to wait (float or integer),
6000 or t to wait forever.
6001 READING is 1 if reading input.
6002 If DO_DISPLAY is >0 display process output while waiting.
6003 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
6007 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
6011 swallow_events (do_display
);
6013 if ((detect_input_pending_run_timers (do_display
))
6014 || !NILP (Vexecuting_kbd_macro
))
6017 if (do_display
>= 2)
6018 redisplay_preserve_echo_area (2);
6020 if (INTEGERP (timeout
))
6022 sec
= XINT (timeout
);
6025 else if (FLOATP (timeout
))
6027 double seconds
= XFLOAT_DATA (timeout
);
6028 sec
= (int) seconds
;
6029 usec
= (int) ((seconds
- sec
) * 1000000);
6031 else if (EQ (timeout
, Qt
))
6037 wrong_type_argument (Qnumberp
, timeout
);
6039 if (sec
== 0 && usec
== 0 && !EQ (timeout
, Qt
))
6046 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
6049 return detect_input_pending () ? Qnil
: Qt
;
6053 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
6054 doc
: /* Perform redisplay if no input is available.
6055 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
6056 perform a full redisplay even if input is available.
6057 Return t if redisplay was performed, nil otherwise. */)
6063 if ((detect_input_pending_run_timers (1)
6064 && NILP (force
) && !redisplay_dont_pause
)
6065 || !NILP (Vexecuting_kbd_macro
))
6068 count
= SPECPDL_INDEX ();
6069 if (!NILP (force
) && !redisplay_dont_pause
)
6070 specbind (Qredisplay_dont_pause
, Qt
);
6071 redisplay_preserve_echo_area (2);
6072 unbind_to (count
, Qnil
);
6078 /***********************************************************************
6079 Other Lisp Functions
6080 ***********************************************************************/
6082 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6083 session's frames, frame names, buffers, buffer-read-only flags, and
6084 buffer-modified-flags. */
6086 static Lisp_Object frame_and_buffer_state
;
6089 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6090 Sframe_or_buffer_changed_p
, 0, 1, 0,
6091 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6092 VARIABLE is a variable name whose value is either nil or a state vector
6093 that will be updated to contain all frames and buffers,
6094 aside from buffers whose names start with space,
6095 along with the buffers' read-only and modified flags. This allows a fast
6096 check to see whether buffer menus might need to be recomputed.
6097 If this function returns non-nil, it updates the internal vector to reflect
6100 If VARIABLE is nil, an internal variable is used. Users should not
6101 pass nil for VARIABLE. */)
6102 (Lisp_Object variable
)
6104 Lisp_Object state
, tail
, frame
, buf
;
6105 Lisp_Object
*vecp
, *end
;
6108 if (! NILP (variable
))
6110 CHECK_SYMBOL (variable
);
6111 state
= Fsymbol_value (variable
);
6112 if (! VECTORP (state
))
6116 state
= frame_and_buffer_state
;
6118 vecp
= XVECTOR (state
)->contents
;
6119 end
= vecp
+ XVECTOR (state
)->size
;
6121 FOR_EACH_FRAME (tail
, frame
)
6125 if (!EQ (*vecp
++, frame
))
6129 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6132 /* Check that the buffer info matches. */
6133 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6135 buf
= XCDR (XCAR (tail
));
6136 /* Ignore buffers that aren't included in buffer lists. */
6137 if (SREF (XBUFFER (buf
)->name
, 0) == ' ')
6141 if (!EQ (*vecp
++, buf
))
6145 if (!EQ (*vecp
++, XBUFFER (buf
)->read_only
))
6149 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6154 /* Detect deletion of a buffer at the end of the list. */
6155 if (EQ (*vecp
, Qlambda
))
6158 /* Come here if we decide the data has changed. */
6160 /* Count the size we will need.
6161 Start with 1 so there is room for at least one lambda at the end. */
6163 FOR_EACH_FRAME (tail
, frame
)
6165 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6167 /* Reallocate the vector if data has grown to need it,
6168 or if it has shrunk a lot. */
6169 if (! VECTORP (state
)
6170 || n
> XVECTOR (state
)->size
6171 || n
+ 20 < XVECTOR (state
)->size
/ 2)
6172 /* Add 20 extra so we grow it less often. */
6174 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6175 if (! NILP (variable
))
6176 Fset (variable
, state
);
6178 frame_and_buffer_state
= state
;
6181 /* Record the new data in the (possibly reallocated) vector. */
6182 vecp
= XVECTOR (state
)->contents
;
6183 FOR_EACH_FRAME (tail
, frame
)
6186 *vecp
++ = XFRAME (frame
)->name
;
6188 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6190 buf
= XCDR (XCAR (tail
));
6191 /* Ignore buffers that aren't included in buffer lists. */
6192 if (SREF (XBUFFER (buf
)->name
, 0) == ' ')
6195 *vecp
++ = XBUFFER (buf
)->read_only
;
6196 *vecp
++ = Fbuffer_modified_p (buf
);
6198 /* Fill up the vector with lambdas (always at least one). */
6200 while (vecp
- XVECTOR (state
)->contents
6201 < XVECTOR (state
)->size
)
6203 /* Make sure we didn't overflow the vector. */
6204 if (vecp
- XVECTOR (state
)->contents
6205 > XVECTOR (state
)->size
)
6212 /***********************************************************************
6214 ***********************************************************************/
6216 /* Initialization done when Emacs fork is started, before doing stty.
6217 Determine terminal type and set terminal_driver. Then invoke its
6218 decoding routine to set up variables in the terminal package. */
6223 char *terminal_type
;
6225 /* Construct the space glyph. */
6226 space_glyph
.type
= CHAR_GLYPH
;
6227 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6228 space_glyph
.charpos
= -1;
6231 cursor_in_echo_area
= 0;
6232 terminal_type
= (char *) 0;
6234 /* Now is the time to initialize this; it's used by init_sys_modes
6236 Vinitial_window_system
= Qnil
;
6238 /* SIGWINCH needs to be handled no matter what display we start
6239 with. Otherwise newly opened tty frames will not resize
6244 #endif /* CANNOT_DUMP */
6245 signal (SIGWINCH
, window_change_signal
);
6246 #endif /* SIGWINCH */
6248 /* If running as a daemon, no need to initialize any frames/terminal. */
6252 /* If the user wants to use a window system, we shouldn't bother
6253 initializing the terminal. This is especially important when the
6254 terminal is so dumb that emacs gives up before and doesn't bother
6255 using the window system.
6257 If the DISPLAY environment variable is set and nonempty,
6258 try to use X, and die with an error message if that doesn't work. */
6260 #ifdef HAVE_X_WINDOWS
6261 if (! inhibit_window_system
&& ! display_arg
)
6264 display
= getenv ("DISPLAY");
6265 display_arg
= (display
!= 0 && *display
!= 0);
6267 if (display_arg
&& !x_display_ok (display
))
6269 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6271 inhibit_window_system
= 1;
6275 if (!inhibit_window_system
&& display_arg
6281 Vinitial_window_system
= Qx
;
6283 Vwindow_system_version
= make_number (11);
6285 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6286 /* In some versions of ncurses,
6287 tputs crashes if we have not called tgetent.
6289 { char b
[2044]; tgetent (b
, "xterm");}
6291 adjust_frame_glyphs_initially ();
6294 #endif /* HAVE_X_WINDOWS */
6297 if (!inhibit_window_system
)
6299 Vinitial_window_system
= Qw32
;
6300 Vwindow_system_version
= make_number (1);
6301 adjust_frame_glyphs_initially ();
6304 #endif /* HAVE_NTGUI */
6307 if (!inhibit_window_system
6313 Vinitial_window_system
= Qns
;
6314 Vwindow_system_version
= make_number(10);
6315 adjust_frame_glyphs_initially ();
6320 /* If no window system has been specified, try to use the terminal. */
6323 fatal ("standard input is not a tty");
6328 terminal_type
= "w32console";
6330 /* Look at the TERM variable. */
6331 terminal_type
= (char *) getenv ("TERM");
6335 #ifdef HAVE_WINDOW_SYSTEM
6336 if (! inhibit_window_system
)
6337 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6339 #endif /* HAVE_WINDOW_SYSTEM */
6340 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6346 struct frame
*f
= XFRAME (selected_frame
);
6348 /* Open a display on the controlling tty. */
6349 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6351 /* Convert the initial frame to use the new display. */
6352 if (f
->output_method
!= output_initial
)
6354 f
->output_method
= t
->type
;
6357 t
->reference_count
++;
6359 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6361 if (f
->output_method
== output_termcap
)
6362 create_tty_output (f
);
6364 t
->display_info
.tty
->top_frame
= selected_frame
;
6365 change_frame_size (XFRAME (selected_frame
),
6366 FrameRows (t
->display_info
.tty
),
6367 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6369 /* Delete the initial terminal. */
6370 if (--initial_terminal
->reference_count
== 0
6371 && initial_terminal
->delete_terminal_hook
)
6372 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6374 /* Update frame parameters to reflect the new type. */
6375 Fmodify_frame_parameters
6376 (selected_frame
, Fcons (Fcons (Qtty_type
,
6377 Ftty_type (selected_frame
)), Qnil
));
6378 if (t
->display_info
.tty
->name
)
6379 Fmodify_frame_parameters (selected_frame
,
6380 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6383 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6388 struct frame
*sf
= SELECTED_FRAME ();
6389 int width
= FRAME_TOTAL_COLS (sf
);
6390 int height
= FRAME_LINES (sf
);
6392 unsigned int total_glyphs
= height
* (width
+ 2) * sizeof (struct glyph
);
6394 /* If these sizes are so big they cause overflow, just ignore the
6395 change. It's not clear what better we could do. */
6396 if (total_glyphs
/ sizeof (struct glyph
) / height
!= width
+ 2)
6397 fatal ("screen size %dx%d too big", width
, height
);
6400 adjust_frame_glyphs_initially ();
6401 calculate_costs (XFRAME (selected_frame
));
6403 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6406 && NILP (Vinitial_window_system
))
6408 /* For the initial frame, we don't have any way of knowing what
6409 are the foreground and background colors of the terminal. */
6410 struct frame
*sf
= SELECTED_FRAME();
6412 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6413 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6414 call0 (intern ("tty-set-up-initial-frame-faces"));
6420 /***********************************************************************
6422 ***********************************************************************/
6424 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6425 Sinternal_show_cursor
, 2, 2, 0,
6426 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6427 WINDOW nil means use the selected window. SHOW non-nil means
6428 show a cursor in WINDOW in the next redisplay. SHOW nil means
6429 don't show a cursor. */)
6430 (Lisp_Object window
, Lisp_Object show
)
6432 /* Don't change cursor state while redisplaying. This could confuse
6434 if (!redisplaying_p
)
6437 window
= selected_window
;
6439 CHECK_WINDOW (window
);
6441 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6448 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6449 Sinternal_show_cursor_p
, 0, 1, 0,
6450 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6451 WINDOW nil or omitted means report on the selected window. */)
6452 (Lisp_Object window
)
6457 window
= selected_window
;
6459 CHECK_WINDOW (window
);
6461 w
= XWINDOW (window
);
6462 return w
->cursor_off_p
? Qnil
: Qt
;
6465 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6466 Slast_nonminibuf_frame
, 0, 0, 0,
6467 doc
: /* Value is last nonminibuffer frame. */)
6470 Lisp_Object frame
= Qnil
;
6472 if (last_nonminibuf_frame
)
6473 XSETFRAME (frame
, last_nonminibuf_frame
);
6478 /***********************************************************************
6480 ***********************************************************************/
6483 syms_of_display (void)
6485 defsubr (&Sredraw_frame
);
6486 defsubr (&Sredraw_display
);
6487 defsubr (&Sframe_or_buffer_changed_p
);
6488 defsubr (&Sopen_termscript
);
6490 defsubr (&Sredisplay
);
6491 defsubr (&Ssleep_for
);
6492 defsubr (&Ssend_string_to_terminal
);
6493 defsubr (&Sinternal_show_cursor
);
6494 defsubr (&Sinternal_show_cursor_p
);
6495 defsubr (&Slast_nonminibuf_frame
);
6498 defsubr (&Sdump_redisplay_history
);
6501 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6502 staticpro (&frame_and_buffer_state
);
6504 Qdisplay_table
= intern_c_string ("display-table");
6505 staticpro (&Qdisplay_table
);
6506 Qredisplay_dont_pause
= intern_c_string ("redisplay-dont-pause");
6507 staticpro (&Qredisplay_dont_pause
);
6509 DEFVAR_INT ("baud-rate", baud_rate
,
6510 doc
: /* *The output baud rate of the terminal.
6511 On most systems, changing this value will affect the amount of padding
6512 and the other strategic decisions made during redisplay. */);
6514 DEFVAR_BOOL ("inverse-video", inverse_video
,
6515 doc
: /* *Non-nil means invert the entire frame display.
6516 This means everything is in inverse video which otherwise would not be. */);
6518 DEFVAR_BOOL ("visible-bell", visible_bell
,
6519 doc
: /* *Non-nil means try to flash the frame to represent a bell.
6521 See also `ring-bell-function'. */);
6523 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6524 doc
: /* *Non-nil means no need to redraw entire frame after suspending.
6525 A non-nil value is useful if the terminal can automatically preserve
6526 Emacs's frame display when you reenter Emacs.
6527 It is up to you to set this variable if your terminal can do that. */);
6529 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6530 doc
: /* Name of the window system that Emacs uses for the first frame.
6531 The value is a symbol:
6532 nil for a termcap frame (a character-only terminal),
6533 'x' for an Emacs frame that is really an X window,
6534 'w32' for an Emacs frame that is a window on MS-Windows display,
6535 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6536 'pc' for a direct-write MS-DOS frame.
6538 Use of this variable as a boolean is deprecated. Instead,
6539 use `display-graphic-p' or any of the other `display-*-p'
6540 predicates which report frame's specific UI-related capabilities. */);
6542 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6543 doc
: /* Name of window system through which the selected frame is displayed.
6544 The value is a symbol:
6545 nil for a termcap frame (a character-only terminal),
6546 'x' for an Emacs frame that is really an X window,
6547 'w32' for an Emacs frame that is a window on MS-Windows display,
6548 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6549 'pc' for a direct-write MS-DOS frame.
6551 Use of this variable as a boolean is deprecated. Instead,
6552 use `display-graphic-p' or any of the other `display-*-p'
6553 predicates which report frame's specific UI-related capabilities. */);
6555 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6556 doc
: /* The version number of the window system in use.
6557 For X windows, this is 11. */);
6559 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6560 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6562 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6563 doc
: /* Table defining how to output a glyph code to the frame.
6564 If not nil, this is a vector indexed by glyph code to define the glyph.
6565 Each element can be:
6566 integer: a glyph code which this glyph is an alias for.
6567 string: output this glyph using that string (not impl. in X windows).
6568 nil: this glyph mod 524288 is the code of a character to output,
6569 and this glyph / 524288 is the face number (see `face-id') to use
6570 while outputting it. */);
6571 Vglyph_table
= Qnil
;
6573 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6574 doc
: /* Display table to use for buffers that specify none.
6575 See `buffer-display-table' for more information. */);
6576 Vstandard_display_table
= Qnil
;
6578 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6579 doc
: /* *Non-nil means update isn't paused when input is detected. */);
6580 redisplay_dont_pause
= 0;
6582 #if PERIODIC_PREEMPTION_CHECKING
6583 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6584 doc
: /* *The period in seconds between checking for input during redisplay.
6585 If input is detected, redisplay is pre-empted, and the input is processed.
6586 If nil, never pre-empt redisplay. */);
6587 Vredisplay_preemption_period
= make_float (0.10);
6594 Vinitial_window_system
= Qnil
;
6595 Vwindow_system_version
= Qnil
;