* lisp/bookmark.el (bookmark-version-control): Use Drew's slightly
[emacs.git] / src / fringe.c
blobd788503e91eeafa373f138611ae5c2c76ce9135b
1 /* Fringe handling (split from xdisp.c).
2 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 #include <config.h>
20 #include <stdio.h>
22 #include "lisp.h"
23 #include "frame.h"
24 #include "window.h"
25 #include "dispextern.h"
26 #include "character.h"
27 #include "buffer.h"
28 #include "blockinput.h"
29 #include "termhooks.h"
31 #ifdef HAVE_WINDOW_SYSTEM
33 /* Fringe bitmaps are represented in three different ways:
35 Logical bitmaps are used internally to denote things like
36 'end-of-buffer', 'left-truncation', 'overlay-arrow', etc.
38 Physical bitmaps specify the visual appearance of the bitmap,
39 e.g. 'bottom-left-angle', 'left-arrow', 'left-triangle', etc.
40 User defined bitmaps are physical bitmaps.
42 Internally, fringe bitmaps for a specific display row are
43 represented as a simple integer that is used as an index
44 into the table of all defined bitmaps. This index is stored
45 in the `fringe' property of the physical bitmap symbol.
47 Logical bitmaps are mapped to physical bitmaps through the
48 buffer-local `fringe-indicator-alist' variable.
50 Each element of this alist is a cons (LOGICAL . PHYSICAL)
51 mapping a logical bitmap to a physical bitmap.
52 PHYSICAL is either a symbol to use in both left and right fringe,
53 or a cons of two symbols (LEFT . RIGHT) denoting different
54 bitmaps to use in left and right fringe.
56 LOGICAL is first looked up in the window's buffer's buffer-local
57 value of the fringe-indicator-alist variable, and if not present,
58 in the global value of fringe-indicator-alist.
60 If LOGICAL is not present in either alist, or the PHYSICAL value
61 found is nil, no bitmap is shown for the logical bitmap.
63 The `left-fringe' and `right-fringe' display properties
64 must specify physical bitmap symbols.
67 static Lisp_Object Qtruncation, Qcontinuation, Qoverlay_arrow;
68 static Lisp_Object Qempty_line, Qtop_bottom;
69 static Lisp_Object Qhollow_small;
71 enum fringe_bitmap_align
73 ALIGN_BITMAP_CENTER = 0,
74 ALIGN_BITMAP_TOP,
75 ALIGN_BITMAP_BOTTOM
78 struct fringe_bitmap
80 unsigned short *bits;
81 unsigned height : 8;
82 unsigned width : 8;
83 unsigned period : 8;
84 unsigned align : 2;
85 unsigned dynamic : 1;
89 /***********************************************************************
90 Fringe bitmaps
91 ***********************************************************************/
93 /* Undefined bitmap. A question mark. */
95 ..xxxx..
96 .xxxxxx.
97 xx....xx
98 xx....xx
99 ....xx..
100 ...xx...
101 ...xx...
102 ........
103 ...xx...
104 ...xx...
106 static unsigned short question_mark_bits[] = {
107 0x3c, 0x7e, 0x7e, 0x0c, 0x18, 0x18, 0x00, 0x18, 0x18};
109 /* An exclamation mark. */
111 ...XX...
112 ...XX...
113 ...XX...
114 ...XX...
115 ...XX...
116 ...XX...
117 ...XX...
118 ........
119 ...XX...
120 ...XX...
122 static unsigned short exclamation_mark_bits[] = {
123 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x00, 0x18};
125 /* An arrow like this: `<-'. */
127 ...xx...
128 ..xx....
129 .xx.....
130 xxxxxx..
131 xxxxxx..
132 .xx.....
133 ..xx....
134 ...xx...
136 static unsigned short left_arrow_bits[] = {
137 0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};
140 /* Right truncation arrow bitmap `->'. */
142 ...xx...
143 ....xx..
144 .....xx.
145 ..xxxxxx
146 ..xxxxxx
147 .....xx.
148 ....xx..
149 ...xx...
151 static unsigned short right_arrow_bits[] = {
152 0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};
155 /* Up arrow bitmap. */
157 ...xx...
158 ..xxxx..
159 .xxxxxx.
160 xxxxxxxx
161 ...xx...
162 ...xx...
163 ...xx...
164 ...xx...
166 static unsigned short up_arrow_bits[] = {
167 0x18, 0x3c, 0x7e, 0xff, 0x18, 0x18, 0x18, 0x18};
170 /* Down arrow bitmap. */
172 ...xx...
173 ...xx...
174 ...xx...
175 ...xx...
176 xxxxxxxx
177 .xxxxxx.
178 ..xxxx..
179 ...xx...
181 static unsigned short down_arrow_bits[] = {
182 0x18, 0x18, 0x18, 0x18, 0xff, 0x7e, 0x3c, 0x18};
184 /* Marker for continuation lines. */
186 ..xxxx..
187 .xxxxx..
188 xx......
189 xxx..x..
190 xxxxxx..
191 .xxxxx..
192 ..xxxx..
193 .xxxxx..
195 static unsigned short left_curly_arrow_bits[] = {
196 0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};
198 /* Marker for continued lines. */
200 ..xxxx..
201 ..xxxxx.
202 ......xx
203 ..x..xxx
204 ..xxxxxx
205 ..xxxxx.
206 ..xxxx..
207 ..xxxxx.
209 static unsigned short right_curly_arrow_bits[] = {
210 0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
212 /* Reverse Overlay arrow bitmap. A triangular arrow. */
214 ......xx
215 ....xxxx
216 ...xxxxx
217 ..xxxxxx
218 ..xxxxxx
219 ...xxxxx
220 ....xxxx
221 ......xx
223 static unsigned short left_triangle_bits[] = {
224 0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};
226 /* Overlay arrow bitmap. A triangular arrow. */
228 xx......
229 xxxx....
230 xxxxx...
231 xxxxxx..
232 xxxxxx..
233 xxxxx...
234 xxxx....
235 xx......
237 static unsigned short right_triangle_bits[] = {
238 0xc0, 0xf0, 0xf8, 0xfc, 0xfc, 0xf8, 0xf0, 0xc0};
240 /* First line bitmap. An top-left angle. */
242 xxxxxx..
243 xxxxxx..
244 xx......
245 xx......
246 xx......
247 xx......
248 xx......
249 ........
251 static unsigned short top_left_angle_bits[] = {
252 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00};
254 /* First line bitmap. An right-up angle. */
256 ..xxxxxx
257 ..xxxxxx
258 ......xx
259 ......xx
260 ......xx
261 ......xx
262 ......xx
263 ........
265 static unsigned short top_right_angle_bits[] = {
266 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00};
268 /* Last line bitmap. An left-down angle. */
270 ........
271 xx......
272 xx......
273 xx......
274 xx......
275 xx......
276 xxxxxx..
277 xxxxxx..
279 static unsigned short bottom_left_angle_bits[] = {
280 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
282 /* Last line bitmap. An right-down angle. */
284 ........
285 ......xx
286 ......xx
287 ......xx
288 ......xx
289 ......xx
290 ..xxxxxx
291 ..xxxxxx
293 static unsigned short bottom_right_angle_bits[] = {
294 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
296 /* First/last line bitmap. An left bracket. */
298 xxxxxx..
299 xxxxxx..
300 xx......
301 xx......
302 xx......
303 xx......
304 xx......
305 xx......
306 xxxxxx..
307 xxxxxx..
309 static unsigned short left_bracket_bits[] = {
310 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
312 /* First/last line bitmap. An right bracket. */
314 ..xxxxxx
315 ..xxxxxx
316 ......xx
317 ......xx
318 ......xx
319 ......xx
320 ......xx
321 ......xx
322 ..xxxxxx
323 ..xxxxxx
325 static unsigned short right_bracket_bits[] = {
326 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
328 /* Filled box cursor bitmap. A filled box; max 13 pixels high. */
330 xxxxxxx.
331 xxxxxxx.
332 xxxxxxx.
333 xxxxxxx.
334 xxxxxxx.
335 xxxxxxx.
336 xxxxxxx.
337 xxxxxxx.
338 xxxxxxx.
339 xxxxxxx.
340 xxxxxxx.
341 xxxxxxx.
342 xxxxxxx.
344 static unsigned short filled_rectangle_bits[] = {
345 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe};
347 /* Hollow box cursor bitmap. A hollow box; max 13 pixels high. */
349 xxxxxxx.
350 x.....x.
351 x.....x.
352 x.....x.
353 x.....x.
354 x.....x.
355 x.....x.
356 x.....x.
357 x.....x.
358 x.....x.
359 x.....x.
360 x.....x.
361 xxxxxxx.
363 static unsigned short hollow_rectangle_bits[] = {
364 0xfe, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0xfe};
366 /* Hollow square bitmap. */
368 .xxxxxx.
369 .x....x.
370 .x....x.
371 .x....x.
372 .x....x.
373 .xxxxxx.
375 static unsigned short hollow_square_bits[] = {
376 0x7e, 0x42, 0x42, 0x42, 0x42, 0x7e};
378 /* Filled square bitmap. */
380 .xxxxxx.
381 .xxxxxx.
382 .xxxxxx.
383 .xxxxxx.
384 .xxxxxx.
385 .xxxxxx.
387 static unsigned short filled_square_bits[] = {
388 0x7e, 0x7e, 0x7e, 0x7e, 0x7e, 0x7e};
390 /* Bar cursor bitmap. A vertical bar; max 13 pixels high. */
392 xx......
393 xx......
394 xx......
395 xx......
396 xx......
397 xx......
398 xx......
399 xx......
400 xx......
401 xx......
402 xx......
403 xx......
404 xx......
406 static unsigned short vertical_bar_bits[] = {
407 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0};
409 /* HBar cursor bitmap. A horizontal bar; 2 pixels high. */
411 xxxxxxx.
412 xxxxxxx.
414 static unsigned short horizontal_bar_bits[] = {
415 0xfe, 0xfe};
418 /* Bitmap drawn to indicate lines not displaying text if
419 `indicate-empty-lines' is non-nil. */
421 ........
422 ..xxxx..
423 ........
424 ........
425 ..xxxx..
426 ........
428 static unsigned short empty_line_bits[] = {
429 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
430 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
431 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
432 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
433 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
434 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
435 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
436 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
439 #define BYTES_PER_BITMAP_ROW (sizeof (unsigned short))
440 #define STANDARD_BITMAP_HEIGHT(bits) (sizeof (bits)/BYTES_PER_BITMAP_ROW)
441 #define FRBITS(bits) bits, STANDARD_BITMAP_HEIGHT (bits)
443 /* NOTE: The order of these bitmaps must match the sequence
444 used in fringe.el to define the corresponding symbols. */
446 static struct fringe_bitmap standard_bitmaps[] =
448 { NULL, 0, 0, 0, 0, 0 }, /* NO_FRINGE_BITMAP */
449 { FRBITS (question_mark_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
450 { FRBITS (exclamation_mark_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
451 { FRBITS (left_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
452 { FRBITS (right_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
453 { FRBITS (up_arrow_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
454 { FRBITS (down_arrow_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
455 { FRBITS (left_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
456 { FRBITS (right_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
457 { FRBITS (left_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
458 { FRBITS (right_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
459 { FRBITS (top_left_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
460 { FRBITS (top_right_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
461 { FRBITS (bottom_left_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
462 { FRBITS (bottom_right_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
463 { FRBITS (left_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
464 { FRBITS (right_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
465 { FRBITS (filled_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
466 { FRBITS (hollow_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
467 { FRBITS (filled_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
468 { FRBITS (hollow_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
469 { FRBITS (vertical_bar_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
470 { FRBITS (horizontal_bar_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
471 { FRBITS (empty_line_bits), 8, 3, ALIGN_BITMAP_TOP, 0 },
474 #define NO_FRINGE_BITMAP 0
475 #define UNDEF_FRINGE_BITMAP 1
476 #define MAX_STANDARD_FRINGE_BITMAPS (sizeof (standard_bitmaps)/sizeof (standard_bitmaps[0]))
478 static struct fringe_bitmap **fringe_bitmaps;
479 static Lisp_Object *fringe_faces;
480 static int max_fringe_bitmaps;
482 #ifndef HAVE_NS
483 static
484 #endif
485 int max_used_fringe_bitmap = MAX_STANDARD_FRINGE_BITMAPS;
488 /* Lookup bitmap number for symbol BITMAP.
489 Return 0 if not a bitmap. */
492 lookup_fringe_bitmap (Lisp_Object bitmap)
494 EMACS_INT bn;
496 bitmap = Fget (bitmap, Qfringe);
497 if (!INTEGERP (bitmap))
498 return 0;
500 bn = XINT (bitmap);
501 if (bn > NO_FRINGE_BITMAP
502 && bn < max_used_fringe_bitmap
503 && (bn < MAX_STANDARD_FRINGE_BITMAPS
504 || fringe_bitmaps[bn] != NULL))
505 return bn;
507 return 0;
510 /* Get fringe bitmap name for bitmap number BN.
512 Found by traversing Vfringe_bitmaps comparing BN to the
513 fringe property for each symbol.
515 Return BN if not found in Vfringe_bitmaps. */
517 static Lisp_Object
518 get_fringe_bitmap_name (int bn)
520 Lisp_Object bitmaps;
521 Lisp_Object num;
523 /* Zero means no bitmap -- return nil. */
524 if (bn <= 0)
525 return Qnil;
527 bitmaps = Vfringe_bitmaps;
528 num = make_number (bn);
530 while (CONSP (bitmaps))
532 Lisp_Object bitmap = XCAR (bitmaps);
533 if (EQ (num, Fget (bitmap, Qfringe)))
534 return bitmap;
535 bitmaps = XCDR (bitmaps);
538 return num;
541 /* Get fringe bitmap data for bitmap number BN. */
543 static struct fringe_bitmap *
544 get_fringe_bitmap_data (int bn)
546 struct fringe_bitmap *fb;
548 fb = fringe_bitmaps[bn];
549 if (fb == NULL)
550 fb = &standard_bitmaps[bn < MAX_STANDARD_FRINGE_BITMAPS
551 ? bn : UNDEF_FRINGE_BITMAP];
553 return fb;
556 /* Draw the bitmap WHICH in one of the left or right fringes of
557 window W. ROW is the glyph row for which to display the bitmap; it
558 determines the vertical position at which the bitmap has to be
559 drawn.
560 LEFT_P is 1 for left fringe, 0 for right fringe.
563 static void
564 draw_fringe_bitmap_1 (struct window *w, struct glyph_row *row, int left_p, int overlay, int which)
566 struct frame *f = XFRAME (WINDOW_FRAME (w));
567 struct draw_fringe_bitmap_params p;
568 struct fringe_bitmap *fb;
569 int period;
570 int face_id = DEFAULT_FACE_ID;
571 int offset, header_line_height;
573 p.overlay_p = (overlay & 1) == 1;
574 p.cursor_p = (overlay & 2) == 2;
576 if (which != NO_FRINGE_BITMAP)
578 offset = 0;
580 else if (left_p)
582 which = row->left_fringe_bitmap;
583 face_id = row->left_fringe_face_id;
584 offset = row->left_fringe_offset;
586 else
588 which = row->right_fringe_bitmap;
589 face_id = row->right_fringe_face_id;
590 offset = row->right_fringe_offset;
593 if (face_id == DEFAULT_FACE_ID)
595 Lisp_Object face = fringe_faces[which];
596 face_id = NILP (face) ? lookup_named_face (f, Qfringe, 0)
597 : lookup_derived_face (f, face, FRINGE_FACE_ID, 0);
598 if (face_id < 0)
599 face_id = FRINGE_FACE_ID;
602 fb = get_fringe_bitmap_data (which);
604 period = fb->period;
606 /* Convert row to frame coordinates. */
607 p.y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y) + offset;
609 p.which = which;
610 p.bits = fb->bits;
611 p.wd = fb->width;
613 p.h = fb->height;
614 p.dh = (period > 0 ? (p.y % period) : 0);
615 p.h -= p.dh;
617 /* Adjust y to the offset in the row to start drawing the bitmap. */
618 switch (fb->align)
620 case ALIGN_BITMAP_CENTER:
621 p.y += (row->height - p.h) / 2;
622 break;
623 case ALIGN_BITMAP_BOTTOM:
624 p.y += (row->visible_height - p.h);
625 break;
626 case ALIGN_BITMAP_TOP:
627 break;
630 p.face = FACE_FROM_ID (f, face_id);
632 if (p.face == NULL)
634 /* This could happen after clearing face cache.
635 But it shouldn't happen anymore. ++kfs */
636 return;
639 PREPARE_FACE_FOR_DISPLAY (f, p.face);
641 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
642 the fringe. */
643 p.bx = -1;
644 header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
645 p.by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, row->y));
646 p.ny = row->visible_height;
647 if (left_p)
649 int wd = WINDOW_LEFT_FRINGE_WIDTH (w);
650 int x = window_box_left (w, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
651 ? LEFT_MARGIN_AREA
652 : TEXT_AREA));
653 if (p.wd > wd)
654 p.wd = wd;
655 p.x = x - p.wd - (wd - p.wd) / 2;
657 if (p.wd < wd || p.y > p.by || p.y + p.h < p.by + p.ny)
659 /* If W has a vertical border to its left, don't draw over it. */
660 wd -= ((!WINDOW_LEFTMOST_P (w)
661 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
662 /* But don't reduce the fringe width if the window
663 has a left margin, because that means we are not
664 in danger of drawing over the vertical border,
665 and OTOH leaving out that one pixel leaves behind
666 traces of the cursor, if it was in column zero
667 before drawing non-empty margin area. */
668 && NILP (w->left_margin_cols))
669 ? 1 : 0);
670 p.bx = x - wd;
671 p.nx = wd;
674 else
676 int x = window_box_right (w,
677 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
678 ? RIGHT_MARGIN_AREA
679 : TEXT_AREA));
680 int wd = WINDOW_RIGHT_FRINGE_WIDTH (w);
681 if (p.wd > wd)
682 p.wd = wd;
683 p.x = x + (wd - p.wd) / 2;
684 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
685 the fringe. */
686 if (p.wd < wd || p.y > p.by || p.y + p.h < p.by + p.ny)
688 p.bx = x;
689 p.nx = wd;
693 FRAME_RIF (f)->draw_fringe_bitmap (w, row, &p);
696 static int
697 get_logical_cursor_bitmap (struct window *w, Lisp_Object cursor)
699 Lisp_Object cmap, bm = Qnil;
701 if ((cmap = BVAR (XBUFFER (w->buffer), fringe_cursor_alist)), !NILP (cmap))
703 bm = Fassq (cursor, cmap);
704 if (CONSP (bm))
706 if ((bm = XCDR (bm)), NILP (bm))
707 return NO_FRINGE_BITMAP;
708 return lookup_fringe_bitmap (bm);
711 if (EQ (cmap, BVAR (&buffer_defaults, fringe_cursor_alist)))
712 return NO_FRINGE_BITMAP;
713 bm = Fassq (cursor, BVAR (&buffer_defaults, fringe_cursor_alist));
714 if (!CONSP (bm) || ((bm = XCDR (bm)), NILP (bm)))
715 return NO_FRINGE_BITMAP;
716 return lookup_fringe_bitmap (bm);
719 static int
720 get_logical_fringe_bitmap (struct window *w, Lisp_Object bitmap, int right_p, int partial_p)
722 Lisp_Object cmap, bm1 = Qnil, bm2 = Qnil, bm;
723 EMACS_INT ln1 = 0, ln2 = 0;
724 int ix1 = right_p;
725 int ix2 = ix1 + (partial_p ? 2 : 0);
727 /* Lookup in buffer-local fringe-indicator-alist before global alist.
729 Elements are:
730 BITMAP -- use for all
731 (L R) -- use for left right (whether partial or not)
732 (L R PL PR) -- use for left right partial-left partial-right
733 If any value in local binding is not present or t, use global value.
735 If partial, lookup partial bitmap in default value if not found here.
736 If not partial, or no partial spec is present, use non-partial bitmap. */
738 if ((cmap = BVAR (XBUFFER (w->buffer), fringe_indicator_alist)), !NILP (cmap))
740 bm1 = Fassq (bitmap, cmap);
741 if (CONSP (bm1))
743 if ((bm1 = XCDR (bm1)), NILP (bm1))
744 return NO_FRINGE_BITMAP;
745 if (CONSP (bm1))
747 ln1 = XINT (Flength (bm1));
748 if (partial_p)
750 if (ln1 > ix2)
752 bm = Fnth (make_number (ix2), bm1);
753 if (!EQ (bm, Qt))
754 goto found;
757 else
759 if (ln1 > ix1)
761 bm = Fnth (make_number (ix1), bm1);
762 if (!EQ (bm, Qt))
763 goto found;
767 else if ((bm = bm1, !EQ (bm, Qt)))
768 goto found;
772 if (!EQ (cmap, BVAR (&buffer_defaults, fringe_indicator_alist))
773 && !NILP (BVAR (&buffer_defaults, fringe_indicator_alist)))
775 bm2 = Fassq (bitmap, BVAR (&buffer_defaults, fringe_indicator_alist));
776 if (CONSP (bm2))
778 if ((bm2 = XCDR (bm2)), !NILP (bm2))
780 if (CONSP (bm2))
782 ln2 = XINT (Flength (bm2));
783 if (partial_p)
785 if (ln2 > ix2)
787 bm = Fnth (make_number (ix2), bm2);
788 if (!EQ (bm, Qt))
789 goto found;
797 if (ln1 > ix1)
799 bm = Fnth (make_number (ix1), bm1);
800 if (!EQ (bm, Qt))
801 goto found;
804 if (ln2 > ix1)
806 bm = Fnth (make_number (ix1), bm2);
807 if (!EQ (bm, Qt))
808 goto found;
809 return NO_FRINGE_BITMAP;
811 else if ((bm = bm2, NILP (bm)))
812 return NO_FRINGE_BITMAP;
814 found:
815 return lookup_fringe_bitmap (bm);
819 void
820 draw_fringe_bitmap (struct window *w, struct glyph_row *row, int left_p)
822 int overlay = 0;
824 if (left_p == row->reversed_p && row->cursor_in_fringe_p)
826 Lisp_Object cursor = Qnil;
828 switch (w->phys_cursor_type)
830 case HOLLOW_BOX_CURSOR:
831 if (row->visible_height >= STANDARD_BITMAP_HEIGHT (hollow_rectangle_bits))
832 cursor = Qhollow;
833 else
834 cursor = Qhollow_small;
835 break;
836 case FILLED_BOX_CURSOR:
837 cursor = Qbox;
838 break;
839 case BAR_CURSOR:
840 cursor = Qbar;
841 break;
842 case HBAR_CURSOR:
843 cursor = Qhbar;
844 break;
845 case NO_CURSOR:
846 default:
847 w->phys_cursor_on_p = 0;
848 row->cursor_in_fringe_p = 0;
849 break;
851 if (!NILP (cursor))
853 int bm = get_logical_cursor_bitmap (w, cursor);
854 if (bm != NO_FRINGE_BITMAP)
856 draw_fringe_bitmap_1 (w, row, left_p, 2, bm);
857 overlay = EQ (cursor, Qbox) ? 3 : 1;
862 draw_fringe_bitmap_1 (w, row, left_p, overlay, NO_FRINGE_BITMAP);
864 if (left_p && row->overlay_arrow_bitmap != NO_FRINGE_BITMAP)
865 draw_fringe_bitmap_1 (w, row, 1, 1, row->overlay_arrow_bitmap);
869 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
870 function with input blocked. */
872 void
873 draw_row_fringe_bitmaps (struct window *w, struct glyph_row *row)
875 eassert (input_blocked_p ());
877 /* If row is completely invisible, because of vscrolling, we
878 don't have to draw anything. */
879 if (row->visible_height <= 0)
880 return;
882 if (WINDOW_LEFT_FRINGE_WIDTH (w) != 0)
883 draw_fringe_bitmap (w, row, 1);
885 if (WINDOW_RIGHT_FRINGE_WIDTH (w) != 0)
886 draw_fringe_bitmap (w, row, 0);
889 /* Draw the fringes of window W. Only fringes for rows marked for
890 update in redraw_fringe_bitmaps_p are drawn.
892 Return >0 if left or right fringe was redrawn in any way.
894 If NO_FRINGE is non-zero, also return >0 if either fringe has zero width.
896 A return value >0 indicates that the vertical line between windows
897 needs update (as it may be drawn in the fringe).
901 draw_window_fringes (struct window *w, int no_fringe)
903 struct glyph_row *row;
904 int yb = window_text_bottom_y (w);
905 int nrows = w->current_matrix->nrows;
906 int y, rn;
907 int updated = 0;
909 if (w->pseudo_window_p)
910 return 0;
912 /* Must draw line if no fringe */
913 if (no_fringe
914 && (WINDOW_LEFT_FRINGE_WIDTH (w) == 0
915 || WINDOW_RIGHT_FRINGE_WIDTH (w) == 0))
916 updated++;
918 for (y = w->vscroll, rn = 0, row = w->current_matrix->rows;
919 y < yb && rn < nrows;
920 y += row->height, ++row, ++rn)
922 if (!row->redraw_fringe_bitmaps_p)
923 continue;
924 draw_row_fringe_bitmaps (w, row);
925 row->redraw_fringe_bitmaps_p = 0;
926 updated++;
929 return updated;
933 /* Recalculate the bitmaps to show in the fringes of window W.
934 Only mark rows with modified bitmaps for update in redraw_fringe_bitmaps_p.
936 If KEEP_CURRENT_P is 0, update current_matrix too. */
939 update_window_fringes (struct window *w, int keep_current_p)
941 struct glyph_row *row, *cur = 0;
942 int yb = window_text_bottom_y (w);
943 int rn, nrows = w->current_matrix->nrows;
944 int y;
945 int redraw_p = 0;
946 Lisp_Object boundary_top = Qnil, boundary_bot = Qnil;
947 Lisp_Object arrow_top = Qnil, arrow_bot = Qnil;
948 Lisp_Object empty_pos;
949 Lisp_Object ind = Qnil;
950 #define MAX_BITMAP_CACHE (8*4)
951 int bitmap_cache[MAX_BITMAP_CACHE];
952 int top_ind_rn, bot_ind_rn;
953 int top_ind_min_y, bot_ind_max_y;
955 /* top_ind_rn is set to a nonnegative value whenever
956 row->indicate_bob_p is set, so it's OK that top_row_ends_at_zv_p
957 is not initialized here. Similarly for bot_ind_rn,
958 row->indicate_eob_p and bot_row_ends_at_zv_p. */
959 int top_row_ends_at_zv_p IF_LINT (= 0), bot_row_ends_at_zv_p IF_LINT (= 0);
961 if (w->pseudo_window_p)
962 return 0;
964 if (!MINI_WINDOW_P (w)
965 && (ind = BVAR (XBUFFER (w->buffer), indicate_buffer_boundaries), !NILP (ind)))
967 if (EQ (ind, Qleft) || EQ (ind, Qright))
968 boundary_top = boundary_bot = arrow_top = arrow_bot = ind;
969 else if (CONSP (ind) && CONSP (XCAR (ind)))
971 Lisp_Object pos;
972 if (pos = Fassq (Qt, ind), !NILP (pos))
973 boundary_top = boundary_bot = arrow_top = arrow_bot = XCDR (pos);
974 if (pos = Fassq (Qtop, ind), !NILP (pos))
975 boundary_top = XCDR (pos);
976 if (pos = Fassq (Qbottom, ind), !NILP (pos))
977 boundary_bot = XCDR (pos);
978 if (pos = Fassq (Qup, ind), !NILP (pos))
979 arrow_top = XCDR (pos);
980 if (pos = Fassq (Qdown, ind), !NILP (pos))
981 arrow_bot = XCDR (pos);
983 else
984 /* Anything else means boundary on left and no arrows. */
985 boundary_top = boundary_bot = Qleft;
988 top_ind_rn = bot_ind_rn = -1;
989 if (!NILP (ind))
991 for (y = w->vscroll, rn = 0;
992 y < yb && rn < nrows;
993 y += row->height, ++rn)
995 row = w->desired_matrix->rows + rn;
996 if (!row->enabled_p)
997 row = w->current_matrix->rows + rn;
999 row->indicate_bob_p = row->indicate_top_line_p = 0;
1000 row->indicate_eob_p = row->indicate_bottom_line_p = 0;
1002 if (!row->mode_line_p)
1004 if (top_ind_rn < 0 && row->visible_height > 0)
1006 if (MATRIX_ROW_START_CHARPOS (row) <= BUF_BEGV (XBUFFER (w->buffer))
1007 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w, row))
1008 row->indicate_bob_p = !NILP (boundary_top);
1009 else
1010 row->indicate_top_line_p = !NILP (arrow_top);
1011 top_ind_rn = rn;
1014 if (bot_ind_rn < 0)
1016 if (MATRIX_ROW_END_CHARPOS (row) >= BUF_ZV (XBUFFER (w->buffer))
1017 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row))
1018 row->indicate_eob_p = !NILP (boundary_bot), bot_ind_rn = rn;
1019 else if (y + row->height >= yb)
1020 row->indicate_bottom_line_p = !NILP (arrow_bot), bot_ind_rn = rn;
1026 empty_pos = BVAR (XBUFFER (w->buffer), indicate_empty_lines);
1027 if (!NILP (empty_pos) && !EQ (empty_pos, Qright))
1028 empty_pos = WINDOW_LEFT_FRINGE_WIDTH (w) == 0 ? Qright : Qleft;
1030 for (y = 0; y < MAX_BITMAP_CACHE; y++)
1031 bitmap_cache[y] = -1;
1033 #define LEFT_FRINGE(cache, which, partial_p) \
1034 (bitmap_cache[cache*4+partial_p] >= 0 \
1035 ? bitmap_cache[cache*4+partial_p] \
1036 : (bitmap_cache[cache*4+partial_p] = \
1037 get_logical_fringe_bitmap (w, which, 0, partial_p)))
1039 #define RIGHT_FRINGE(cache, which, partial_p) \
1040 (bitmap_cache[cache*4+2+partial_p] >= 0 \
1041 ? bitmap_cache[cache*4+2+partial_p] \
1042 : (bitmap_cache[cache*4+2+partial_p] = \
1043 get_logical_fringe_bitmap (w, which, 1, partial_p)))
1046 /* Extend top-aligned top indicator (or bottom-aligned bottom
1047 indicator) to adjacent rows if it doesn't fit in one row. */
1048 top_ind_min_y = bot_ind_max_y = -1;
1049 if (top_ind_rn >= 0)
1051 int bn = NO_FRINGE_BITMAP;
1053 row = w->desired_matrix->rows + top_ind_rn;
1054 if (!row->enabled_p)
1055 row = w->current_matrix->rows + top_ind_rn;
1057 top_row_ends_at_zv_p = row->ends_at_zv_p;
1058 if (row->indicate_bob_p)
1060 if (EQ (boundary_top, Qleft))
1061 bn = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1062 ? LEFT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1063 : LEFT_FRINGE (2, Qtop, 0));
1064 else
1065 bn = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1066 ? RIGHT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1067 : RIGHT_FRINGE (2, Qtop, 0));
1069 else if (row->indicate_top_line_p)
1071 if (EQ (arrow_top, Qleft))
1072 bn = LEFT_FRINGE (6, Qup, 0);
1073 else
1074 bn = RIGHT_FRINGE (6, Qup, 0);
1077 if (bn != NO_FRINGE_BITMAP)
1079 struct fringe_bitmap *fb = get_fringe_bitmap_data (bn);
1081 if (fb->align == ALIGN_BITMAP_TOP && fb->period == 0)
1083 struct glyph_row *row1;
1084 int top_ind_max_y;
1086 top_ind_min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1087 top_ind_max_y = top_ind_min_y + fb->height;
1088 if (top_ind_max_y > yb)
1089 top_ind_max_y = yb;
1091 for (y = row->y + row->height, rn = top_ind_rn + 1;
1092 y < top_ind_max_y && rn < nrows;
1093 y += row1->height, rn++)
1095 if (bot_ind_rn >= 0 && rn >= bot_ind_rn)
1096 break;
1098 row1 = w->desired_matrix->rows + rn;
1099 if (!row1->enabled_p)
1100 row1 = w->current_matrix->rows + rn;
1102 row1->indicate_bob_p = row->indicate_bob_p;
1103 row1->indicate_top_line_p = row->indicate_top_line_p;
1108 if (bot_ind_rn >= 0)
1110 int bn = NO_FRINGE_BITMAP;
1112 row = w->desired_matrix->rows + bot_ind_rn;
1113 if (!row->enabled_p)
1114 row = w->current_matrix->rows + bot_ind_rn;
1116 bot_row_ends_at_zv_p = row->ends_at_zv_p;
1117 if (row->indicate_eob_p)
1119 if (EQ (boundary_bot, Qleft))
1120 bn = LEFT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1121 else
1122 bn = RIGHT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1124 else if (row->indicate_bottom_line_p)
1126 if (EQ (arrow_bot, Qleft))
1127 bn = LEFT_FRINGE (7, Qdown, 0);
1128 else
1129 bn = RIGHT_FRINGE (7, Qdown, 0);
1132 if (bn != NO_FRINGE_BITMAP)
1134 struct fringe_bitmap *fb = get_fringe_bitmap_data (bn);
1136 if (fb->align == ALIGN_BITMAP_BOTTOM && fb->period == 0)
1138 struct glyph_row *row1;
1139 int bot_ind_min_y;
1141 bot_ind_max_y = row->y + row->visible_height;
1142 bot_ind_min_y = bot_ind_max_y - fb->height;
1143 if (bot_ind_min_y < WINDOW_HEADER_LINE_HEIGHT (w))
1144 bot_ind_min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1146 for (y = row->y, rn = bot_ind_rn - 1;
1147 y >= bot_ind_min_y && rn >= 0;
1148 y -= row1->height, rn--)
1150 if (top_ind_rn >= 0 && rn <= top_ind_rn)
1151 break;
1153 row1 = w->desired_matrix->rows + rn;
1154 if (!row1->enabled_p)
1155 row1 = w->current_matrix->rows + rn;
1157 row1->indicate_eob_p = row->indicate_eob_p;
1158 row1->indicate_bottom_line_p = row->indicate_bottom_line_p;
1164 for (y = w->vscroll, rn = 0;
1165 y < yb && rn < nrows;
1166 y += row->height, rn++)
1168 int left, right;
1169 unsigned left_face_id, right_face_id;
1170 int left_offset, right_offset;
1171 int periodic_p;
1173 row = w->desired_matrix->rows + rn;
1174 cur = w->current_matrix->rows + rn;
1175 if (!row->enabled_p)
1176 row = cur;
1178 left_face_id = right_face_id = DEFAULT_FACE_ID;
1179 left_offset = right_offset = 0;
1180 periodic_p = 0;
1182 /* Decide which bitmap to draw in the left fringe. */
1183 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
1184 left = NO_FRINGE_BITMAP;
1185 else if (row->left_user_fringe_bitmap != NO_FRINGE_BITMAP)
1187 left = row->left_user_fringe_bitmap;
1188 left_face_id = row->left_user_fringe_face_id;
1190 else if ((!row->reversed_p && row->truncated_on_left_p)
1191 || (row->reversed_p && row->truncated_on_right_p))
1192 left = LEFT_FRINGE (0, Qtruncation, 0);
1193 else if (row->indicate_bob_p && EQ (boundary_top, Qleft))
1195 left = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1196 ? LEFT_FRINGE (1, Qtop_bottom, top_row_ends_at_zv_p)
1197 : LEFT_FRINGE (2, Qtop, 0));
1198 if (top_ind_min_y >= 0)
1199 left_offset = top_ind_min_y - row->y;
1201 else if (row->indicate_eob_p && EQ (boundary_bot, Qleft))
1203 left = LEFT_FRINGE (3, Qbottom, bot_row_ends_at_zv_p);
1204 if (bot_ind_max_y >= 0)
1205 left_offset = bot_ind_max_y - (row->y + row->visible_height);
1207 else if ((!row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row))
1208 || (row->reversed_p && row->continued_p))
1209 left = LEFT_FRINGE (4, Qcontinuation, 0);
1210 else if (row->indicate_empty_line_p && EQ (empty_pos, Qleft))
1211 left = LEFT_FRINGE (5, Qempty_line, 0);
1212 else if (row->indicate_top_line_p && EQ (arrow_top, Qleft))
1214 left = LEFT_FRINGE (6, Qup, 0);
1215 if (top_ind_min_y >= 0)
1216 left_offset = top_ind_min_y - row->y;
1218 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qleft))
1220 left = LEFT_FRINGE (7, Qdown, 0);
1221 if (bot_ind_max_y >= 0)
1222 left_offset = bot_ind_max_y - (row->y + row->visible_height);
1224 else
1225 left = NO_FRINGE_BITMAP;
1227 /* Decide which bitmap to draw in the right fringe. */
1228 if (WINDOW_RIGHT_FRINGE_WIDTH (w) == 0)
1229 right = NO_FRINGE_BITMAP;
1230 else if (row->right_user_fringe_bitmap != NO_FRINGE_BITMAP)
1232 right = row->right_user_fringe_bitmap;
1233 right_face_id = row->right_user_fringe_face_id;
1235 else if ((!row->reversed_p && row->truncated_on_right_p)
1236 || (row->reversed_p && row->truncated_on_left_p))
1237 right = RIGHT_FRINGE (0, Qtruncation, 0);
1238 else if (row->indicate_bob_p && EQ (boundary_top, Qright))
1240 right = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1241 ? RIGHT_FRINGE (1, Qtop_bottom, top_row_ends_at_zv_p)
1242 : RIGHT_FRINGE (2, Qtop, 0));
1243 if (top_ind_min_y >= 0)
1244 right_offset = top_ind_min_y - row->y;
1246 else if (row->indicate_eob_p && EQ (boundary_bot, Qright))
1248 right = RIGHT_FRINGE (3, Qbottom, bot_row_ends_at_zv_p);
1249 if (bot_ind_max_y >= 0)
1250 right_offset = bot_ind_max_y - (row->y + row->visible_height);
1252 else if ((!row->reversed_p && row->continued_p)
1253 || (row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row)))
1254 right = RIGHT_FRINGE (4, Qcontinuation, 0);
1255 else if (row->indicate_top_line_p && EQ (arrow_top, Qright))
1257 right = RIGHT_FRINGE (6, Qup, 0);
1258 if (top_ind_min_y >= 0)
1259 right_offset = top_ind_min_y - row->y;
1261 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qright))
1263 right = RIGHT_FRINGE (7, Qdown, 0);
1264 if (bot_ind_max_y >= 0)
1265 right_offset = bot_ind_max_y - (row->y + row->visible_height);
1267 else if (row->indicate_empty_line_p && EQ (empty_pos, Qright))
1268 right = RIGHT_FRINGE (5, Qempty_line, 0);
1269 else
1270 right = NO_FRINGE_BITMAP;
1272 periodic_p = (get_fringe_bitmap_data (left)->period != 0
1273 || get_fringe_bitmap_data (right)->period != 0);
1275 if (row->y != cur->y
1276 || row->visible_height != cur->visible_height
1277 || row->ends_at_zv_p != cur->ends_at_zv_p
1278 || left != cur->left_fringe_bitmap
1279 || right != cur->right_fringe_bitmap
1280 || left_face_id != cur->left_fringe_face_id
1281 || right_face_id != cur->right_fringe_face_id
1282 || left_offset != cur->left_fringe_offset
1283 || right_offset != cur->right_fringe_offset
1284 || periodic_p != cur->fringe_bitmap_periodic_p
1285 || cur->redraw_fringe_bitmaps_p)
1287 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1288 if (!keep_current_p)
1290 cur->redraw_fringe_bitmaps_p = 1;
1291 cur->left_fringe_bitmap = left;
1292 cur->right_fringe_bitmap = right;
1293 cur->left_fringe_face_id = left_face_id;
1294 cur->right_fringe_face_id = right_face_id;
1295 cur->left_fringe_offset = left_offset;
1296 cur->right_fringe_offset = right_offset;
1297 cur->fringe_bitmap_periodic_p = periodic_p;
1301 if (row->overlay_arrow_bitmap < 0)
1302 row->overlay_arrow_bitmap = get_logical_fringe_bitmap (w, Qoverlay_arrow, 0, 0);
1304 if (row->overlay_arrow_bitmap != cur->overlay_arrow_bitmap)
1306 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1307 if (!keep_current_p)
1309 cur->redraw_fringe_bitmaps_p = 1;
1310 cur->overlay_arrow_bitmap = row->overlay_arrow_bitmap;
1314 row->left_fringe_bitmap = left;
1315 row->right_fringe_bitmap = right;
1316 row->left_fringe_face_id = left_face_id;
1317 row->right_fringe_face_id = right_face_id;
1318 row->left_fringe_offset = left_offset;
1319 row->right_fringe_offset = right_offset;
1320 row->fringe_bitmap_periodic_p = periodic_p;
1323 return redraw_p && !keep_current_p;
1327 /* Compute actual fringe widths for frame F.
1329 If REDRAW is 1, redraw F if the fringe settings was actually
1330 modified and F is visible.
1332 Since the combined left and right fringe must occupy an integral
1333 number of columns, we may need to add some pixels to each fringe.
1334 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
1335 but a negative width value is taken literally (after negating it).
1337 We never make the fringes narrower than specified.
1340 void
1341 compute_fringe_widths (struct frame *f, int redraw)
1343 int o_left = FRAME_LEFT_FRINGE_WIDTH (f);
1344 int o_right = FRAME_RIGHT_FRINGE_WIDTH (f);
1345 int o_cols = FRAME_FRINGE_COLS (f);
1347 Lisp_Object left_fringe = Fassq (Qleft_fringe, f->param_alist);
1348 Lisp_Object right_fringe = Fassq (Qright_fringe, f->param_alist);
1349 int left_fringe_width, right_fringe_width;
1351 if (!NILP (left_fringe))
1352 left_fringe = Fcdr (left_fringe);
1353 if (!NILP (right_fringe))
1354 right_fringe = Fcdr (right_fringe);
1356 left_fringe_width = ((NILP (left_fringe) || !INTEGERP (left_fringe)) ? 8 :
1357 XINT (left_fringe));
1358 right_fringe_width = ((NILP (right_fringe) || !INTEGERP (right_fringe)) ? 8 :
1359 XINT (right_fringe));
1361 if (left_fringe_width || right_fringe_width)
1363 int left_wid = left_fringe_width >= 0 ? left_fringe_width : -left_fringe_width;
1364 int right_wid = right_fringe_width >= 0 ? right_fringe_width : -right_fringe_width;
1365 int conf_wid = left_wid + right_wid;
1366 int font_wid = FRAME_COLUMN_WIDTH (f);
1367 int cols = (left_wid + right_wid + font_wid-1) / font_wid;
1368 int real_wid = cols * font_wid;
1369 if (left_wid && right_wid)
1371 if (left_fringe_width < 0)
1373 /* Left fringe width is fixed, adjust right fringe if necessary */
1374 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid;
1375 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid - left_wid;
1377 else if (right_fringe_width < 0)
1379 /* Right fringe width is fixed, adjust left fringe if necessary */
1380 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid - right_wid;
1381 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid;
1383 else
1385 /* Adjust both fringes with an equal amount.
1386 Note that we are doing integer arithmetic here, so don't
1387 lose a pixel if the total width is an odd number. */
1388 int fill = real_wid - conf_wid;
1389 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid + fill/2;
1390 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid + fill - fill/2;
1393 else if (left_fringe_width)
1395 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid;
1396 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1398 else
1400 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1401 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid;
1403 FRAME_FRINGE_COLS (f) = cols;
1405 else
1407 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1408 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1409 FRAME_FRINGE_COLS (f) = 0;
1412 if (redraw && FRAME_VISIBLE_P (f))
1413 if (o_left != FRAME_LEFT_FRINGE_WIDTH (f) ||
1414 o_right != FRAME_RIGHT_FRINGE_WIDTH (f) ||
1415 o_cols != FRAME_FRINGE_COLS (f))
1416 redraw_frame (f);
1420 /* Free resources used by a user-defined bitmap. */
1422 static void
1423 destroy_fringe_bitmap (int n)
1425 struct fringe_bitmap **fbp;
1427 fringe_faces[n] = Qnil;
1429 fbp = &fringe_bitmaps[n];
1430 if (*fbp && (*fbp)->dynamic)
1432 /* XXX Is SELECTED_FRAME OK here? */
1433 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1434 if (rif && rif->destroy_fringe_bitmap)
1435 rif->destroy_fringe_bitmap (n);
1436 xfree (*fbp);
1437 *fbp = NULL;
1440 while (max_used_fringe_bitmap > MAX_STANDARD_FRINGE_BITMAPS
1441 && fringe_bitmaps[max_used_fringe_bitmap - 1] == NULL)
1442 max_used_fringe_bitmap--;
1446 DEFUN ("destroy-fringe-bitmap", Fdestroy_fringe_bitmap, Sdestroy_fringe_bitmap,
1447 1, 1, 0,
1448 doc: /* Destroy fringe bitmap BITMAP.
1449 If BITMAP overrides a standard fringe bitmap, the original bitmap is restored. */)
1450 (Lisp_Object bitmap)
1452 int n;
1454 CHECK_SYMBOL (bitmap);
1455 n = lookup_fringe_bitmap (bitmap);
1456 if (!n)
1457 return Qnil;
1459 destroy_fringe_bitmap (n);
1461 if (n >= MAX_STANDARD_FRINGE_BITMAPS)
1463 Vfringe_bitmaps = Fdelq (bitmap, Vfringe_bitmaps);
1464 /* It would be better to remove the fringe property. */
1465 Fput (bitmap, Qfringe, Qnil);
1468 return Qnil;
1472 /* Initialize bitmap bit.
1474 On X, we bit-swap the built-in bitmaps and reduce bitmap
1475 from short to char array if width is <= 8 bits.
1477 On MAC with big-endian CPU, we need to byte-swap each short.
1479 On W32 and MAC (little endian), there's no need to do this.
1482 #if defined (HAVE_X_WINDOWS)
1483 static const unsigned char swap_nibble[16] = {
1484 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
1485 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
1486 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
1487 0x3, 0xb, 0x7, 0xf}; /* 0011 1011 0111 1111 */
1488 #endif /* HAVE_X_WINDOWS */
1490 static void
1491 init_fringe_bitmap (int which, struct fringe_bitmap *fb, int once_p)
1493 if (once_p || fb->dynamic)
1495 #if defined (HAVE_X_WINDOWS)
1496 unsigned short *bits = fb->bits;
1497 int j;
1499 if (fb->width <= 8)
1501 unsigned char *cbits = (unsigned char *)fb->bits;
1502 for (j = 0; j < fb->height; j++)
1504 unsigned short b = *bits++;
1505 unsigned char c;
1506 c = (unsigned char)((swap_nibble[b & 0xf] << 4)
1507 | (swap_nibble[(b>>4) & 0xf]));
1508 *cbits++ = (c >> (8 - fb->width));
1511 else
1513 for (j = 0; j < fb->height; j++)
1515 unsigned short b = *bits;
1516 b = (unsigned short)((swap_nibble[b & 0xf] << 12)
1517 | (swap_nibble[(b>>4) & 0xf] << 8)
1518 | (swap_nibble[(b>>8) & 0xf] << 4)
1519 | (swap_nibble[(b>>12) & 0xf]));
1520 b >>= (16 - fb->width);
1521 #ifdef WORDS_BIGENDIAN
1522 b = ((b >> 8) | (b << 8));
1523 #endif
1524 *bits++ = b;
1527 #endif /* HAVE_X_WINDOWS */
1531 if (!once_p)
1533 /* XXX Is SELECTED_FRAME OK here? */
1534 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1536 destroy_fringe_bitmap (which);
1538 if (rif && rif->define_fringe_bitmap)
1539 rif->define_fringe_bitmap (which, fb->bits, fb->height, fb->width);
1541 fringe_bitmaps[which] = fb;
1542 if (which >= max_used_fringe_bitmap)
1543 max_used_fringe_bitmap = which + 1;
1548 DEFUN ("define-fringe-bitmap", Fdefine_fringe_bitmap, Sdefine_fringe_bitmap,
1549 2, 5, 0,
1550 doc: /* Define fringe bitmap BITMAP from BITS of size HEIGHT x WIDTH.
1551 BITMAP is a symbol identifying the new fringe bitmap.
1552 BITS is either a string or a vector of integers.
1553 HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
1554 WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
1555 Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
1556 indicating the positioning of the bitmap relative to the rows where it
1557 is used; the default is to center the bitmap. Fifth arg may also be a
1558 list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap
1559 should be repeated.
1560 If BITMAP already exists, the existing definition is replaced. */)
1561 (Lisp_Object bitmap, Lisp_Object bits, Lisp_Object height, Lisp_Object width, Lisp_Object align)
1563 int n, h, i, j;
1564 unsigned short *b;
1565 struct fringe_bitmap fb, *xfb;
1566 int fill1 = 0, fill2 = 0;
1568 CHECK_SYMBOL (bitmap);
1570 if (STRINGP (bits))
1571 h = SCHARS (bits);
1572 else if (VECTORP (bits))
1573 h = ASIZE (bits);
1574 else
1575 wrong_type_argument (Qsequencep, bits);
1577 if (NILP (height))
1578 fb.height = h;
1579 else
1581 CHECK_NUMBER (height);
1582 fb.height = max (0, min (XINT (height), 255));
1583 if (fb.height > h)
1585 fill1 = (fb.height - h) / 2;
1586 fill2 = fb.height - h - fill1;
1590 if (NILP (width))
1591 fb.width = 8;
1592 else
1594 CHECK_NUMBER (width);
1595 fb.width = max (0, min (XINT (width), 255));
1598 fb.period = 0;
1599 fb.align = ALIGN_BITMAP_CENTER;
1601 if (CONSP (align))
1603 Lisp_Object period = XCDR (align);
1604 if (CONSP (period))
1606 period = XCAR (period);
1607 if (!NILP (period))
1609 fb.period = fb.height;
1610 fb.height = 255;
1613 align = XCAR (align);
1615 if (EQ (align, Qtop))
1616 fb.align = ALIGN_BITMAP_TOP;
1617 else if (EQ (align, Qbottom))
1618 fb.align = ALIGN_BITMAP_BOTTOM;
1619 else if (!NILP (align) && !EQ (align, Qcenter))
1620 error ("Bad align argument");
1622 n = lookup_fringe_bitmap (bitmap);
1623 if (!n)
1625 if (max_used_fringe_bitmap < max_fringe_bitmaps)
1626 n = max_used_fringe_bitmap++;
1627 else
1629 for (n = MAX_STANDARD_FRINGE_BITMAPS;
1630 n < max_fringe_bitmaps;
1631 n++)
1632 if (fringe_bitmaps[n] == NULL)
1633 break;
1635 if (n == max_fringe_bitmaps)
1637 int bitmaps = max_fringe_bitmaps + 20;
1638 if (MAX_FRINGE_BITMAPS < bitmaps)
1639 error ("No free fringe bitmap slots");
1641 i = max_fringe_bitmaps;
1642 fringe_bitmaps = xrealloc (fringe_bitmaps,
1643 bitmaps * sizeof *fringe_bitmaps);
1644 fringe_faces = xrealloc (fringe_faces,
1645 bitmaps * sizeof *fringe_faces);
1647 for (i = max_fringe_bitmaps; i < bitmaps; i++)
1649 fringe_bitmaps[i] = NULL;
1650 fringe_faces[i] = Qnil;
1653 max_fringe_bitmaps = bitmaps;
1657 Vfringe_bitmaps = Fcons (bitmap, Vfringe_bitmaps);
1658 Fput (bitmap, Qfringe, make_number (n));
1661 fb.dynamic = 1;
1663 xfb = xmalloc (sizeof fb + fb.height * BYTES_PER_BITMAP_ROW);
1664 fb.bits = b = (unsigned short *) (xfb + 1);
1665 memset (b, 0, fb.height);
1667 j = 0;
1668 while (j < fb.height)
1670 for (i = 0; i < fill1 && j < fb.height; i++)
1671 b[j++] = 0;
1672 for (i = 0; i < h && j < fb.height; i++)
1674 Lisp_Object elt = Faref (bits, make_number (i));
1675 b[j++] = NUMBERP (elt) ? XINT (elt) : 0;
1677 for (i = 0; i < fill2 && j < fb.height; i++)
1678 b[j++] = 0;
1681 *xfb = fb;
1683 init_fringe_bitmap (n, xfb, 0);
1685 return bitmap;
1688 DEFUN ("set-fringe-bitmap-face", Fset_fringe_bitmap_face, Sset_fringe_bitmap_face,
1689 1, 2, 0,
1690 doc: /* Set face for fringe bitmap BITMAP to FACE.
1691 If FACE is nil, reset face to default fringe face. */)
1692 (Lisp_Object bitmap, Lisp_Object face)
1694 int n;
1696 CHECK_SYMBOL (bitmap);
1697 n = lookup_fringe_bitmap (bitmap);
1698 if (!n)
1699 error ("Undefined fringe bitmap");
1701 /* The purpose of the following code is to signal an error if FACE
1702 is not a face. This is for the caller's convenience only; the
1703 redisplay code should be able to fail gracefully. Skip the check
1704 if FRINGE_FACE_ID is unrealized (as in batch mode and during
1705 daemon startup). */
1706 if (!NILP (face))
1708 struct frame *f = SELECTED_FRAME ();
1710 if (FACE_FROM_ID (f, FRINGE_FACE_ID)
1711 && lookup_derived_face (f, face, FRINGE_FACE_ID, 1) < 0)
1712 error ("No such face");
1715 fringe_faces[n] = face;
1716 return Qnil;
1719 DEFUN ("fringe-bitmaps-at-pos", Ffringe_bitmaps_at_pos, Sfringe_bitmaps_at_pos,
1720 0, 2, 0,
1721 doc: /* Return fringe bitmaps of row containing position POS in window WINDOW.
1722 If WINDOW is nil, use selected window. If POS is nil, use value of point
1723 in that window. Return value is a list (LEFT RIGHT OV), where LEFT
1724 is the symbol for the bitmap in the left fringe (or nil if no bitmap),
1725 RIGHT is similar for the right fringe, and OV is non-nil if there is an
1726 overlay arrow in the left fringe.
1727 Return nil if POS is not visible in WINDOW. */)
1728 (Lisp_Object pos, Lisp_Object window)
1730 struct window *w;
1731 struct glyph_row *row;
1732 ptrdiff_t textpos;
1734 if (NILP (window))
1735 window = selected_window;
1736 CHECK_WINDOW (window);
1737 w = XWINDOW (window);
1739 if (!NILP (pos))
1741 CHECK_NUMBER_COERCE_MARKER (pos);
1742 if (! (BEGV <= XINT (pos) && XINT (pos) <= ZV))
1743 args_out_of_range (window, pos);
1744 textpos = XINT (pos);
1746 else if (w == XWINDOW (selected_window))
1747 textpos = PT;
1748 else
1749 textpos = XMARKER (w->pointm)->charpos;
1751 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1752 row = row_containing_pos (w, textpos, row, NULL, 0);
1753 if (row)
1754 return list3 (get_fringe_bitmap_name (row->left_fringe_bitmap),
1755 get_fringe_bitmap_name (row->right_fringe_bitmap),
1756 (row->overlay_arrow_bitmap == 0 ? Qnil
1757 : row->overlay_arrow_bitmap < 0 ? Qt
1758 : get_fringe_bitmap_name (row->overlay_arrow_bitmap)));
1759 else
1760 return Qnil;
1764 /***********************************************************************
1765 Initialization
1766 ***********************************************************************/
1768 void
1769 syms_of_fringe (void)
1771 DEFSYM (Qtruncation, "truncation");
1772 DEFSYM (Qcontinuation, "continuation");
1773 DEFSYM (Qoverlay_arrow, "overlay-arrow");
1774 DEFSYM (Qempty_line, "empty-line");
1775 DEFSYM (Qtop_bottom, "top-bottom");
1776 DEFSYM (Qhollow_small, "hollow-small");
1778 defsubr (&Sdestroy_fringe_bitmap);
1779 defsubr (&Sdefine_fringe_bitmap);
1780 defsubr (&Sfringe_bitmaps_at_pos);
1781 defsubr (&Sset_fringe_bitmap_face);
1783 DEFVAR_LISP ("overflow-newline-into-fringe", Voverflow_newline_into_fringe,
1784 doc: /* Non-nil means that newline may flow into the right fringe.
1785 This means that display lines which are exactly as wide as the window
1786 (not counting the final newline) will only occupy one screen line, by
1787 showing (or hiding) the final newline in the right fringe; when point
1788 is at the final newline, the cursor is shown in the right fringe.
1789 If nil, also continue lines which are exactly as wide as the window. */);
1790 Voverflow_newline_into_fringe = Qt;
1792 DEFVAR_LISP ("fringe-bitmaps", Vfringe_bitmaps,
1793 doc: /* List of fringe bitmap symbols. */);
1794 Vfringe_bitmaps = Qnil;
1797 /* Garbage collection hook */
1799 void
1800 mark_fringe_data (void)
1802 int i;
1804 for (i = 0; i < max_fringe_bitmaps; i++)
1805 if (!NILP (fringe_faces[i]))
1806 mark_object (fringe_faces[i]);
1809 /* Initialize this module when Emacs starts. */
1811 void
1812 init_fringe_once (void)
1814 int bt;
1816 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1817 init_fringe_bitmap (bt, &standard_bitmaps[bt], 1);
1820 void
1821 init_fringe (void)
1823 int i;
1825 max_fringe_bitmaps = MAX_STANDARD_FRINGE_BITMAPS + 20;
1827 fringe_bitmaps = xzalloc (max_fringe_bitmaps * sizeof *fringe_bitmaps);
1828 fringe_faces = xmalloc (max_fringe_bitmaps * sizeof *fringe_faces);
1830 for (i = 0; i < max_fringe_bitmaps; i++)
1831 fringe_faces[i] = Qnil;
1834 #ifdef HAVE_NTGUI
1836 void
1837 w32_init_fringe (struct redisplay_interface *rif)
1839 int bt;
1841 if (!rif)
1842 return;
1844 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1846 struct fringe_bitmap *fb = &standard_bitmaps[bt];
1847 rif->define_fringe_bitmap (bt, fb->bits, fb->height, fb->width);
1851 void
1852 w32_reset_fringes (void)
1854 /* Destroy row bitmaps. */
1855 int bt;
1856 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1858 if (!rif)
1859 return;
1861 for (bt = NO_FRINGE_BITMAP + 1; bt < max_used_fringe_bitmap; bt++)
1862 rif->destroy_fringe_bitmap (bt);
1865 #endif /* HAVE_NTGUI */
1867 #endif /* HAVE_WINDOW_SYSTEM */