1 /* Fringe handling (split from xdisp.c).
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1997,
3 1998, 1999, 2000, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "dispextern.h"
31 #include "blockinput.h"
33 #ifdef HAVE_WINDOW_SYSTEM
35 extern Lisp_Object Qfringe
;
36 extern Lisp_Object Qtop
, Qbottom
, Qcenter
;
37 extern Lisp_Object Qup
, Qdown
, Qleft
, Qright
;
39 /* Non-nil means that newline may flow into the right fringe. */
41 Lisp_Object Voverflow_newline_into_fringe
;
43 /* List of known fringe bitmap symbols.
45 The fringe bitmap number is stored in the `fringe' property on
46 those symbols. Names for the built-in bitmaps are installed by
50 Lisp_Object Vfringe_bitmaps
;
52 enum fringe_bitmap_type
56 LEFT_TRUNCATION_BITMAP
,
57 RIGHT_TRUNCATION_BITMAP
,
60 CONTINUED_LINE_BITMAP
,
61 CONTINUATION_LINE_BITMAP
,
63 TOP_LEFT_ANGLE_BITMAP
,
64 TOP_RIGHT_ANGLE_BITMAP
,
65 BOTTOM_LEFT_ANGLE_BITMAP
,
66 BOTTOM_RIGHT_ANGLE_BITMAP
,
69 FILLED_BOX_CURSOR_BITMAP
,
70 HOLLOW_BOX_CURSOR_BITMAP
,
75 MAX_STANDARD_FRINGE_BITMAPS
78 enum fringe_bitmap_align
80 ALIGN_BITMAP_CENTER
= 0,
96 /***********************************************************************
98 ***********************************************************************/
100 /* Undefined bitmap. A question mark. */
113 static unsigned short unknown_bits
[] = {
114 0x3c, 0x7e, 0x7e, 0x0c, 0x18, 0x18, 0x00, 0x18, 0x18};
116 /* An arrow like this: `<-'. */
127 static unsigned short left_arrow_bits
[] = {
128 0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};
131 /* Right truncation arrow bitmap `->'. */
142 static unsigned short right_arrow_bits
[] = {
143 0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};
146 /* Up arrow bitmap. */
157 static unsigned short up_arrow_bits
[] = {
158 0x18, 0x3c, 0x7e, 0xff, 0x18, 0x18, 0x18, 0x18};
161 /* Down arrow bitmap. */
172 static unsigned short down_arrow_bits
[] = {
173 0x18, 0x18, 0x18, 0x18, 0xff, 0x7e, 0x3c, 0x18};
175 /* Marker for continued lines. */
186 static unsigned short continued_bits
[] = {
187 0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
189 /* Marker for continuation lines. */
200 static unsigned short continuation_bits
[] = {
201 0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};
203 /* Overlay arrow bitmap. A triangular arrow. */
214 static unsigned short ov_bits
[] = {
215 0xc0, 0xf0, 0xf8, 0xfc, 0xfc, 0xf8, 0xf0, 0xc0};
218 /* Reverse Overlay arrow bitmap. A triangular arrow. */
229 static unsigned short rev_ov_bits
[] = {
230 0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};
233 /* First line bitmap. An top-left angle. */
244 static unsigned short top_left_angle_bits
[] = {
245 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00};
247 /* First line bitmap. An right-up angle. */
258 static unsigned short top_right_angle_bits
[] = {
259 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00};
261 /* Last line bitmap. An left-down angle. */
272 static unsigned short bottom_left_angle_bits
[] = {
273 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
275 /* Last line bitmap. An right-down angle. */
286 static unsigned short bottom_right_angle_bits
[] = {
287 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
289 /* First/last line bitmap. An left bracket. */
302 static unsigned short left_bracket_bits
[] = {
303 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
305 /* First/last line bitmap. An right bracket. */
318 static unsigned short right_bracket_bits
[] = {
319 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
321 /* Filled box cursor bitmap. A filled box; max 13 pixels high. */
337 static unsigned short filled_box_cursor_bits
[] = {
338 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe};
340 /* Hollow box cursor bitmap. A hollow box; max 13 pixels high. */
356 static unsigned short hollow_box_cursor_bits
[] = {
357 0xfe, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0xfe};
359 /* Bar cursor bitmap. A vertical bar; max 13 pixels high. */
375 static unsigned short bar_cursor_bits
[] = {
376 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0};
378 /* HBar cursor bitmap. A horisontal bar; 2 pixels high. */
383 static unsigned short hbar_cursor_bits
[] = {
387 /* Bitmap drawn to indicate lines not displaying text if
388 `indicate-empty-lines' is non-nil. */
397 static unsigned short zv_bits
[] = {
398 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
399 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
400 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
401 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
402 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
403 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
404 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
405 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
407 /* Hollow square bitmap. */
416 static unsigned short hollow_square_bits
[] = {
417 0x7e, 0x42, 0x42, 0x42, 0x42, 0x7e};
420 #define BYTES_PER_BITMAP_ROW (sizeof (unsigned short))
421 #define STANDARD_BITMAP_HEIGHT(bits) (sizeof (bits)/BYTES_PER_BITMAP_ROW)
422 #define FRBITS(bits) bits, STANDARD_BITMAP_HEIGHT (bits)
424 struct fringe_bitmap standard_bitmaps
[MAX_STANDARD_FRINGE_BITMAPS
] =
426 { NULL
, 0, 0, 0, 0, 0 }, /* NO_FRINGE_BITMAP */
427 { FRBITS (unknown_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
428 { FRBITS (left_arrow_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
429 { FRBITS (right_arrow_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
430 { FRBITS (up_arrow_bits
), 8, 0, ALIGN_BITMAP_TOP
, 0 },
431 { FRBITS (down_arrow_bits
), 8, 0, ALIGN_BITMAP_BOTTOM
, 0 },
432 { FRBITS (continued_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
433 { FRBITS (continuation_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
434 { FRBITS (ov_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
435 { FRBITS (top_left_angle_bits
), 8, 0, ALIGN_BITMAP_TOP
, 0 },
436 { FRBITS (top_right_angle_bits
), 8, 0, ALIGN_BITMAP_TOP
, 0 },
437 { FRBITS (bottom_left_angle_bits
), 8, 0, ALIGN_BITMAP_BOTTOM
, 0 },
438 { FRBITS (bottom_right_angle_bits
), 8, 0, ALIGN_BITMAP_BOTTOM
, 0 },
439 { FRBITS (left_bracket_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
440 { FRBITS (right_bracket_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
441 { FRBITS (filled_box_cursor_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
442 { FRBITS (hollow_box_cursor_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
443 { FRBITS (hollow_square_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
444 { FRBITS (bar_cursor_bits
), 8, 0, ALIGN_BITMAP_CENTER
, 0 },
445 { FRBITS (hbar_cursor_bits
), 8, 0, ALIGN_BITMAP_BOTTOM
, 0 },
446 { FRBITS (zv_bits
), 8, 3, ALIGN_BITMAP_TOP
, 0 },
449 static struct fringe_bitmap
**fringe_bitmaps
;
450 static Lisp_Object
*fringe_faces
;
451 static int max_fringe_bitmaps
;
453 static int max_used_fringe_bitmap
= MAX_STANDARD_FRINGE_BITMAPS
;
456 /* Lookup bitmap number for symbol BITMAP.
457 Return 0 if not a bitmap. */
460 lookup_fringe_bitmap (bitmap
)
465 bitmap
= Fget (bitmap
, Qfringe
);
466 if (!INTEGERP (bitmap
))
470 if (bn
> NO_FRINGE_BITMAP
471 && bn
< max_used_fringe_bitmap
472 && (bn
< MAX_STANDARD_FRINGE_BITMAPS
473 || fringe_bitmaps
[bn
] != NULL
))
479 /* Get fringe bitmap name for bitmap number BN.
481 Found by traversing Vfringe_bitmaps comparing BN to the
482 fringe property for each symbol.
484 Return BN if not found in Vfringe_bitmaps. */
487 get_fringe_bitmap_name (bn
)
493 /* Zero means no bitmap -- return nil. */
497 bitmaps
= Vfringe_bitmaps
;
498 num
= make_number (bn
);
500 while (CONSP (bitmaps
))
502 Lisp_Object bitmap
= XCAR (bitmaps
);
503 if (EQ (num
, Fget (bitmap
, Qfringe
)))
505 bitmaps
= XCDR (bitmaps
);
512 /* Draw the bitmap WHICH in one of the left or right fringes of
513 window W. ROW is the glyph row for which to display the bitmap; it
514 determines the vertical position at which the bitmap has to be
516 LEFT_P is 1 for left fringe, 0 for right fringe.
520 draw_fringe_bitmap_1 (w
, row
, left_p
, overlay
, which
)
522 struct glyph_row
*row
;
524 enum fringe_bitmap_type which
;
526 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
527 struct draw_fringe_bitmap_params p
;
528 struct fringe_bitmap
*fb
;
530 int face_id
= DEFAULT_FACE_ID
;
533 p
.overlay_p
= (overlay
& 1) == 1;
534 p
.cursor_p
= (overlay
& 2) == 2;
536 if (which
!= NO_FRINGE_BITMAP
)
541 which
= row
->left_fringe_bitmap
;
542 face_id
= row
->left_fringe_face_id
;
546 which
= row
->right_fringe_bitmap
;
547 face_id
= row
->right_fringe_face_id
;
550 if (face_id
== DEFAULT_FACE_ID
)
554 if ((face
= fringe_faces
[which
], NILP (face
))
555 || (face_id
= lookup_derived_face (f
, face
, 'A', FRINGE_FACE_ID
, 0),
557 face_id
= FRINGE_FACE_ID
;
560 fb
= fringe_bitmaps
[which
];
562 fb
= &standard_bitmaps
[which
< MAX_STANDARD_FRINGE_BITMAPS
563 ? which
: UNDEF_FRINGE_BITMAP
];
567 /* Convert row to frame coordinates. */
568 p
.y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
575 p
.dh
= (period
> 0 ? (p
.y
% period
) : 0);
577 /* Clip bitmap if too high. */
578 if (p
.h
> row
->height
)
581 p
.face
= FACE_FROM_ID (f
, face_id
);
585 /* This could happen after clearing face cache.
586 But it shouldn't happen anymore. ++kfs */
590 PREPARE_FACE_FOR_DISPLAY (f
, p
.face
);
592 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
597 int wd
= WINDOW_LEFT_FRINGE_WIDTH (w
);
598 int x
= window_box_left (w
, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
603 p
.x
= x
- p
.wd
- (wd
- p
.wd
) / 2;
605 if (p
.wd
< wd
|| row
->height
> p
.h
)
607 /* If W has a vertical border to its left, don't draw over it. */
608 wd
-= ((!WINDOW_LEFTMOST_P (w
)
609 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
617 int x
= window_box_right (w
,
618 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
621 int wd
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
624 p
.x
= x
+ (wd
- p
.wd
) / 2;
625 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
627 if (p
.wd
< wd
|| row
->height
> p
.h
)
636 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
638 p
.by
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, row
->y
));
639 p
.ny
= row
->visible_height
;
642 /* Adjust y to the offset in the row to start drawing the bitmap. */
645 case ALIGN_BITMAP_CENTER
:
646 p
.y
+= (row
->height
- p
.h
) / 2;
648 case ALIGN_BITMAP_BOTTOM
:
650 p
.y
+= (row
->visible_height
- p
.h
);
652 case ALIGN_BITMAP_TOP
:
656 rif
->draw_fringe_bitmap (w
, row
, &p
);
660 draw_fringe_bitmap (w
, row
, left_p
)
662 struct glyph_row
*row
;
667 if (!left_p
&& row
->cursor_in_fringe_p
)
669 int cursor
= NO_FRINGE_BITMAP
;
671 switch (w
->phys_cursor_type
)
673 case HOLLOW_BOX_CURSOR
:
674 if (row
->visible_height
>= STANDARD_BITMAP_HEIGHT (hollow_box_cursor_bits
))
675 cursor
= HOLLOW_BOX_CURSOR_BITMAP
;
677 cursor
= HOLLOW_SQUARE_BITMAP
;
679 case FILLED_BOX_CURSOR
:
680 cursor
= FILLED_BOX_CURSOR_BITMAP
;
683 cursor
= BAR_CURSOR_BITMAP
;
686 cursor
= HBAR_CURSOR_BITMAP
;
690 w
->phys_cursor_on_p
= 0;
691 row
->cursor_in_fringe_p
= 0;
694 if (cursor
!= NO_FRINGE_BITMAP
)
696 draw_fringe_bitmap_1 (w
, row
, 0, 2, cursor
);
697 overlay
= cursor
== FILLED_BOX_CURSOR_BITMAP
? 3 : 1;
701 draw_fringe_bitmap_1 (w
, row
, left_p
, overlay
, NO_FRINGE_BITMAP
);
703 if (left_p
&& row
->overlay_arrow_bitmap
!= NO_FRINGE_BITMAP
)
704 draw_fringe_bitmap_1 (w
, row
, 1, 1,
705 (row
->overlay_arrow_bitmap
< 0
706 ? OVERLAY_ARROW_BITMAP
707 : row
->overlay_arrow_bitmap
));
711 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
712 function with input blocked. */
715 draw_row_fringe_bitmaps (w
, row
)
717 struct glyph_row
*row
;
719 xassert (interrupt_input_blocked
);
721 /* If row is completely invisible, because of vscrolling, we
722 don't have to draw anything. */
723 if (row
->visible_height
<= 0)
726 if (WINDOW_LEFT_FRINGE_WIDTH (w
) != 0)
727 draw_fringe_bitmap (w
, row
, 1);
729 if (WINDOW_RIGHT_FRINGE_WIDTH (w
) != 0)
730 draw_fringe_bitmap (w
, row
, 0);
733 /* Draw the fringes of window W. Only fringes for rows marked for
734 update in redraw_fringe_bitmaps_p are drawn.
736 Return >0 if left or right fringe was redrawn in any way.
738 If NO_FRINGE is non-zero, also return >0 if either fringe has zero width.
740 A return value >0 indicates that the vertical line between windows
741 needs update (as it may be drawn in the fringe).
745 draw_window_fringes (w
, no_fringe
)
749 struct glyph_row
*row
;
750 int yb
= window_text_bottom_y (w
);
751 int nrows
= w
->current_matrix
->nrows
;
755 if (w
->pseudo_window_p
)
758 /* Must draw line if no fringe */
760 && (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0
761 || WINDOW_RIGHT_FRINGE_WIDTH (w
) == 0))
764 for (y
= 0, rn
= 0, row
= w
->current_matrix
->rows
;
765 y
< yb
&& rn
< nrows
;
766 y
+= row
->height
, ++row
, ++rn
)
768 if (!row
->redraw_fringe_bitmaps_p
)
770 draw_row_fringe_bitmaps (w
, row
);
771 row
->redraw_fringe_bitmaps_p
= 0;
779 /* Recalculate the bitmaps to show in the fringes of window W.
780 Only mark rows with modified bitmaps for update in redraw_fringe_bitmaps_p.
782 If KEEP_CURRENT_P is 0, update current_matrix too. */
785 update_window_fringes (w
, keep_current_p
)
789 struct glyph_row
*row
, *cur
= 0;
790 int yb
= window_text_bottom_y (w
);
791 int rn
, nrows
= w
->current_matrix
->nrows
;
794 Lisp_Object boundary_top
= Qnil
, boundary_bot
= Qnil
;
795 Lisp_Object arrow_top
= Qnil
, arrow_bot
= Qnil
;
796 Lisp_Object empty_pos
;
797 Lisp_Object ind
= Qnil
;
799 if (w
->pseudo_window_p
)
802 if (!MINI_WINDOW_P (w
)
803 && (ind
= XBUFFER (w
->buffer
)->indicate_buffer_boundaries
, !NILP (ind
)))
805 if (EQ (ind
, Qleft
) || EQ (ind
, Qright
))
806 boundary_top
= boundary_bot
= arrow_top
= arrow_bot
= ind
;
807 else if (CONSP (ind
) && CONSP (XCAR (ind
)))
810 if (pos
= Fassq (Qt
, ind
), !NILP (pos
))
811 boundary_top
= boundary_bot
= arrow_top
= arrow_bot
= XCDR (pos
);
812 if (pos
= Fassq (Qtop
, ind
), !NILP (pos
))
813 boundary_top
= XCDR (pos
);
814 if (pos
= Fassq (Qbottom
, ind
), !NILP (pos
))
815 boundary_bot
= XCDR (pos
);
816 if (pos
= Fassq (Qup
, ind
), !NILP (pos
))
817 arrow_top
= XCDR (pos
);
818 if (pos
= Fassq (Qdown
, ind
), !NILP (pos
))
819 arrow_bot
= XCDR (pos
);
822 /* Anything else means boundary on left and no arrows. */
823 boundary_top
= boundary_bot
= Qleft
;
828 int done_top
= 0, done_bot
= 0;
831 y
< yb
&& rn
< nrows
;
832 y
+= row
->height
, ++rn
)
834 unsigned indicate_bob_p
, indicate_top_line_p
;
835 unsigned indicate_eob_p
, indicate_bottom_line_p
;
837 row
= w
->desired_matrix
->rows
+ rn
;
839 row
= w
->current_matrix
->rows
+ rn
;
841 indicate_bob_p
= row
->indicate_bob_p
;
842 indicate_top_line_p
= row
->indicate_top_line_p
;
843 indicate_eob_p
= row
->indicate_eob_p
;
844 indicate_bottom_line_p
= row
->indicate_bottom_line_p
;
846 row
->indicate_bob_p
= row
->indicate_top_line_p
= 0;
847 row
->indicate_eob_p
= row
->indicate_bottom_line_p
= 0;
849 if (!row
->mode_line_p
)
853 if (MATRIX_ROW_START_CHARPOS (row
) <= BUF_BEGV (XBUFFER (w
->buffer
))
854 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
855 row
->indicate_bob_p
= !NILP (boundary_top
);
857 row
->indicate_top_line_p
= !NILP (arrow_top
);
863 if (MATRIX_ROW_END_CHARPOS (row
) >= BUF_ZV (XBUFFER (w
->buffer
))
864 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w
, row
))
865 row
->indicate_eob_p
= !NILP (boundary_bot
), done_bot
= 1;
866 else if (y
+ row
->height
>= yb
)
867 row
->indicate_bottom_line_p
= !NILP (arrow_bot
), done_bot
= 1;
871 if (indicate_bob_p
!= row
->indicate_bob_p
872 || indicate_top_line_p
!= row
->indicate_top_line_p
873 || indicate_eob_p
!= row
->indicate_eob_p
874 || indicate_bottom_line_p
!= row
->indicate_bottom_line_p
)
875 row
->redraw_fringe_bitmaps_p
= 1;
879 empty_pos
= XBUFFER (w
->buffer
)->indicate_empty_lines
;
880 if (!NILP (empty_pos
) && !EQ (empty_pos
, Qright
))
881 empty_pos
= WINDOW_LEFT_FRINGE_WIDTH (w
) == 0 ? Qright
: Qleft
;
884 y
< yb
&& rn
< nrows
;
885 y
+= row
->height
, rn
++)
887 enum fringe_bitmap_type left
, right
;
888 unsigned left_face_id
, right_face_id
;
890 row
= w
->desired_matrix
->rows
+ rn
;
891 cur
= w
->current_matrix
->rows
+ rn
;
895 left_face_id
= right_face_id
= DEFAULT_FACE_ID
;
897 /* Decide which bitmap to draw in the left fringe. */
898 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
899 left
= NO_FRINGE_BITMAP
;
900 else if (row
->left_user_fringe_bitmap
!= NO_FRINGE_BITMAP
)
902 left
= row
->left_user_fringe_bitmap
;
903 left_face_id
= row
->left_user_fringe_face_id
;
905 else if (row
->truncated_on_left_p
)
906 left
= LEFT_TRUNCATION_BITMAP
;
907 else if (row
->indicate_bob_p
&& EQ (boundary_top
, Qleft
))
908 left
= ((row
->indicate_eob_p
&& EQ (boundary_bot
, Qleft
))
909 ? LEFT_BRACKET_BITMAP
: TOP_LEFT_ANGLE_BITMAP
);
910 else if (row
->indicate_eob_p
&& EQ (boundary_bot
, Qleft
))
911 left
= BOTTOM_LEFT_ANGLE_BITMAP
;
912 else if (MATRIX_ROW_CONTINUATION_LINE_P (row
))
913 left
= CONTINUATION_LINE_BITMAP
;
914 else if (row
->indicate_empty_line_p
&& EQ (empty_pos
, Qleft
))
915 left
= ZV_LINE_BITMAP
;
916 else if (row
->indicate_top_line_p
&& EQ (arrow_top
, Qleft
))
917 left
= UP_ARROW_BITMAP
;
918 else if (row
->indicate_bottom_line_p
&& EQ (arrow_bot
, Qleft
))
919 left
= DOWN_ARROW_BITMAP
;
921 left
= NO_FRINGE_BITMAP
;
923 /* Decide which bitmap to draw in the right fringe. */
924 if (WINDOW_RIGHT_FRINGE_WIDTH (w
) == 0)
925 right
= NO_FRINGE_BITMAP
;
926 else if (row
->right_user_fringe_bitmap
!= NO_FRINGE_BITMAP
)
928 right
= row
->right_user_fringe_bitmap
;
929 right_face_id
= row
->right_user_fringe_face_id
;
931 else if (row
->truncated_on_right_p
)
932 right
= RIGHT_TRUNCATION_BITMAP
;
933 else if (row
->indicate_bob_p
&& EQ (boundary_top
, Qright
))
934 right
= ((row
->indicate_eob_p
&& EQ (boundary_bot
, Qright
))
935 ? RIGHT_BRACKET_BITMAP
: TOP_RIGHT_ANGLE_BITMAP
);
936 else if (row
->indicate_eob_p
&& EQ (boundary_bot
, Qright
))
937 right
= BOTTOM_RIGHT_ANGLE_BITMAP
;
938 else if (row
->continued_p
)
939 right
= CONTINUED_LINE_BITMAP
;
940 else if (row
->indicate_top_line_p
&& EQ (arrow_top
, Qright
))
941 right
= UP_ARROW_BITMAP
;
942 else if (row
->indicate_bottom_line_p
&& EQ (arrow_bot
, Qright
))
943 right
= DOWN_ARROW_BITMAP
;
944 else if (row
->indicate_empty_line_p
&& EQ (empty_pos
, Qright
))
945 right
= ZV_LINE_BITMAP
;
947 right
= NO_FRINGE_BITMAP
;
950 || row
->visible_height
!= cur
->visible_height
951 || row
->ends_at_zv_p
!= cur
->ends_at_zv_p
952 || left
!= cur
->left_fringe_bitmap
953 || right
!= cur
->right_fringe_bitmap
954 || left_face_id
!= cur
->left_fringe_face_id
955 || right_face_id
!= cur
->right_fringe_face_id
956 || cur
->redraw_fringe_bitmaps_p
)
958 redraw_p
= row
->redraw_fringe_bitmaps_p
= 1;
961 cur
->redraw_fringe_bitmaps_p
= 1;
962 cur
->left_fringe_bitmap
= left
;
963 cur
->right_fringe_bitmap
= right
;
964 cur
->left_fringe_face_id
= left_face_id
;
965 cur
->right_fringe_face_id
= right_face_id
;
969 if (row
->overlay_arrow_bitmap
!= cur
->overlay_arrow_bitmap
)
971 redraw_p
= row
->redraw_fringe_bitmaps_p
= cur
->redraw_fringe_bitmaps_p
= 1;
972 cur
->overlay_arrow_bitmap
= row
->overlay_arrow_bitmap
;
975 row
->left_fringe_bitmap
= left
;
976 row
->right_fringe_bitmap
= right
;
977 row
->left_fringe_face_id
= left_face_id
;
978 row
->right_fringe_face_id
= right_face_id
;
980 if (rn
> 0 && row
->redraw_fringe_bitmaps_p
)
981 row
[-1].redraw_fringe_bitmaps_p
= cur
[-1].redraw_fringe_bitmaps_p
= 1;
984 return redraw_p
&& !keep_current_p
;
988 /* Compute actual fringe widths for frame F.
990 If REDRAW is 1, redraw F if the fringe settings was actually
991 modified and F is visible.
993 Since the combined left and right fringe must occupy an integral
994 number of columns, we may need to add some pixels to each fringe.
995 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
996 but a negative width value is taken literally (after negating it).
998 We never make the fringes narrower than specified.
1002 compute_fringe_widths (f
, redraw
)
1006 int o_left
= FRAME_LEFT_FRINGE_WIDTH (f
);
1007 int o_right
= FRAME_RIGHT_FRINGE_WIDTH (f
);
1008 int o_cols
= FRAME_FRINGE_COLS (f
);
1010 Lisp_Object left_fringe
= Fassq (Qleft_fringe
, f
->param_alist
);
1011 Lisp_Object right_fringe
= Fassq (Qright_fringe
, f
->param_alist
);
1012 int left_fringe_width
, right_fringe_width
;
1014 if (!NILP (left_fringe
))
1015 left_fringe
= Fcdr (left_fringe
);
1016 if (!NILP (right_fringe
))
1017 right_fringe
= Fcdr (right_fringe
);
1019 left_fringe_width
= ((NILP (left_fringe
) || !INTEGERP (left_fringe
)) ? 8 :
1020 XINT (left_fringe
));
1021 right_fringe_width
= ((NILP (right_fringe
) || !INTEGERP (right_fringe
)) ? 8 :
1022 XINT (right_fringe
));
1024 if (left_fringe_width
|| right_fringe_width
)
1026 int left_wid
= left_fringe_width
>= 0 ? left_fringe_width
: -left_fringe_width
;
1027 int right_wid
= right_fringe_width
>= 0 ? right_fringe_width
: -right_fringe_width
;
1028 int conf_wid
= left_wid
+ right_wid
;
1029 int font_wid
= FRAME_COLUMN_WIDTH (f
);
1030 int cols
= (left_wid
+ right_wid
+ font_wid
-1) / font_wid
;
1031 int real_wid
= cols
* font_wid
;
1032 if (left_wid
&& right_wid
)
1034 if (left_fringe_width
< 0)
1036 /* Left fringe width is fixed, adjust right fringe if necessary */
1037 FRAME_LEFT_FRINGE_WIDTH (f
) = left_wid
;
1038 FRAME_RIGHT_FRINGE_WIDTH (f
) = real_wid
- left_wid
;
1040 else if (right_fringe_width
< 0)
1042 /* Right fringe width is fixed, adjust left fringe if necessary */
1043 FRAME_LEFT_FRINGE_WIDTH (f
) = real_wid
- right_wid
;
1044 FRAME_RIGHT_FRINGE_WIDTH (f
) = right_wid
;
1048 /* Adjust both fringes with an equal amount.
1049 Note that we are doing integer arithmetic here, so don't
1050 lose a pixel if the total width is an odd number. */
1051 int fill
= real_wid
- conf_wid
;
1052 FRAME_LEFT_FRINGE_WIDTH (f
) = left_wid
+ fill
/2;
1053 FRAME_RIGHT_FRINGE_WIDTH (f
) = right_wid
+ fill
- fill
/2;
1056 else if (left_fringe_width
)
1058 FRAME_LEFT_FRINGE_WIDTH (f
) = real_wid
;
1059 FRAME_RIGHT_FRINGE_WIDTH (f
) = 0;
1063 FRAME_LEFT_FRINGE_WIDTH (f
) = 0;
1064 FRAME_RIGHT_FRINGE_WIDTH (f
) = real_wid
;
1066 FRAME_FRINGE_COLS (f
) = cols
;
1070 FRAME_LEFT_FRINGE_WIDTH (f
) = 0;
1071 FRAME_RIGHT_FRINGE_WIDTH (f
) = 0;
1072 FRAME_FRINGE_COLS (f
) = 0;
1075 if (redraw
&& FRAME_VISIBLE_P (f
))
1076 if (o_left
!= FRAME_LEFT_FRINGE_WIDTH (f
) ||
1077 o_right
!= FRAME_RIGHT_FRINGE_WIDTH (f
) ||
1078 o_cols
!= FRAME_FRINGE_COLS (f
))
1083 /* Free resources used by a user-defined bitmap. */
1086 destroy_fringe_bitmap (n
)
1089 struct fringe_bitmap
**fbp
;
1091 fringe_faces
[n
] = Qnil
;
1093 fbp
= &fringe_bitmaps
[n
];
1094 if (*fbp
&& (*fbp
)->dynamic
)
1096 if (rif
&& rif
->destroy_fringe_bitmap
)
1097 rif
->destroy_fringe_bitmap (n
);
1102 while (max_used_fringe_bitmap
> MAX_STANDARD_FRINGE_BITMAPS
1103 && fringe_bitmaps
[max_used_fringe_bitmap
- 1] == NULL
)
1104 max_used_fringe_bitmap
--;
1108 DEFUN ("destroy-fringe-bitmap", Fdestroy_fringe_bitmap
, Sdestroy_fringe_bitmap
,
1110 doc
: /* Destroy fringe bitmap BITMAP.
1111 If BITMAP overrides a standard fringe bitmap, the original bitmap is restored. */)
1117 CHECK_SYMBOL (bitmap
);
1118 n
= lookup_fringe_bitmap (bitmap
);
1122 destroy_fringe_bitmap (n
);
1124 if (n
>= MAX_STANDARD_FRINGE_BITMAPS
)
1126 Vfringe_bitmaps
= Fdelq (bitmap
, Vfringe_bitmaps
);
1127 /* It would be better to remove the fringe property. */
1128 Fput (bitmap
, Qfringe
, Qnil
);
1135 /* Initialize bitmap bit.
1137 On X, we bit-swap the built-in bitmaps and reduce bitmap
1138 from short to char array if width is <= 8 bits.
1140 On MAC with big-endian CPU, we need to byte-swap each short.
1142 On W32 and MAC (little endian), there's no need to do this.
1146 init_fringe_bitmap (which
, fb
, once_p
)
1147 enum fringe_bitmap_type which
;
1148 struct fringe_bitmap
*fb
;
1151 if (once_p
|| fb
->dynamic
)
1153 #if defined (HAVE_X_WINDOWS)
1154 static unsigned char swap_nibble
[16]
1155 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
1156 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
1157 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
1158 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
1159 unsigned short *bits
= fb
->bits
;
1164 unsigned char *cbits
= (unsigned char *)fb
->bits
;
1165 for (j
= 0; j
< fb
->height
; j
++)
1167 unsigned short b
= *bits
++;
1169 c
= (unsigned char)((swap_nibble
[b
& 0xf] << 4)
1170 | (swap_nibble
[(b
>>4) & 0xf]));
1171 *cbits
++ = (c
>> (8 - fb
->width
));
1176 for (j
= 0; j
< fb
->height
; j
++)
1178 unsigned short b
= *bits
;
1179 b
= (unsigned short)((swap_nibble
[b
& 0xf] << 12)
1180 | (swap_nibble
[(b
>>4) & 0xf] << 8)
1181 | (swap_nibble
[(b
>>8) & 0xf] << 4)
1182 | (swap_nibble
[(b
>>12) & 0xf]));
1183 *bits
++ = (b
>> (16 - fb
->width
));
1186 #endif /* HAVE_X_WINDOWS */
1188 #if defined (MAC_OS) && defined (WORDS_BIG_ENDIAN)
1189 unsigned short *bits
= fb
->bits
;
1191 for (j
= 0; j
< fb
->height
; j
++)
1193 unsigned short b
= *bits
;
1194 *bits
++ = ((b
>> 8) & 0xff) | ((b
& 0xff) << 8);
1196 #endif /* MAC_OS && WORDS_BIG_ENDIAN */
1201 destroy_fringe_bitmap (which
);
1203 if (rif
&& rif
->define_fringe_bitmap
)
1204 rif
->define_fringe_bitmap (which
, fb
->bits
, fb
->height
, fb
->width
);
1206 fringe_bitmaps
[which
] = fb
;
1207 if (which
>= max_used_fringe_bitmap
)
1208 max_used_fringe_bitmap
= which
+ 1;
1213 DEFUN ("define-fringe-bitmap", Fdefine_fringe_bitmap
, Sdefine_fringe_bitmap
,
1215 doc
: /* Define fringe bitmap BITMAP from BITS of size HEIGHT x WIDTH.
1216 BITMAP is a symbol or string naming the new fringe bitmap.
1217 BITS is either a string or a vector of integers.
1218 HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
1219 WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
1220 Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
1221 indicating the positioning of the bitmap relative to the rows where it
1222 is used; the default is to center the bitmap. Fourth arg may also be a
1223 list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap
1225 If BITMAP already exists, the existing definition is replaced. */)
1226 (bitmap
, bits
, height
, width
, align
)
1227 Lisp_Object bitmap
, bits
, height
, width
, align
;
1231 struct fringe_bitmap fb
, *xfb
;
1232 int fill1
= 0, fill2
= 0;
1234 CHECK_SYMBOL (bitmap
);
1238 else if (VECTORP (bits
))
1239 h
= XVECTOR (bits
)->size
;
1241 bits
= wrong_type_argument (Qsequencep
, bits
);
1247 CHECK_NUMBER (height
);
1248 fb
.height
= min (XINT (height
), 255);
1251 fill1
= (fb
.height
- h
) / 2;
1252 fill2
= fb
.height
- h
- fill1
;
1260 CHECK_NUMBER (width
);
1261 fb
.width
= min (XINT (width
), 255);
1265 fb
.align
= ALIGN_BITMAP_CENTER
;
1269 Lisp_Object period
= XCDR (align
);
1272 period
= XCAR (period
);
1275 fb
.period
= fb
.height
;
1279 align
= XCAR (align
);
1281 if (EQ (align
, Qtop
))
1282 fb
.align
= ALIGN_BITMAP_TOP
;
1283 else if (EQ (align
, Qbottom
))
1284 fb
.align
= ALIGN_BITMAP_BOTTOM
;
1285 else if (!NILP (align
) && !EQ (align
, Qcenter
))
1286 error ("Bad align argument");
1288 n
= lookup_fringe_bitmap (bitmap
);
1291 if (max_used_fringe_bitmap
< max_fringe_bitmaps
)
1292 n
= max_used_fringe_bitmap
++;
1295 for (n
= MAX_STANDARD_FRINGE_BITMAPS
;
1296 n
< max_fringe_bitmaps
;
1298 if (fringe_bitmaps
[n
] == NULL
)
1301 if (n
== max_fringe_bitmaps
)
1303 if ((max_fringe_bitmaps
+ 20) > MAX_FRINGE_BITMAPS
)
1304 error ("No free fringe bitmap slots");
1306 i
= max_fringe_bitmaps
;
1307 max_fringe_bitmaps
+= 20;
1309 = ((struct fringe_bitmap
**)
1310 xrealloc (fringe_bitmaps
, max_fringe_bitmaps
* sizeof (struct fringe_bitmap
*)));
1312 = (Lisp_Object
*) xrealloc (fringe_faces
, max_fringe_bitmaps
* sizeof (Lisp_Object
));
1314 for (; i
< max_fringe_bitmaps
; i
++)
1316 fringe_bitmaps
[i
] = NULL
;
1317 fringe_faces
[i
] = Qnil
;
1322 Vfringe_bitmaps
= Fcons (bitmap
, Vfringe_bitmaps
);
1323 Fput (bitmap
, Qfringe
, make_number (n
));
1328 xfb
= (struct fringe_bitmap
*) xmalloc (sizeof fb
1329 + fb
.height
* BYTES_PER_BITMAP_ROW
);
1330 fb
.bits
= b
= (unsigned short *) (xfb
+ 1);
1331 bzero (b
, fb
.height
);
1334 while (j
< fb
.height
)
1336 for (i
= 0; i
< fill1
&& j
< fb
.height
; i
++)
1338 for (i
= 0; i
< h
&& j
< fb
.height
; i
++)
1340 Lisp_Object elt
= Faref (bits
, make_number (i
));
1341 b
[j
++] = NUMBERP (elt
) ? XINT (elt
) : 0;
1343 for (i
= 0; i
< fill2
&& j
< fb
.height
; i
++)
1349 init_fringe_bitmap (n
, xfb
, 0);
1354 DEFUN ("set-fringe-bitmap-face", Fset_fringe_bitmap_face
, Sset_fringe_bitmap_face
,
1356 doc
: /* Set face for fringe bitmap BITMAP to FACE.
1357 If FACE is nil, reset face to default fringe face. */)
1359 Lisp_Object bitmap
, face
;
1364 CHECK_SYMBOL (bitmap
);
1365 n
= lookup_fringe_bitmap (bitmap
);
1367 error ("Undefined fringe bitmap");
1371 face_id
= lookup_derived_face (SELECTED_FRAME (), face
,
1372 'A', FRINGE_FACE_ID
, 1);
1374 error ("No such face");
1377 fringe_faces
[n
] = face
;
1382 DEFUN ("fringe-bitmaps-at-pos", Ffringe_bitmaps_at_pos
, Sfringe_bitmaps_at_pos
,
1384 doc
: /* Return fringe bitmaps of row containing position POS in window WINDOW.
1385 If WINDOW is nil, use selected window. If POS is nil, use value of point
1386 in that window. Return value is a list (LEFT RIGHT OV), where LEFT
1387 is the symbol for the bitmap in the left fringe (or nil if no bitmap),
1388 RIGHT is similar for the right fringe, and OV is non-nil if there is an
1389 overlay arrow in the left fringe.
1390 Return nil if POS is not visible in WINDOW. */)
1392 Lisp_Object pos
, window
;
1395 struct glyph_row
*row
;
1399 window
= selected_window
;
1400 CHECK_WINDOW (window
);
1401 w
= XWINDOW (window
);
1405 CHECK_NUMBER_COERCE_MARKER (pos
);
1406 textpos
= XINT (pos
);
1408 else if (w
== XWINDOW (selected_window
))
1411 textpos
= XMARKER (w
->pointm
)->charpos
;
1413 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1414 row
= row_containing_pos (w
, textpos
, row
, NULL
, 0);
1416 return list3 (get_fringe_bitmap_name (row
->left_fringe_bitmap
),
1417 get_fringe_bitmap_name (row
->right_fringe_bitmap
),
1418 (row
->overlay_arrow_bitmap
== 0 ? Qnil
1419 : row
->overlay_arrow_bitmap
< 0 ? Qt
1420 : get_fringe_bitmap_name (row
->overlay_arrow_bitmap
)));
1426 /***********************************************************************
1428 ***********************************************************************/
1433 defsubr (&Sdestroy_fringe_bitmap
);
1434 defsubr (&Sdefine_fringe_bitmap
);
1435 defsubr (&Sfringe_bitmaps_at_pos
);
1436 defsubr (&Sset_fringe_bitmap_face
);
1438 DEFVAR_LISP ("overflow-newline-into-fringe", &Voverflow_newline_into_fringe
,
1439 doc
: /* *Non-nil means that newline may flow into the right fringe.
1440 This means that display lines which are exactly as wide as the window
1441 (not counting the final newline) will only occupy one screen line, by
1442 showing (or hiding) the final newline in the right fringe; when point
1443 is at the final newline, the cursor is shown in the right fringe.
1444 If nil, also continue lines which are exactly as wide as the window. */);
1445 Voverflow_newline_into_fringe
= Qt
;
1447 DEFVAR_LISP ("fringe-bitmaps", &Vfringe_bitmaps
,
1448 doc
: /* List of fringe bitmap symbols.
1449 You must (require 'fringe) to use fringe bitmap symbols in your programs." */);
1450 Vfringe_bitmaps
= Qnil
;
1453 /* Garbage collection hook */
1460 for (i
= 0; i
< max_fringe_bitmaps
; i
++)
1461 if (!NILP (fringe_faces
[i
]))
1462 mark_object (fringe_faces
[i
]);
1465 /* Initialize this module when Emacs starts. */
1470 enum fringe_bitmap_type bt
;
1472 for (bt
= NO_FRINGE_BITMAP
+ 1; bt
< MAX_STANDARD_FRINGE_BITMAPS
; bt
++)
1473 init_fringe_bitmap(bt
, &standard_bitmaps
[bt
], 1);
1481 max_fringe_bitmaps
= MAX_STANDARD_FRINGE_BITMAPS
+ 20;
1484 = (struct fringe_bitmap
**) xmalloc (max_fringe_bitmaps
* sizeof (struct fringe_bitmap
*));
1486 = (Lisp_Object
*) xmalloc (max_fringe_bitmaps
* sizeof (Lisp_Object
));
1488 for (i
= 0; i
< max_fringe_bitmaps
; i
++)
1490 fringe_bitmaps
[i
] = NULL
;
1491 fringe_faces
[i
] = Qnil
;
1500 enum fringe_bitmap_type bt
;
1505 for (bt
= NO_FRINGE_BITMAP
+ 1; bt
< MAX_STANDARD_FRINGE_BITMAPS
; bt
++)
1507 struct fringe_bitmap
*fb
= &standard_bitmaps
[bt
];
1508 rif
->define_fringe_bitmap (bt
, fb
->bits
, fb
->height
, fb
->width
);
1513 w32_reset_fringes ()
1515 /* Destroy row bitmaps. */
1521 for (bt
= NO_FRINGE_BITMAP
+ 1; bt
< max_used_fringe_bitmap
; bt
++)
1522 rif
->destroy_fringe_bitmap (bt
);
1525 #endif /* HAVE_NTGUI */
1527 #endif /* HAVE_WINDOW_SYSTEM */
1529 /* arch-tag: 04596920-43eb-473d-b319-82712338162d
1530 (do not change this comment) */