1 /* Synchronize redisplay structures and output changes.
2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
3 Copyright (C) 1995, 1996 Ben Wing.
4 Copyright (C) 1996 Chuck Thompson.
5 Copyright (C) 1999 Andy Piper.
7 This file is part of XEmacs.
9 XEmacs is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with XEmacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* Synched up with: Not in FSF. */
26 /* This file has been Mule-ized. */
28 /* Author: Chuck Thompson */
30 /* Heavily hacked for modularity, gutter and subwindow support by Andy
41 #include "redisplay.h"
44 static int compare_runes (struct window *w, struct rune *crb,
46 static void redraw_cursor_in_window (struct window *w,
47 int run_end_begin_glyphs);
48 static void redisplay_output_display_block (struct window *w, struct display_line *dl,
49 int block, int start, int end, int start_pixpos,
50 int cursor_start, int cursor_width,
52 static void redisplay_normalize_display_box (struct display_box* dest,
53 struct display_glyph_area* src);
54 static int redisplay_display_boxes_in_window_p (struct window* w,
55 struct display_box* db,
56 struct display_glyph_area* dga);
57 static void redisplay_clear_clipped_region (Lisp_Object locale, face_index findex,
58 struct display_box* dest,
59 struct display_glyph_area* glyphsrc,
60 int fullheight_p, Lisp_Object);
62 /*****************************************************************************
65 Synchronize the given rune blocks.
66 ****************************************************************************/
68 sync_rune_structs (struct window *w, rune_dynarr *cra, rune_dynarr *dra)
71 int max_move = ((Dynarr_length (dra) > Dynarr_largest (cra))
72 ? Dynarr_largest (cra)
73 : Dynarr_length (dra));
77 /* #### Doing this directly breaks the encapsulation. But, the
78 running time of this function has a measurable impact on
79 redisplay performance so avoiding all excess overhead is a
80 good thing. Is all of this true? */
81 memcpy (cra->base, dra->base, sizeof (struct rune) * max_move);
82 Dynarr_set_size (cra, max_move);
87 for (rune_elt = max_move; rune_elt < Dynarr_length (dra); rune_elt++)
90 struct rune *drb = Dynarr_atp (dra, rune_elt);
93 memcpy (crb, drb, sizeof (struct rune));
94 Dynarr_add (cra, *crb);
98 /*****************************************************************************
99 sync_display_line_structs
101 For the given LINE in window W, make the current display line equal
102 the desired display line.
103 ****************************************************************************/
105 sync_display_line_structs (struct window *w, int line, int do_blocks,
106 display_line_dynarr *cdla,
107 display_line_dynarr *ddla)
109 int cdla_len = Dynarr_length (cdla);
111 struct display_line dl, *clp, *dlp;
114 dlp = Dynarr_atp (ddla, line);
115 if (line >= Dynarr_largest (cdla))
118 clp->display_blocks = Dynarr_new (display_block);
122 clp = Dynarr_atp (cdla, line);
123 if (clp->display_blocks)
124 Dynarr_reset (clp->display_blocks);
125 if (clp->left_glyphs)
127 Dynarr_free (clp->left_glyphs);
128 clp->left_glyphs = 0;
130 if (clp->right_glyphs)
132 Dynarr_free (clp->right_glyphs);
133 clp->right_glyphs = 0;
137 display_block_dynarr *tdb = clp->display_blocks;
139 memcpy (clp, dlp, sizeof (struct display_line));
140 clp->display_blocks = tdb;
141 clp->left_glyphs = 0;
142 clp->right_glyphs = 0;
145 if (!do_blocks && line >= cdla_len)
147 Dynarr_add (cdla, *clp);
151 for (db_elt = 0; db_elt < Dynarr_length (dlp->display_blocks); db_elt++)
153 struct display_block db, *cdb;
154 struct display_block *ddb = Dynarr_atp (dlp->display_blocks, db_elt);
156 if (db_elt >= Dynarr_largest (clp->display_blocks))
159 memcpy (cdb, ddb, sizeof (struct display_block));
160 cdb->runes = Dynarr_new (rune);
161 Dynarr_add (clp->display_blocks, *cdb);
167 cdb = Dynarr_atp (clp->display_blocks, db_elt);
169 memcpy (cdb, ddb, sizeof (struct display_block));
171 Dynarr_increment (clp->display_blocks);
174 sync_rune_structs (w, cdb->runes, ddb->runes);
177 if (line >= cdla_len)
178 Dynarr_add (cdla, *clp);
181 /*****************************************************************************
184 Compare to runes to see if each of their fields is equal. If so,
185 return true otherwise return false.
186 ****************************************************************************/
188 compare_runes (struct window *w, struct rune *crb, struct rune *drb)
190 /* Do not compare the values of bufpos and endpos. They do not
191 affect the display characteristics. */
193 /* Note: (hanoi 6) spends 95% of its time in redisplay, and about
194 30% here. Not using bitfields for rune.type alone gives a redisplay
197 #### In profile arcs run of a normal Gnus session this function
198 is run 6.76 million times, only to return 1 in 6.73 million of
201 In addition a quick look GCC sparc assembly shows that GCC is not
202 doing a good job here.
203 1. The function is not inlined (too complicated?)
204 2. It seems to be reloading the crb and drb variables all the
206 3. It doesn't seem to notice that the second half of these if's
207 are really a switch statement.
211 #### It would really be worth it to arrange for this function to
212 be (almost) a single call to memcmp. */
214 if ((crb->findex != drb->findex) ||
215 (WINDOW_FACE_CACHEL_DIRTY (w, drb->findex)))
217 else if (crb->xpos != drb->xpos)
219 else if (crb->width != drb->width)
221 else if (crb->cursor_type != drb->cursor_type)
223 else if (crb->type != drb->type)
225 else if (crb->type == RUNE_CHAR &&
226 (crb->object.chr.ch != drb->object.chr.ch))
228 else if (crb->type == RUNE_HLINE &&
229 (crb->object.hline.thickness != drb->object.hline.thickness ||
230 crb->object.hline.yoffset != drb->object.hline.yoffset))
232 else if (crb->type == RUNE_DGLYPH &&
233 (!EQ (crb->object.dglyph.glyph, drb->object.dglyph.glyph) ||
234 !EQ (crb->object.dglyph.extent, drb->object.dglyph.extent) ||
235 crb->object.dglyph.xoffset != drb->object.dglyph.xoffset))
237 /* Only check dirtiness if we know something has changed. */
238 else if (crb->type == RUNE_DGLYPH &&
239 XFRAME (w->frame)->glyphs_changed)
241 glyph_index gindex = get_glyph_cachel_index (w, drb->object.dglyph.glyph);
242 /* Although doing the cachel lookup for every comparison is
243 very expensive.we have to do it to make sure the cache is
245 if (GLYPH_CACHEL_DIRTYP (w, gindex))
254 /*****************************************************************************
255 get_next_display_block
257 Return the next display starting at or overlapping START_POS. Return
258 the start of the next region in NEXT_START.
259 ****************************************************************************/
261 get_next_display_block (layout_bounds bounds, display_block_dynarr *dba,
262 int start_pos, int *next_start)
264 int next_display_block = NO_BLOCK;
268 /* If we don't find a display block covering or starting at
269 start_pos, then we return the starting point of the next display
270 block or the next division boundary, whichever is closer to
274 if (start_pos >= bounds.left_out && start_pos < bounds.left_in)
275 *next_start = bounds.left_in;
276 else if (start_pos < bounds.left_white)
277 *next_start = bounds.left_white;
278 else if (start_pos < bounds.right_white)
279 *next_start = bounds.right_white;
280 else if (start_pos < bounds.right_in)
281 *next_start = bounds.right_in;
282 else if (start_pos <= bounds.right_out)
283 *next_start = bounds.right_out;
288 for (block = 0; block < Dynarr_length (dba); block++)
290 struct display_block *db = Dynarr_atp (dba, block);
292 if (db->start_pos <= start_pos && db->end_pos > start_pos)
294 if ((int) db->type > priority)
297 next_display_block = block;
299 *next_start = db->end_pos;
302 else if (next_start && db->start_pos > start_pos)
304 if (db->start_pos < *next_start)
305 *next_start = db->start_pos;
309 return next_display_block;
312 /*****************************************************************************
313 get_cursor_size_and_location
315 Return the information defining the pixel location of the cursor.
316 ****************************************************************************/
318 get_cursor_size_and_location (struct window *w, struct display_block *db,
320 int *cursor_start, int *cursor_width,
325 int defheight, defwidth;
327 if (Dynarr_length (db->runes) <= cursor_location)
330 XSETWINDOW (window, w);
332 rb = Dynarr_atp (db->runes, cursor_location);
333 *cursor_start = rb->xpos;
335 default_face_height_and_width (window, &defheight, &defwidth);
336 *cursor_height = defheight;
338 if (rb->type == RUNE_BLANK)
339 *cursor_width = defwidth;
341 *cursor_width = rb->width;
344 /*****************************************************************************
345 compare_display_blocks
347 Given two display blocks, output only those areas where they differ.
348 ****************************************************************************/
350 compare_display_blocks (struct window *w, struct display_line *cdl,
351 struct display_line *ddl, int c_block, int d_block,
352 int start_pixpos, int cursor_start, int cursor_width,
355 struct frame *f = XFRAME (w->frame);
356 struct display_block *cdb, *ddb;
362 cdb = Dynarr_atp (cdl->display_blocks, c_block);
363 ddb = Dynarr_atp (ddl->display_blocks, d_block);
365 assert (cdb->type == ddb->type);
368 stop_pos = min (Dynarr_length (cdb->runes), Dynarr_length (ddb->runes));
371 (!Dynarr_length (ddb->runes)
373 : (Dynarr_atp (ddb->runes, Dynarr_length (ddb->runes) - 1)->xpos +
374 Dynarr_atp (ddb->runes, Dynarr_length (ddb->runes) - 1)->width));
376 /* If the new block type is not text and the cursor status is
377 changing and it overlaps the position of this block then force a
378 full redraw of the block in order to make sure that the cursor is
380 if (ddb->type != TEXT
382 /* I'm not sure exactly what this code wants to do, but it's
383 * not right--it doesn't update when cursor_elt changes from, e.g.,
384 * 0 to 8, and the new or old cursor loc overlaps this block.
385 * I've replaced it with the more conservative test below.
386 * -dkindred@cs.cmu.edu 23-Mar-1997 */
387 && ((cdl->cursor_elt == -1 && ddl->cursor_elt != -1)
388 || (cdl->cursor_elt != -1 && ddl->cursor_elt == -1))
389 && (ddl->cursor_elt == -1 ||
392 && (cursor_start + cursor_width) >= start_pixpos
393 && cursor_start <= block_end))
395 && (cdl->cursor_elt != ddl->cursor_elt)
400 if (f->windows_structure_changed ||
401 /* #### Why is this so? We have face cachels so that we don't
402 have to recalculate all the display blocks when faces
403 change. I have fixed this for glyphs and am inclined to think
404 that faces should "Just Work", but I'm not feeling brave
405 today. Maybe its because the face cachels represent merged
406 faces rather than simply instantiations in a particular
409 cdl->ypos != ddl->ypos ||
410 cdl->ascent != ddl->ascent ||
411 cdl->descent != ddl->descent ||
412 cdl->clip != ddl->clip ||
422 while (start_pos < 0 && elt < stop_pos)
424 if (!compare_runes (w, Dynarr_atp (cdb->runes, elt),
425 Dynarr_atp (ddb->runes, elt)))
435 /* If nothing has changed in the area where the blocks overlap, but
436 there are new blocks in the desired block, then adjust the start
437 point accordingly. */
438 if (elt == stop_pos && stop_pos < Dynarr_length (ddb->runes))
439 start_pos = stop_pos;
444 if ((Dynarr_length (ddb->runes) != Dynarr_length (cdb->runes))
447 stop_pos = Dynarr_length (ddb->runes);
451 /* If the lines have the same number of runes and we are not
452 forcing a full redraw because the display line has
453 changed position then we try and optimize how much of the
454 line we actually redraw by scanning backwards from the
455 end for the first changed rune. This optimization is
456 almost always triggered by face changes. */
458 int elt = Dynarr_length (ddb->runes) - 1;
460 while (elt > start_pos)
462 if (!compare_runes (w, Dynarr_atp (cdb->runes, elt),
463 Dynarr_atp (ddb->runes, elt)))
471 redisplay_output_display_block (w, ddl, d_block, start_pos,
472 stop_pos, start_pixpos,
473 cursor_start, cursor_width,
481 /*****************************************************************************
484 Clear the lefthand outside border.
485 ****************************************************************************/
487 clear_left_border (struct window *w, int y, int height)
489 struct frame *f = XFRAME (w->frame);
492 XSETWINDOW (window, w);
493 redisplay_clear_region (window, DEFAULT_INDEX,
494 FRAME_LEFT_BORDER_START (f), y,
495 FRAME_BORDER_WIDTH (f), height);
498 /*****************************************************************************
501 Clear the righthand outside border.
502 ****************************************************************************/
504 clear_right_border (struct window *w, int y, int height)
506 struct frame *f = XFRAME (w->frame);
509 XSETWINDOW (window, w);
510 redisplay_clear_region (window, DEFAULT_INDEX,
511 FRAME_RIGHT_BORDER_START (f),
512 y, FRAME_BORDER_WIDTH (f), height);
515 /*****************************************************************************
518 Ensure that the contents of the given display line is correct
519 on-screen. The force_ parameters are used by redisplay_move_cursor
520 to correctly update cursor locations and only cursor locations.
521 ****************************************************************************/
523 output_display_line (struct window *w, display_line_dynarr *cdla,
524 display_line_dynarr *ddla, int line, int force_start,
528 struct frame *f = XFRAME (w->frame);
529 struct buffer *b = XBUFFER (w->buffer);
530 struct buffer *old_b = window_display_buffer (w);
531 struct display_line *cdl, *ddl;
532 display_block_dynarr *cdba, *ddba;
533 int start_pixpos, end_pixpos;
534 int cursor_start, cursor_width, cursor_height;
536 int force = (force_start >= 0 || force_end >= 0);
537 int clear_border = 0;
540 if (cdla && line < Dynarr_length (cdla))
542 cdl = Dynarr_atp (cdla, line);
543 cdba = cdl->display_blocks;
551 ddl = Dynarr_atp (ddla, line); /* assert line < Dynarr_length (ddla) */
552 ddba = ddl->display_blocks;
554 if (force_start >= 0 && force_start >= ddl->bounds.left_out)
555 start_pixpos = force_start;
557 start_pixpos = ddl->bounds.left_out;
559 if (force_end >= 0 && force_end < ddl->bounds.right_out)
560 end_pixpos = force_end;
562 end_pixpos = ddl->bounds.right_out;
564 /* Get the cursor parameters. */
565 if (ddl->cursor_elt != -1)
567 struct display_block *db;
569 /* If the lines cursor parameter is not -1 then it indicates
570 which rune in the TEXT block contains the cursor. This means
571 that there must be at least one display block. The TEXT
572 block, if present, must always be the first display block. */
573 assert (Dynarr_length (ddba) != 0);
575 db = Dynarr_atp (ddba, 0);
576 assert (db->type == TEXT);
578 get_cursor_size_and_location (w, db, ddl->cursor_elt, &cursor_start,
579 &cursor_width, &cursor_height);
583 cursor_start = cursor_width = cursor_height = 0;
586 /* The modeline should only have a single block and it had better be
590 /* The shadow thickness check is necessary if only the sign of
592 if (cdba && !w->shadow_thickness_changed)
594 must_sync |= compare_display_blocks (w, cdl, ddl, 0, 0,
595 start_pixpos, 0, 0, 0);
599 redisplay_output_display_block (w, ddl, 0, 0, -1, start_pixpos,
608 while (!ddl->modeline && start_pixpos < end_pixpos)
611 int next_start_pixpos;
613 block = get_next_display_block (ddl->bounds, ddba, start_pixpos,
616 /* If we didn't find a block then we should blank the area
617 between start_pos and next_start if necessary. */
618 if (block == NO_BLOCK)
620 /* We only erase those areas which were actually previously
621 covered by a display block unless the window structure
622 changed. In that case we clear all areas since the current
623 structures may actually represent a different buffer. */
624 while (start_pixpos < next_start_pixpos)
630 old_block = get_next_display_block (ddl->bounds, cdba,
631 start_pixpos, &block_end);
634 old_block = NO_BLOCK;
635 block_end = next_start_pixpos;
638 if (!cdba || old_block != NO_BLOCK || b != old_b ||
639 f->windows_structure_changed ||
642 (cdl && (cdl->ypos != ddl->ypos ||
643 cdl->ascent != ddl->ascent ||
644 cdl->descent != ddl->descent ||
645 cdl->top_clip != ddl->top_clip ||
646 cdl->clip != ddl->clip)))
648 int x, y, width, height;
653 y = DISPLAY_LINE_YPOS (ddl);
654 width = min (next_start_pixpos, block_end) - x;
655 height = DISPLAY_LINE_HEIGHT (ddl);
657 if (x < ddl->bounds.left_in)
659 findex = ddl->left_margin_findex ?
660 ddl->left_margin_findex
661 : get_builtin_face_cache_index (w, Vleft_margin_face);
663 else if (x < ddl->bounds.right_in)
665 /* no check here because DEFAULT_INDEX == 0 anyway */
666 findex = ddl->default_findex;
668 else if (x < ddl->bounds.right_out)
670 findex = ddl->right_margin_findex ?
671 ddl->right_margin_findex
672 : get_builtin_face_cache_index (w, Vright_margin_face);
675 findex = (face_index) -1;
677 if (findex != (face_index) -1)
681 XSETWINDOW (window, w);
683 /* Clear the empty area. */
684 redisplay_clear_region (window, findex, x, y, width, height);
686 /* Mark that we should clear the border. This is
687 necessary because italic fonts may leave
688 droppings in the border. */
693 start_pixpos = min (next_start_pixpos, block_end);
698 struct display_block *cdb, *ddb;
703 old_block = get_next_display_block (ddl->bounds, cdba,
704 start_pixpos, &block_end);
706 old_block = NO_BLOCK;
708 ddb = Dynarr_atp (ddba, block);
709 cdb = (old_block != NO_BLOCK ? Dynarr_atp (cdba, old_block) : 0);
711 /* If there was formerly no block over the current
712 region or if it was a block of a different type, then
713 output the entire ddb. Otherwise, compare cdb and
714 ddb and output only the changed region. */
715 if (!force && cdb && ddb->type == cdb->type
716 /* If there was no buffer being display before the
717 compare anyway as we might be outputting a gutter. */
719 (b == old_b || !old_b))
721 must_sync |= compare_display_blocks (w, cdl, ddl, old_block,
723 cursor_start, cursor_width,
732 for (elt = 0; elt < Dynarr_length (ddb->runes); elt++)
734 struct rune *rb = Dynarr_atp (ddb->runes, elt);
736 if (start_pixpos >= rb->xpos
737 && start_pixpos < rb->xpos + rb->width)
740 if (end_pixpos > rb->xpos
741 && end_pixpos <= rb->xpos + rb->width)
744 if (last_elt > Dynarr_length (ddb->runes))
745 last_elt = Dynarr_length (ddb->runes);
751 redisplay_output_display_block (w, ddl, block, first_elt,
754 cursor_start, cursor_width,
758 start_pixpos = next_start_pixpos;
762 /* Clear the internal border if we are next to it and the window
763 structure or frame size has changed or if something caused
764 clear_border to be tripped. */
765 /* #### Doing this on f->clear sucks but is necessary because of
766 window-local background values. */
767 if (f->windows_structure_changed || f->faces_changed || clear_border
770 int y = DISPLAY_LINE_YPOS (ddl);
771 int height = DISPLAY_LINE_HEIGHT (ddl);
773 /* If we are in the gutter then we musn't clear the borders. */
774 if (y >= WINDOW_TEXT_TOP (w) && (y + height) <= WINDOW_TEXT_BOTTOM (w))
778 y -= MODELINE_SHADOW_THICKNESS (w);
779 height += (2 * MODELINE_SHADOW_THICKNESS (w));
782 if (window_is_leftmost (w))
783 clear_left_border (w, y, height);
784 if (window_is_rightmost (w))
785 clear_right_border (w, y, height);
790 sync_display_line_structs (w, line, must_sync, cdla, ddla);
793 /*****************************************************************************
794 redisplay_move_cursor
796 For the given window W, move the cursor to NEW_POINT. Returns a
797 boolean indicating success or failure.
798 ****************************************************************************/
800 #define ADJ_BUFPOS (rb->bufpos + dl->offset)
801 #define ADJ_ENDPOS (rb->endpos + dl->offset)
804 redisplay_move_cursor (struct window *w, Bufpos new_point, int no_output_end)
806 struct frame *f = XFRAME (w->frame);
807 struct device *d = XDEVICE (f->device);
809 display_line_dynarr *cla = window_display_lines (w, CURRENT_DISP);
810 struct display_line *dl;
811 struct display_block *db;
813 int x = w->last_point_x[CURRENT_DISP];
814 int y = w->last_point_y[CURRENT_DISP];
817 * Bail if cursor_in_echo_area is non-zero and we're fiddling with
818 * the cursor in a non-active minibuffer window, since that is a
819 * special case that is handled elsewhere and this function need
820 * not handle it. Return 1 so the caller will assume we
823 if (cursor_in_echo_area && MINI_WINDOW_P (w) &&
824 w != XWINDOW (FRAME_SELECTED_WINDOW (f)))
827 if (y < 0 || y >= Dynarr_length (cla))
830 dl = Dynarr_atp (cla, y);
831 db = get_display_block_from_line (dl, TEXT);
833 if (x < 0 || x >= Dynarr_length (db->runes))
836 rb = Dynarr_atp (db->runes, x);
838 if (rb->cursor_type == CURSOR_OFF)
840 else if (ADJ_BUFPOS == new_point
841 || (ADJ_ENDPOS && (new_point >= ADJ_BUFPOS)
842 && (new_point <= ADJ_ENDPOS)))
844 w->last_point_x[CURRENT_DISP] = x;
845 w->last_point_y[CURRENT_DISP] = y;
846 Fset_marker (w->last_point[CURRENT_DISP], make_int (ADJ_BUFPOS),
853 DEVMETH (d, output_begin, (d));
855 /* #### This is a gross kludge. Cursor handling is such a royal
857 if (rb->type == RUNE_DGLYPH &&
858 (EQ (rb->object.dglyph.glyph, Vtruncation_glyph) ||
859 EQ (rb->object.dglyph.glyph, Vcontinuation_glyph)))
860 rb->cursor_type = NO_CURSOR;
862 rb->cursor_type = CURSOR_OFF;
864 output_display_line (w, 0, cla, y, rb->xpos, rb->xpos + rb->width);
867 w->last_point_x[CURRENT_DISP] = -1;
868 w->last_point_y[CURRENT_DISP] = -1;
869 Fset_marker (w->last_point[CURRENT_DISP], Qnil, w->buffer);
871 /* If this isn't the selected frame, then erasing the old cursor is
872 all we actually had to do. */
873 if (w != XWINDOW (FRAME_SELECTED_WINDOW (device_selected_frame (d))))
876 DEVMETH (d, output_end, (d));
881 /* This should only occur in the minibuffer. */
884 w->last_point_x[CURRENT_DISP] = 0;
885 w->last_point_y[CURRENT_DISP] = y;
886 Fset_marker (w->last_point[CURRENT_DISP], Qzero, w->buffer);
888 rb = Dynarr_atp (db->runes, 0);
889 rb->cursor_type = CURSOR_ON;
892 output_display_line (w, 0, cla, y, rb->xpos, rb->xpos + rb->width);
895 DEVMETH (d, output_end, (d));
904 if (ADJ_BUFPOS < new_point)
910 else /* (rb->bufpos + dl->offset) > new_point */
927 while (up ? (cur_dl < Dynarr_length (cla)) : (cur_dl >= 0))
929 dl = Dynarr_atp (cla, cur_dl);
930 db = get_display_block_from_line (dl, TEXT);
933 cur_rb = Dynarr_length (db->runes) - 1;
935 while ((!scroll_on_clipped_lines || !dl->clip) &&
936 (up ? (cur_rb < Dynarr_length (db->runes)) : (cur_rb >= 0)))
938 rb = Dynarr_atp (db->runes, cur_rb);
940 if (rb->cursor_type != IGNORE_CURSOR
941 && rb->cursor_type != NO_CURSOR &&
942 (ADJ_BUFPOS == new_point
943 || (ADJ_ENDPOS && (new_point >= ADJ_BUFPOS)
944 && (new_point <= ADJ_BUFPOS))))
946 rb->cursor_type = CURSOR_ON;
947 dl->cursor_elt = cur_rb;
950 output_display_line (w, 0, cla, cur_dl, rb->xpos,
951 rb->xpos + rb->width);
953 w->last_point_x[CURRENT_DISP] = cur_rb;
954 w->last_point_y[CURRENT_DISP] = cur_dl;
955 Fset_marker (w->last_point[CURRENT_DISP],
956 make_int (ADJ_BUFPOS), w->buffer);
959 DEVMETH (d, output_end, (d));
963 (up ? cur_rb++ : cur_rb--);
966 (up ? (cur_rb = 0) : (first = 0));
967 (up ? cur_dl++ : cur_dl--);
972 DEVMETH (d, output_end, (d));
978 /*****************************************************************************
979 redraw_cursor_in_window
981 For the given window W, redraw the cursor if it is contained within
983 ****************************************************************************/
985 redraw_cursor_in_window (struct window *w, int run_end_begin_meths)
987 struct frame *f = XFRAME (w->frame);
988 struct device *d = XDEVICE (f->device);
990 display_line_dynarr *dla = window_display_lines (w, CURRENT_DISP);
991 struct display_line *dl;
992 struct display_block *db;
995 int x = w->last_point_x[CURRENT_DISP];
996 int y = w->last_point_y[CURRENT_DISP];
998 if (cursor_in_echo_area && MINI_WINDOW_P (w) &&
999 !echo_area_active (f) && minibuf_level == 0)
1001 MAYBE_DEVMETH (d, set_final_cursor_coords, (f, w->pixel_top, 0));
1004 if (y < 0 || y >= Dynarr_length (dla))
1007 if (MINI_WINDOW_P (w) && f != device_selected_frame (d) &&
1008 !is_surrogate_for_selected_frame (f))
1011 dl = Dynarr_atp (dla, y);
1012 db = get_display_block_from_line (dl, TEXT);
1014 if (x < 0 || x >= Dynarr_length (db->runes))
1017 rb = Dynarr_atp (db->runes, x);
1019 /* Don't call the output routine if the block isn't actually the
1021 if (rb->cursor_type == CURSOR_ON)
1023 MAYBE_DEVMETH (d, set_final_cursor_coords,
1024 (f, dl->ypos - 1, rb->xpos));
1026 if (run_end_begin_meths)
1027 DEVMETH (d, output_begin, (d));
1029 output_display_line (w, 0, dla, y, rb->xpos, rb->xpos + rb->width);
1031 if (run_end_begin_meths)
1032 DEVMETH (d, output_end, (d));
1036 /*****************************************************************************
1037 redisplay_redraw_cursor
1039 For the given frame F, redraw the cursor on the selected window.
1040 This is used to update the cursor after focus changes.
1041 ****************************************************************************/
1043 redisplay_redraw_cursor (struct frame *f, int run_end_begin_meths)
1047 if (!cursor_in_echo_area)
1048 window = FRAME_SELECTED_WINDOW (f);
1049 else if (FRAME_HAS_MINIBUF_P (f))
1050 window = FRAME_MINIBUF_WINDOW (f);
1054 redraw_cursor_in_window (XWINDOW (window), run_end_begin_meths);
1057 /****************************************************************************
1058 redisplay_output_display_block
1060 Given a display line, a block number for that start line, output all
1061 runes between start and end in the specified display block.
1062 ****************************************************************************/
1064 redisplay_output_display_block (struct window *w, struct display_line *dl, int block,
1065 int start, int end, int start_pixpos, int cursor_start,
1066 int cursor_width, int cursor_height)
1068 struct frame *f = XFRAME (w->frame);
1069 struct device *d = XDEVICE (f->device);
1070 struct display_block *db = Dynarr_atp (dl->display_blocks, block);
1071 rune_dynarr *rba = db->runes;
1074 rb = Dynarr_atp (rba, start);
1077 /* Nothing to do so don't do anything. */
1080 xpos = max (start_pixpos, rb->xpos);
1083 end = Dynarr_length (rba);
1085 rb = Dynarr_atp (rba, end - 1);
1086 width = rb->xpos + rb->width - xpos;
1087 /* now actually output the block. */
1088 DEVMETH (d, output_display_block, (w, dl, block, start,
1090 cursor_start, cursor_width,
1094 /****************************************************************************
1095 redisplay_unmap_subwindows
1097 Remove subwindows from the area in the box defined by the given
1099 ****************************************************************************/
1100 static void redisplay_unmap_subwindows (struct frame* f, int x, int y, int width, int height,
1101 Lisp_Object ignored_window)
1105 for (elt = 0; elt < Dynarr_length (f->subwindow_cachels); elt++)
1107 struct subwindow_cachel *cachel =
1108 Dynarr_atp (f->subwindow_cachels, elt);
1110 if (cachel->being_displayed
1112 cachel->x + cachel->width > x && cachel->x < x + width
1114 cachel->y + cachel->height > y && cachel->y < y + height
1116 !EQ (cachel->subwindow, ignored_window))
1118 unmap_subwindow (cachel->subwindow);
1123 /****************************************************************************
1124 redisplay_unmap_subwindows_maybe
1126 Potentially subwindows from the area in the box defined by the given
1128 ****************************************************************************/
1129 void redisplay_unmap_subwindows_maybe (struct frame* f, int x, int y, int width, int height)
1131 if (Dynarr_length (FRAME_SUBWINDOW_CACHE (f)))
1133 redisplay_unmap_subwindows (f, x, y, width, height, Qnil);
1137 static void redisplay_unmap_subwindows_except_us (struct frame* f, int x, int y, int width,
1138 int height, Lisp_Object subwindow)
1140 if (Dynarr_length (FRAME_SUBWINDOW_CACHE (f)))
1142 redisplay_unmap_subwindows (f, x, y, width, height, subwindow);
1146 /****************************************************************************
1147 redisplay_output_subwindow
1149 output a subwindow. This code borrows heavily from the pixmap stuff,
1150 although is much simpler not needing to account for partial
1151 pixmaps, backgrounds etc.
1152 ****************************************************************************/
1154 redisplay_output_subwindow (struct window *w,
1155 Lisp_Object image_instance,
1156 struct display_box* db, struct display_glyph_area* dga,
1157 face_index findex, int cursor_start, int cursor_width,
1160 struct Lisp_Image_Instance *p = XIMAGE_INSTANCE (image_instance);
1162 struct display_glyph_area sdga;
1164 dga->height = IMAGE_INSTANCE_SUBWINDOW_HEIGHT (p);
1165 dga->width = IMAGE_INSTANCE_SUBWINDOW_WIDTH (p);
1167 /* This makes the glyph area fit into the display area. */
1168 if (!redisplay_normalize_glyph_area (db, dga))
1171 XSETWINDOW (window, w);
1173 /* Clear the area the subwindow is going into. */
1174 redisplay_clear_clipped_region (window, findex,
1175 db, dga, 0, image_instance);
1177 /* This shrinks the display box to exactly enclose the glyph
1179 redisplay_normalize_display_box (db, dga);
1181 /* if we can't view the whole window we can't view any of it. We
1182 have to be careful here since we may be being asked to display
1183 part of a subwindow, the rest of which is on-screen as well. We
1184 need to allow this case and map the entire subwindow. We also
1185 need to be careful since the subwindow could be outside the
1186 window in the gutter or modeline - we also need to allow these
1188 sdga.xoffset = -dga->xoffset;
1189 sdga.yoffset = -dga->yoffset;
1190 sdga.height = IMAGE_INSTANCE_SUBWINDOW_HEIGHT (p);
1191 sdga.width = IMAGE_INSTANCE_SUBWINDOW_WIDTH (p);
1193 if (redisplay_display_boxes_in_window_p (w, db, &sdga) < 0)
1195 map_subwindow (image_instance, db->xpos, db->ypos, dga);
1199 sdga.xoffset = sdga.yoffset = 0;
1200 map_subwindow (image_instance, db->xpos - dga->xoffset,
1201 db->ypos - dga->yoffset, &sdga);
1205 /****************************************************************************
1206 redisplay_output_layout
1208 Output a widget hierarchy. This can safely call itself recursively.
1209 ****************************************************************************/
1211 redisplay_output_layout (struct window *w,
1212 Lisp_Object image_instance,
1213 struct display_box* db, struct display_glyph_area* dga,
1214 face_index findex, int cursor_start, int cursor_width,
1217 struct Lisp_Image_Instance *p = XIMAGE_INSTANCE (image_instance);
1218 Lisp_Object window, rest;
1219 Emchar_dynarr *buf = Dynarr_new (Emchar);
1220 struct frame *f = XFRAME (w->frame);
1221 struct device *d = XDEVICE (f->device);
1222 int layout_height, layout_width;
1223 /* We bogusly don't take f->extents_changed and f->glyphs_changed
1224 into account. This is because if we do we always redisplay the
1225 entire layout. So far I have seen no ill effects to we'll see. */
1226 int frame_really_changed = (f->buffers_changed ||
1230 f->modeline_changed ||
1231 f->subwindows_changed ||
1232 f->windows_changed ||
1233 f->windows_structure_changed);
1235 XSETWINDOW (window, w);
1237 layout_height = glyph_height (image_instance, window);
1238 layout_width = glyph_width (image_instance, window);
1240 dga->height = layout_height;
1241 dga->width = layout_width;
1243 /* This makes the glyph area fit into the display area. */
1244 if (!redisplay_normalize_glyph_area (db, dga))
1247 /* Highly dodgy optimization. We want to only output the whole
1248 layout if we really have to. */
1249 if (frame_really_changed || IMAGE_INSTANCE_DIRTYP (p))
1251 /* First clear the area we are drawing into. This is the easiest
1252 thing to do since we have many gaps that we have to make sure are
1254 redisplay_clear_clipped_region (window, findex, db, dga, 1, Qnil);
1256 /* Output a border if required */
1257 if (!NILP (IMAGE_INSTANCE_LAYOUT_BORDER (p)))
1260 enum edge_style style;
1261 int ypos = db->ypos;
1262 int height = dga->height;
1264 if (dga->xoffset >= 0)
1266 if (dga->width - dga->xoffset == layout_width)
1267 edges |= EDGE_RIGHT;
1268 if (dga->yoffset >= 0)
1270 if (dga->height - dga->yoffset == layout_height)
1271 edges |= EDGE_BOTTOM;
1273 if (EQ (IMAGE_INSTANCE_LAYOUT_BORDER (p), Qetched_in))
1274 style = EDGE_ETCHED_IN;
1275 else if (EQ (IMAGE_INSTANCE_LAYOUT_BORDER (p), Qetched_out))
1276 style = EDGE_ETCHED_OUT;
1277 else if (EQ (IMAGE_INSTANCE_LAYOUT_BORDER (p), Qbevel_in))
1278 style = EDGE_BEVEL_IN;
1279 else if (INTP (IMAGE_INSTANCE_LAYOUT_BORDER (p)))
1281 style = EDGE_ETCHED_IN;
1282 if (edges & EDGE_TOP)
1284 ypos += XINT (IMAGE_INSTANCE_LAYOUT_BORDER (p));
1285 height -= XINT (IMAGE_INSTANCE_LAYOUT_BORDER (p));
1289 style = EDGE_BEVEL_OUT;
1291 MAYBE_DEVMETH (d, bevel_area,
1292 (w, findex, db->xpos,
1294 dga->width, height, 2, edges, style));
1298 /* This shrinks the display box to exactly enclose the glyph
1300 redisplay_normalize_display_box (db, dga);
1302 /* Flip through the widgets in the layout displaying as necessary */
1303 LIST_LOOP (rest, IMAGE_INSTANCE_LAYOUT_CHILDREN (p))
1305 Lisp_Object child = XCAR (rest);
1307 struct display_box cdb;
1308 /* For losing HP-UX */
1309 cdb.xpos = db->xpos;
1310 cdb.ypos = db->ypos;
1311 cdb.width = db->width;
1312 cdb.height = db->height;
1314 /* First determine if the image is visible at all */
1315 if (IMAGE_INSTANCEP (child))
1317 struct Lisp_Image_Instance* childii = XIMAGE_INSTANCE (child);
1318 /* The enclosing layout offsets are +ve at this point */
1319 struct display_glyph_area cdga;
1320 cdga.xoffset = IMAGE_INSTANCE_XOFFSET (childii) - dga->xoffset;
1321 cdga.yoffset = IMAGE_INSTANCE_YOFFSET (childii) - dga->yoffset;
1322 cdga.width = glyph_width (child, window);
1323 cdga.height = glyph_height (child, window);
1325 /* Although normalization is done by the output routines
1326 we have to do it here so that they don't try and
1327 clear all of db. This is true below also. */
1328 if (redisplay_normalize_glyph_area (&cdb, &cdga))
1330 redisplay_normalize_display_box (&cdb, &cdga);
1331 /* Since the display boxes will now be totally in the
1332 window if they are visible at all we can now check this easily. */
1333 if (cdb.xpos < db->xpos || cdb.ypos < db->ypos
1334 || cdb.xpos + cdb.width > db->xpos + db->width
1335 || cdb.ypos + cdb.height > db->ypos + db->height)
1337 /* We have to invert the offset here as normalization
1338 will have made them positive which the output
1339 routines will treat as a truely +ve offset. */
1340 cdga.xoffset = -cdga.xoffset;
1341 cdga.yoffset = -cdga.yoffset;
1343 switch (IMAGE_INSTANCE_TYPE (childii))
1347 /* #### This is well hacked and could use some
1349 if (redisplay_normalize_glyph_area (&cdb, &cdga)
1351 (frame_really_changed || IMAGE_INSTANCE_DIRTYP (childii)))
1353 struct display_line dl; /* this is fake */
1354 Lisp_Object string =
1355 IMAGE_INSTANCE_TEXT_STRING (childii);
1356 convert_bufbyte_string_into_emchar_dynarr
1357 (XSTRING_DATA (string), XSTRING_LENGTH (string), buf);
1359 redisplay_normalize_display_box (&cdb, &cdga);
1360 /* Offsets are now +ve again so be careful
1361 when fixing up the display line. */
1363 /* Munge boxes into display lines. */
1364 dl.ypos = (cdb.ypos - cdga.yoffset)
1365 + glyph_ascent (child, window);
1366 dl.ascent = glyph_ascent (child, window);
1367 dl.descent = glyph_descent (child, window);
1368 dl.top_clip = cdga.yoffset;
1369 dl.clip = (dl.ypos + dl.descent) - (cdb.ypos + cdb.height);
1370 /* output_string doesn't understand offsets in
1371 the same way as other routines - we have to
1372 add the offset to the width so that we
1373 output the full string. */
1374 MAYBE_DEVMETH (d, output_string, (w, &dl, buf, cdb.xpos,
1375 cdga.xoffset, cdb.xpos,
1376 cdga.width + cdga.xoffset,
1377 findex, 0, 0, 0, 0));
1383 case IMAGE_MONO_PIXMAP:
1384 case IMAGE_COLOR_PIXMAP:
1385 if (frame_really_changed || IMAGE_INSTANCE_DIRTYP (childii))
1386 redisplay_output_pixmap (w, child, &cdb, &cdga, findex,
1391 case IMAGE_SUBWINDOW:
1392 if (frame_really_changed || IMAGE_INSTANCE_DIRTYP (childii))
1393 redisplay_output_subwindow (w, child, &cdb, &cdga, findex,
1398 redisplay_output_layout (w, child, &cdb, &cdga, findex,
1403 /* nothing is as nothing does */
1416 /****************************************************************************
1417 redisplay_output_pixmap
1421 ****************************************************************************/
1423 redisplay_output_pixmap (struct window *w,
1424 Lisp_Object image_instance,
1425 struct display_box* db, struct display_glyph_area* dga,
1426 face_index findex, int cursor_start, int cursor_width,
1427 int cursor_height, int offset_bitmap)
1429 struct frame *f = XFRAME (w->frame);
1430 struct device *d = XDEVICE (f->device);
1431 struct Lisp_Image_Instance *p = XIMAGE_INSTANCE (image_instance);
1433 XSETWINDOW (window, w);
1435 dga->height = IMAGE_INSTANCE_PIXMAP_HEIGHT (p);
1436 dga->width = IMAGE_INSTANCE_PIXMAP_WIDTH (p);
1438 /* This makes the glyph area fit into the display area. */
1439 if (!redisplay_normalize_glyph_area (db, dga))
1442 /* Clear the area the pixmap is going into. The pixmap itself will
1443 always take care of the full width. We don't want to clear where
1444 it is going to go in order to avoid flicker. So, all we have to
1445 take care of is any area above or below the pixmap. If the pixmap
1446 has a mask in which case we have to clear the whole damn thing
1447 since we can't yet clear just the area not included in the
1451 redisplay_clear_clipped_region (window, findex,
1453 (int)IMAGE_INSTANCE_PIXMAP_MASK (p),
1456 /* This shrinks the display box to exactly enclose the glyph
1458 redisplay_normalize_display_box (db, dga);
1460 assert (db->xpos >= 0 && db->ypos >= 0);
1462 MAYBE_DEVMETH (d, output_pixmap, (w, image_instance,
1464 findex, cursor_start,
1465 cursor_width, cursor_height,
1469 /****************************************************************************
1470 redisplay_clear_region
1472 Clear the area in the box defined by the given parameters using the
1473 given face. This has been generalised so that subwindows can be
1474 coped with effectively.
1475 ****************************************************************************/
1477 redisplay_clear_region (Lisp_Object locale, face_index findex, int x, int y,
1478 int width, int height)
1480 struct window *w = NULL;
1481 struct frame *f = NULL;
1483 Lisp_Object background_pixmap = Qunbound;
1484 Lisp_Object fcolor = Qnil, bcolor = Qnil;
1486 if (!width || !height)
1489 if (WINDOWP (locale))
1491 w = XWINDOW (locale);
1492 f = XFRAME (w->frame);
1494 else if (FRAMEP (locale))
1497 f = XFRAME (locale);
1502 d = XDEVICE (f->device);
1504 /* if we have subwindows in the region we have to unmap them */
1505 redisplay_unmap_subwindows_maybe (f, x, y, width, height);
1507 /* #### This isn't quite right for when this function is called
1508 from the toolbar code. */
1510 /* Don't use a backing pixmap in the border area */
1511 if (x >= FRAME_LEFT_BORDER_END (f)
1512 && x < FRAME_RIGHT_BORDER_START (f)
1513 && y >= FRAME_TOP_BORDER_END (f)
1514 && y < FRAME_BOTTOM_BORDER_START (f))
1520 temp = WINDOW_FACE_CACHEL_BACKGROUND_PIXMAP (w, findex);
1522 if (IMAGE_INSTANCEP (temp)
1523 && IMAGE_INSTANCE_PIXMAP_TYPE_P (XIMAGE_INSTANCE (temp)))
1525 /* #### maybe we could implement such that a string
1526 can be a background pixmap? */
1527 background_pixmap = temp;
1532 temp = FACE_BACKGROUND_PIXMAP (Vdefault_face, locale);
1534 if (IMAGE_INSTANCEP (temp)
1535 && IMAGE_INSTANCE_PIXMAP_TYPE_P (XIMAGE_INSTANCE (temp)))
1537 background_pixmap = temp;
1542 if (!UNBOUNDP (background_pixmap) &&
1543 XIMAGE_INSTANCE_PIXMAP_DEPTH (background_pixmap) == 0)
1547 fcolor = WINDOW_FACE_CACHEL_FOREGROUND (w, findex);
1548 bcolor = WINDOW_FACE_CACHEL_BACKGROUND (w, findex);
1552 fcolor = FACE_FOREGROUND (Vdefault_face, locale);
1553 bcolor = FACE_BACKGROUND (Vdefault_face, locale);
1559 WINDOW_FACE_CACHEL_BACKGROUND (w, findex) :
1560 FACE_BACKGROUND (Vdefault_face, locale));
1564 if (UNBOUNDP (background_pixmap))
1565 background_pixmap = Qnil;
1567 DEVMETH (d, clear_region,
1568 (locale, d, f, findex, x, y, width, height, fcolor, bcolor, background_pixmap));
1571 /****************************************************************************
1572 redisplay_clear_clipped_region
1574 Clear the area in the dest display_box not covered by the src
1575 display_glyph_area using the given face. This is a common occurance
1576 for images shorter than the display line. Clipping can be played
1577 around with by altering these. glyphsrc should be normalized.
1578 ****************************************************************************/
1580 redisplay_clear_clipped_region (Lisp_Object window, face_index findex,
1581 struct display_box* dest, struct display_glyph_area* glyphsrc,
1582 int fullheight_p, Lisp_Object ignored_subwindow)
1584 /* assume dest->xpos >= 0 */
1586 struct frame* f = XFRAME (XWINDOW (window)->frame);
1588 if (glyphsrc->xoffset > 0)
1590 clear_x = dest->xpos + glyphsrc->xoffset;
1594 clear_x = dest->xpos;
1597 /* If we need the whole height cleared then just do it. */
1600 redisplay_clear_region (window, findex, clear_x, dest->ypos,
1601 glyphsrc->width, dest->height);
1605 int yoffset = (glyphsrc->yoffset > 0 ? glyphsrc->yoffset : 0);
1607 /* We need to make sure that subwindows are unmapped from the
1609 redisplay_unmap_subwindows_except_us (f, clear_x, dest->ypos,
1610 glyphsrc->width, dest->height,
1612 /* first the top box */
1615 redisplay_clear_region (window, findex, clear_x, dest->ypos,
1616 glyphsrc->width, yoffset);
1619 /* Then the bottom box */
1620 if (yoffset + glyphsrc->height < dest->height)
1622 redisplay_clear_region (window, findex, clear_x,
1623 dest->ypos + yoffset + glyphsrc->height,
1625 dest->height - (yoffset + glyphsrc->height));
1631 /*****************************************************************************
1632 redisplay_normalize_glyph_area
1633 redisplay_normalize_display_box
1635 Calculate the visible box for displaying src in dest.
1636 ****************************************************************************/
1638 redisplay_normalize_glyph_area (struct display_box* dest,
1639 struct display_glyph_area* glyphsrc)
1641 if (dest->xpos + glyphsrc->xoffset > dest->xpos + dest->width
1643 dest->ypos + glyphsrc->yoffset > dest->ypos + dest->height
1645 -glyphsrc->xoffset >= glyphsrc->width
1647 -glyphsrc->yoffset >= glyphsrc->height)
1649 /* It's all clipped out */
1653 /* Horizontal offsets. This works because xoffset can be -ve as well as +ve */
1654 if (dest->xpos + glyphsrc->xoffset + glyphsrc->width > dest->xpos + dest->width)
1656 if (glyphsrc->xoffset > 0)
1657 glyphsrc->width = dest->width - glyphsrc->xoffset;
1659 glyphsrc->width = dest->width;
1662 if (glyphsrc->xoffset < 0)
1663 glyphsrc->width += glyphsrc->xoffset;
1665 /* Vertical offsets. This works because yoffset can be -ve as well as +ve */
1666 if (dest->ypos + glyphsrc->yoffset + glyphsrc->height > dest->ypos + dest->height)
1668 if (glyphsrc->yoffset > 0)
1669 glyphsrc->height = dest->height - glyphsrc->yoffset;
1671 glyphsrc->height = dest->height;
1674 if (glyphsrc->yoffset < 0)
1675 glyphsrc->height += glyphsrc->yoffset;
1681 redisplay_normalize_display_box (struct display_box* dest,
1682 struct display_glyph_area* glyphsrc)
1684 /* Adjust the destination area. At the end of this the destination
1685 area will exactly enclose the glyph area. The only remaining
1686 adjustment will be offsets into the glyph area. */
1688 /* Horizontal adjustment. */
1689 if (glyphsrc->xoffset > 0)
1691 dest->xpos += glyphsrc->xoffset;
1692 dest->width -= glyphsrc->xoffset;
1693 glyphsrc->xoffset = 0;
1696 glyphsrc->xoffset = -glyphsrc->xoffset;
1698 if (glyphsrc->width < dest->width)
1699 dest->width = glyphsrc->width;
1701 /* Vertical adjustment. */
1702 if (glyphsrc->yoffset > 0)
1704 dest->ypos += glyphsrc->yoffset;
1705 dest->height -= glyphsrc->yoffset;
1706 glyphsrc->yoffset = 0;
1709 glyphsrc->yoffset = -glyphsrc->yoffset;
1711 if (glyphsrc->height < dest->height)
1712 dest->height = glyphsrc->height;
1715 /*****************************************************************************
1716 redisplay_display_boxes_in_window_p
1718 Determine whether the require display_glyph_area is completely inside
1719 the window. 0 means the display_box is not in the window. 1 means the
1720 display_box and the display_glyph_area are in the window. -1 means
1721 the display_box is in the window but the display_glyph_area is not.
1722 ****************************************************************************/
1724 redisplay_display_boxes_in_window_p (struct window* w,
1725 struct display_box* db,
1726 struct display_glyph_area* dga)
1728 int left = WINDOW_TEXT_LEFT (w);
1729 int right = WINDOW_TEXT_RIGHT (w);
1730 int top = WINDOW_TEXT_TOP (w);
1731 int bottom = WINDOW_TEXT_BOTTOM (w);
1733 if (db->xpos < left || db->ypos < top
1734 || db->xpos + db->width > right
1735 || db->ypos + db->height > bottom)
1736 /* We are not displaying in a window at all */
1739 if (db->xpos + dga->xoffset >= left
1741 db->ypos + dga->yoffset >= top
1743 db->xpos + dga->xoffset + dga->width <= right
1745 db->ypos + dga->yoffset + dga->height <= bottom)
1751 /*****************************************************************************
1752 redisplay_calculate_display_boxes
1754 Convert from rune/display_line co-ordinates to display_box
1756 ****************************************************************************/
1758 redisplay_calculate_display_boxes (struct display_line *dl, int xpos,
1759 int xoffset, int start_pixpos, int width,
1760 struct display_box* dest,
1761 struct display_glyph_area* src)
1764 dest->ypos = DISPLAY_LINE_YPOS (dl);
1765 dest->width = width;
1766 dest->height = DISPLAY_LINE_HEIGHT (dl);
1768 src->xoffset = -xoffset;
1769 src->yoffset = -dl->top_clip;
1773 if (start_pixpos >=0 && start_pixpos > xpos)
1775 /* Oops, we're asking for a start outside of the displayable
1777 if (start_pixpos > xpos + width)
1779 dest->xpos = start_pixpos;
1780 dest->width -= (start_pixpos - xpos);
1781 /* Offsets are -ve when we want to clip pixels off the displayed
1783 src->xoffset -= (start_pixpos - xpos);
1789 /*****************************************************************************
1790 redisplay_clear_top_of_window
1792 If window is topmost, clear the internal border above it.
1793 ****************************************************************************/
1795 redisplay_clear_top_of_window (struct window *w)
1798 XSETWINDOW (window, w);
1800 if (!NILP (Fwindow_highest_p (window)))
1802 struct frame *f = XFRAME (w->frame);
1803 int x, y, width, height;
1806 width = w->pixel_width;
1808 if (window_is_leftmost (w))
1810 x -= FRAME_BORDER_WIDTH (f);
1811 width += FRAME_BORDER_WIDTH (f);
1813 if (window_is_rightmost (w))
1814 width += FRAME_BORDER_WIDTH (f);
1816 y = FRAME_TOP_BORDER_START (f) - 1;
1817 height = FRAME_BORDER_HEIGHT (f) + 1;
1819 redisplay_clear_region (window, DEFAULT_INDEX, x, y, width, height);
1823 /*****************************************************************************
1824 redisplay_clear_to_window_end
1826 Clear the area between ypos1 and ypos2. Each margin area and the
1827 text area is handled separately since they may each have their own
1829 ****************************************************************************/
1831 redisplay_clear_to_window_end (struct window *w, int ypos1, int ypos2)
1833 struct frame *f = XFRAME (w->frame);
1834 struct device *d = XDEVICE (f->device);
1836 if (HAS_DEVMETH_P (d, clear_to_window_end))
1837 DEVMETH (d, clear_to_window_end, (w, ypos1, ypos2));
1840 int height = ypos2 - ypos1;
1845 int bflag = 0 ; /* (window_needs_vertical_divider (w) ? 0 : 1);*/
1846 layout_bounds bounds;
1848 bounds = calculate_display_line_boundaries (w, bflag);
1849 XSETWINDOW (window, w);
1851 if (window_is_leftmost (w))
1852 redisplay_clear_region (window, DEFAULT_INDEX, FRAME_LEFT_BORDER_START (f),
1853 ypos1, FRAME_BORDER_WIDTH (f), height);
1855 if (bounds.left_in - bounds.left_out > 0)
1856 redisplay_clear_region (window,
1857 get_builtin_face_cache_index (w, Vleft_margin_face),
1858 bounds.left_out, ypos1,
1859 bounds.left_in - bounds.left_out, height);
1861 if (bounds.right_in - bounds.left_in > 0)
1862 redisplay_clear_region (window,
1864 bounds.left_in, ypos1,
1865 bounds.right_in - bounds.left_in, height);
1867 if (bounds.right_out - bounds.right_in > 0)
1868 redisplay_clear_region (window,
1869 get_builtin_face_cache_index (w, Vright_margin_face),
1870 bounds.right_in, ypos1,
1871 bounds.right_out - bounds.right_in, height);
1873 if (window_is_rightmost (w))
1874 redisplay_clear_region (window, DEFAULT_INDEX, FRAME_RIGHT_BORDER_START (f),
1875 ypos1, FRAME_BORDER_WIDTH (f), height);
1880 /*****************************************************************************
1881 redisplay_clear_bottom_of_window
1883 Clear window from right below the last display line to right above
1884 the modeline. The calling function can limit the area actually
1885 erased by setting min_start and/or max_end to positive values.
1886 ****************************************************************************/
1888 redisplay_clear_bottom_of_window (struct window *w, display_line_dynarr *ddla,
1889 int min_start, int max_end)
1891 struct frame *f = XFRAME (w->frame);
1893 int ddla_len = Dynarr_length (ddla);
1895 ypos2 = WINDOW_TEXT_BOTTOM (w);
1896 #ifdef HAVE_SCROLLBARS
1897 /* This adjustment is to catch the intersection of any scrollbars. */
1898 if (f->windows_structure_changed && NILP (w->scrollbar_on_top_p))
1899 ypos2 += window_scrollbar_height (w);
1904 if (ddla_len == 1 && Dynarr_atp (ddla, 0)->modeline)
1906 ypos1 = WINDOW_TEXT_TOP (w);
1907 #ifdef HAVE_SCROLLBARS
1908 /* This adjustment is to catch the intersection of any scrollbars. */
1909 if (f->windows_structure_changed && !NILP (w->scrollbar_on_top_p))
1910 ypos1 -= window_scrollbar_height (w);
1915 struct display_line *dl = Dynarr_atp (ddla, ddla_len - 1);
1916 ypos1 = dl->ypos + dl->descent - dl->clip;
1920 ypos1 = WINDOW_TEXT_TOP (w);
1922 /* #### See if this can be made conditional on the frame
1924 if (MINI_WINDOW_P (w))
1925 ypos2 += FRAME_BORDER_HEIGHT (f);
1927 if (min_start >= 0 && ypos1 < min_start)
1929 if (max_end >= 0 && ypos2 > max_end)
1935 redisplay_clear_to_window_end (w, ypos1, ypos2);
1938 /*****************************************************************************
1939 redisplay_update_line
1941 This is used during incremental updates to update a single line and
1942 correct the offsets on all lines below it. At the moment
1943 update_values is false if we are only updating the modeline.
1944 ****************************************************************************/
1946 redisplay_update_line (struct window *w, int first_line, int last_line,
1949 struct frame *f = XFRAME (w->frame);
1950 struct device *d = XDEVICE (f->device);
1952 display_line_dynarr *cdla = window_display_lines (w, CURRENT_DISP);
1953 display_line_dynarr *ddla = window_display_lines (w, DESIRED_DISP);
1955 DEVMETH (d, output_begin, (d));
1957 while (first_line <= last_line)
1959 Charcount old_len = (Dynarr_atp (cdla, first_line)->end_bufpos -
1960 Dynarr_atp (cdla, first_line)->bufpos);
1961 Charcount new_len = (Dynarr_atp (ddla, first_line)->end_bufpos -
1962 Dynarr_atp (ddla, first_line)->bufpos);
1964 assert (Dynarr_length (cdla) == Dynarr_length (ddla));
1966 /* Output the changes. */
1967 output_display_line (w, cdla, ddla, first_line, -1, -1);
1969 /* Update the offsets. */
1972 int cur_line = first_line + 1;
1973 while (cur_line < Dynarr_length (cdla))
1975 Dynarr_atp (cdla, cur_line)->offset += (new_len - old_len);
1976 Dynarr_atp (ddla, cur_line)->offset += (new_len - old_len);
1981 /* Update the window_end_pos and other settings. */
1984 w->window_end_pos[CURRENT_DISP] -= (new_len - old_len);
1986 if (Dynarr_atp (ddla, first_line)->cursor_elt != -1)
1988 w->last_point_x[CURRENT_DISP] = w->last_point_x[DESIRED_DISP];
1989 w->last_point_y[CURRENT_DISP] = w->last_point_y[DESIRED_DISP];
1996 /* Update the window max line length. We have to scan the entire
1997 set of display lines otherwise we might not detect if the max is
1998 supposed to shrink. */
2003 w->max_line_len = 0;
2004 while (line < Dynarr_length (ddla))
2006 struct display_line *dl = Dynarr_atp (ddla, line);
2009 w->max_line_len = max (dl->num_chars, w->max_line_len);
2015 w->last_modified[CURRENT_DISP] = w->last_modified[DESIRED_DISP];
2016 w->last_facechange[CURRENT_DISP] = w->last_facechange[DESIRED_DISP];
2017 Fset_marker (w->last_point[CURRENT_DISP],
2018 Fmarker_position (w->last_point[DESIRED_DISP]), w->buffer);
2019 Fset_marker (w->last_start[CURRENT_DISP],
2020 Fmarker_position (w->last_start[DESIRED_DISP]), w->buffer);
2022 /* We don't bother updating the vertical scrollbars here. This
2023 gives us a performance increase while having minimal loss of
2024 quality to the scrollbar slider size and position since when this
2025 function is called we know that the changes to the buffer were
2026 very localized. We have to update the horizontal scrollbars,
2027 though, because this routine could cause a change which has a
2028 larger impact on their sizing. */
2029 /* #### See if we can get away with only calling this if
2030 max_line_len is greater than the window_char_width. */
2031 #if defined(HAVE_SCROLLBARS) && defined(HAVE_X_WINDOWS)
2033 extern int stupid_vertical_scrollbar_drag_hack;
2035 update_window_scrollbars (w, NULL, 1, stupid_vertical_scrollbar_drag_hack);
2036 stupid_vertical_scrollbar_drag_hack = 1;
2040 /* This has to be done after we've updated the values. We don't
2041 call output_end for tty frames. Redisplay will do this after all
2042 tty windows have been updated. This cuts down on cursor
2044 if (FRAME_TTY_P (f))
2045 redisplay_redraw_cursor (f, 0);
2047 DEVMETH (d, output_end, (d));
2050 /*****************************************************************************
2051 redisplay_output_window
2053 For the given window W, ensure that the current display lines are
2054 equal to the desired display lines, outputing changes as necessary.
2056 #### Fuck me. This just isn't going to cut it for tty's. The output
2057 decisions for them must be based on the contents of the entire frame
2058 because that is how the available output capabilities think. The
2059 solution is relatively simple. Create redisplay_output_frame. This
2060 will basically merge all of the separate window display structs into
2061 a single one for the frame. This combination structure will be able
2062 to be passed to the same output_display_line which works for windows
2063 on X frames and the right things will happen. It just takes time to
2065 ****************************************************************************/
2067 redisplay_output_window (struct window *w)
2069 struct frame *f = XFRAME (w->frame);
2070 struct device *d = XDEVICE (f->device);
2072 display_line_dynarr *cdla = window_display_lines (w, CURRENT_DISP);
2073 display_line_dynarr *ddla = window_display_lines (w, DESIRED_DISP);
2075 int cdla_len = Dynarr_length (cdla);
2076 int ddla_len = Dynarr_length (ddla);
2079 int need_to_clear_bottom = 0;
2080 int need_to_clear_start = -1;
2081 int need_to_clear_end = -1;
2083 /* Backgrounds may have changed or windows may have gone away
2084 leaving dividers lying around. */
2085 if (f->faces_changed
2086 || f->windows_structure_changed
2087 || w->shadow_thickness_changed)
2088 need_to_clear_bottom = 1;
2090 /* The first thing we do is determine if we are going to need to
2091 clear the bottom of the window. We only need to do this if the
2092 bottom of the current display lines is below the bottom of the
2093 desired display lines. Note that the number of lines is
2094 irrelevant. Only the position matters. We also clear to the
2095 bottom of the window if the modeline has shifted position. */
2096 /* #### We can't blindly not clear the bottom if f->clear is true
2097 since there might be a window-local background. However, for
2098 those cases where there isn't, clearing the end of the window in
2100 if (!need_to_clear_bottom)
2102 struct display_line *cdl, *ddl;
2104 /* If the modeline has changed position or size, clear the bottom
2106 if (!need_to_clear_bottom)
2111 cdl = Dynarr_atp (cdla, 0);
2113 ddl = Dynarr_atp (ddla, 0);
2116 need_to_clear_bottom = 1;
2117 else if ((!cdl->modeline && ddl->modeline)
2118 || (cdl->modeline && !ddl->modeline))
2119 need_to_clear_bottom = 1;
2120 else if (cdl->ypos != ddl->ypos ||
2121 cdl->ascent != ddl->ascent ||
2122 cdl->descent != ddl->descent ||
2123 cdl->clip != ddl->clip)
2124 need_to_clear_bottom = 1;
2126 /* #### This kludge is to make sure the modeline shadows get
2127 redrawn if the modeline position shifts. */
2128 if (need_to_clear_bottom)
2129 w->shadow_thickness_changed = 1;
2132 if (!need_to_clear_bottom)
2137 cdl = Dynarr_atp (cdla, cdla_len - 1);
2139 ddl = Dynarr_atp (ddla, ddla_len - 1);
2142 need_to_clear_bottom = 1;
2145 int cdl_bottom, ddl_bottom;
2147 cdl_bottom = cdl->ypos + cdl->descent;
2148 ddl_bottom = ddl->ypos + ddl->descent;
2150 if (cdl_bottom > ddl_bottom)
2152 need_to_clear_bottom = 1;
2153 need_to_clear_start = ddl_bottom;
2154 need_to_clear_end = cdl_bottom;
2160 /* Perform any output initialization. */
2161 DEVMETH (d, output_begin, (d));
2163 /* If the window's structure has changed clear the internal border
2164 above it if it is topmost (the function will check). */
2165 if (f->windows_structure_changed)
2166 redisplay_clear_top_of_window (w);
2168 /* Output each line. */
2169 for (line = 0; line < Dynarr_length (ddla); line++)
2171 output_display_line (w, cdla, ddla, line, -1, -1);
2174 /* If the number of display lines has shrunk, adjust. */
2175 if (cdla_len > ddla_len)
2177 Dynarr_length (cdla) = ddla_len;
2180 /* Output a vertical divider between windows, if necessary. */
2181 if (window_needs_vertical_divider (w)
2182 && (f->windows_structure_changed || f->clear))
2184 DEVMETH (d, output_vertical_divider, (w, f->windows_structure_changed));
2187 /* Clear the rest of the window, if necessary. */
2188 if (need_to_clear_bottom)
2190 redisplay_clear_bottom_of_window (w, ddla, need_to_clear_start,
2194 w->window_end_pos[CURRENT_DISP] = w->window_end_pos[DESIRED_DISP];
2195 Fset_marker (w->start[CURRENT_DISP],
2196 make_int (marker_position (w->start[DESIRED_DISP])),
2198 Fset_marker (w->pointm[CURRENT_DISP],
2199 make_int (marker_position (w->pointm[DESIRED_DISP])),
2201 w->last_modified[CURRENT_DISP] = w->last_modified[DESIRED_DISP];
2202 w->last_facechange[CURRENT_DISP] = w->last_facechange[DESIRED_DISP];
2203 Fset_marker (w->last_start[CURRENT_DISP],
2204 Fmarker_position (w->last_start[DESIRED_DISP]), w->buffer);
2205 Fset_marker (w->last_point[CURRENT_DISP],
2206 Fmarker_position (w->last_point[DESIRED_DISP]), w->buffer);
2207 w->last_point_x[CURRENT_DISP] = w->last_point_x[DESIRED_DISP];
2208 w->last_point_y[CURRENT_DISP] = w->last_point_y[DESIRED_DISP];
2209 w->shadow_thickness_changed = 0;
2211 set_window_display_buffer (w, XBUFFER (w->buffer));
2212 find_window_mirror (w)->truncate_win = window_truncation_on (w);
2214 /* Overkill on invalidating the cache. It is very bad for it to not
2215 get invalidated when it should be. */
2216 INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE (d);
2218 /* We don't call output_end for tty frames. Redisplay will do this
2219 after all tty windows have been updated. This cuts down on
2221 if (FRAME_TTY_P (f))
2222 redisplay_redraw_cursor (f, 0);
2224 DEVMETH (d, output_end, (d));
2226 #ifdef HAVE_SCROLLBARS
2227 update_window_scrollbars (w, NULL, !MINI_WINDOW_P (w), 0);
2231 /*****************************************************************************
2234 Draw a 3d border around the modeline on window W.
2235 ****************************************************************************/
2237 bevel_modeline (struct window *w, struct display_line *dl)
2239 struct frame *f = XFRAME (w->frame);
2240 struct device *d = XDEVICE (f->device);
2241 int x, y, width, height;
2242 int shadow_thickness = MODELINE_SHADOW_THICKNESS (w);
2243 enum edge_style style;
2245 x = WINDOW_MODELINE_LEFT (w);
2246 width = WINDOW_MODELINE_RIGHT (w) - x;
2247 y = dl->ypos - dl->ascent - shadow_thickness;
2248 height = dl->ascent + dl->descent + 2 * shadow_thickness;
2250 if (XINT (w->modeline_shadow_thickness) < 0)
2252 style = EDGE_BEVEL_IN;
2256 style = EDGE_BEVEL_OUT;
2259 MAYBE_DEVMETH (d, bevel_area,
2260 (w, MODELINE_INDEX, x, y, width, height, shadow_thickness,