* process.h (PSET): Remove.
[emacs.git] / src / fringe.c
blob97d03a2bfae8a2d705b06a9076922d1df76b5419
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>
21 #include <setjmp.h>
23 #include "lisp.h"
24 #include "frame.h"
25 #include "window.h"
26 #include "dispextern.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "blockinput.h"
30 #include "termhooks.h"
32 #ifdef HAVE_WINDOW_SYSTEM
34 /* Fringe bitmaps are represented in three different ways:
36 Logical bitmaps are used internally to denote things like
37 'end-of-buffer', 'left-truncation', 'overlay-arrow', etc.
39 Physical bitmaps specify the visual appearance of the bitmap,
40 e.g. 'bottom-left-angle', 'left-arrow', 'left-triangle', etc.
41 User defined bitmaps are physical bitmaps.
43 Internally, fringe bitmaps for a specific display row are
44 represented as a simple integer that is used as an index
45 into the table of all defined bitmaps. This index is stored
46 in the `fringe' property of the physical bitmap symbol.
48 Logical bitmaps are mapped to physical bitmaps through the
49 buffer-local `fringe-indicator-alist' variable.
51 Each element of this alist is a cons (LOGICAL . PHYSICAL)
52 mapping a logical bitmap to a physical bitmap.
53 PHYSICAL is either a symbol to use in both left and right fringe,
54 or a cons of two symbols (LEFT . RIGHT) denoting different
55 bitmaps to use in left and right fringe.
57 LOGICAL is first looked up in the window's buffer's buffer-local
58 value of the fringe-indicator-alist variable, and if not present,
59 in the global value of fringe-indicator-alist.
61 If LOGICAL is not present in either alist, or the PHYSICAL value
62 found is nil, no bitmap is shown for the logical bitmap.
64 The `left-fringe' and `right-fringe' display properties
65 must specify physical bitmap symbols.
68 static Lisp_Object Qtruncation, Qcontinuation, Qoverlay_arrow;
69 static Lisp_Object Qempty_line, Qtop_bottom;
70 static Lisp_Object Qhollow_small;
72 enum fringe_bitmap_align
74 ALIGN_BITMAP_CENTER = 0,
75 ALIGN_BITMAP_TOP,
76 ALIGN_BITMAP_BOTTOM
79 struct fringe_bitmap
81 unsigned short *bits;
82 unsigned height : 8;
83 unsigned width : 8;
84 unsigned period : 8;
85 unsigned align : 2;
86 unsigned dynamic : 1;
90 /***********************************************************************
91 Fringe bitmaps
92 ***********************************************************************/
94 /* Undefined bitmap. A question mark. */
96 ..xxxx..
97 .xxxxxx.
98 xx....xx
99 xx....xx
100 ....xx..
101 ...xx...
102 ...xx...
103 ........
104 ...xx...
105 ...xx...
107 static unsigned short question_mark_bits[] = {
108 0x3c, 0x7e, 0x7e, 0x0c, 0x18, 0x18, 0x00, 0x18, 0x18};
110 /* An exclamation mark. */
112 ...XX...
113 ...XX...
114 ...XX...
115 ...XX...
116 ...XX...
117 ...XX...
118 ...XX...
119 ........
120 ...XX...
121 ...XX...
123 static unsigned short exclamation_mark_bits[] = {
124 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x00, 0x18};
126 /* An arrow like this: `<-'. */
128 ...xx...
129 ..xx....
130 .xx.....
131 xxxxxx..
132 xxxxxx..
133 .xx.....
134 ..xx....
135 ...xx...
137 static unsigned short left_arrow_bits[] = {
138 0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};
141 /* Right truncation arrow bitmap `->'. */
143 ...xx...
144 ....xx..
145 .....xx.
146 ..xxxxxx
147 ..xxxxxx
148 .....xx.
149 ....xx..
150 ...xx...
152 static unsigned short right_arrow_bits[] = {
153 0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};
156 /* Up arrow bitmap. */
158 ...xx...
159 ..xxxx..
160 .xxxxxx.
161 xxxxxxxx
162 ...xx...
163 ...xx...
164 ...xx...
165 ...xx...
167 static unsigned short up_arrow_bits[] = {
168 0x18, 0x3c, 0x7e, 0xff, 0x18, 0x18, 0x18, 0x18};
171 /* Down arrow bitmap. */
173 ...xx...
174 ...xx...
175 ...xx...
176 ...xx...
177 xxxxxxxx
178 .xxxxxx.
179 ..xxxx..
180 ...xx...
182 static unsigned short down_arrow_bits[] = {
183 0x18, 0x18, 0x18, 0x18, 0xff, 0x7e, 0x3c, 0x18};
185 /* Marker for continuation lines. */
187 ..xxxx..
188 .xxxxx..
189 xx......
190 xxx..x..
191 xxxxxx..
192 .xxxxx..
193 ..xxxx..
194 .xxxxx..
196 static unsigned short left_curly_arrow_bits[] = {
197 0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};
199 /* Marker for continued lines. */
201 ..xxxx..
202 ..xxxxx.
203 ......xx
204 ..x..xxx
205 ..xxxxxx
206 ..xxxxx.
207 ..xxxx..
208 ..xxxxx.
210 static unsigned short right_curly_arrow_bits[] = {
211 0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
213 /* Reverse Overlay arrow bitmap. A triangular arrow. */
215 ......xx
216 ....xxxx
217 ...xxxxx
218 ..xxxxxx
219 ..xxxxxx
220 ...xxxxx
221 ....xxxx
222 ......xx
224 static unsigned short left_triangle_bits[] = {
225 0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};
227 /* Overlay arrow bitmap. A triangular arrow. */
229 xx......
230 xxxx....
231 xxxxx...
232 xxxxxx..
233 xxxxxx..
234 xxxxx...
235 xxxx....
236 xx......
238 static unsigned short right_triangle_bits[] = {
239 0xc0, 0xf0, 0xf8, 0xfc, 0xfc, 0xf8, 0xf0, 0xc0};
241 /* First line bitmap. An top-left angle. */
243 xxxxxx..
244 xxxxxx..
245 xx......
246 xx......
247 xx......
248 xx......
249 xx......
250 ........
252 static unsigned short top_left_angle_bits[] = {
253 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00};
255 /* First line bitmap. An right-up angle. */
257 ..xxxxxx
258 ..xxxxxx
259 ......xx
260 ......xx
261 ......xx
262 ......xx
263 ......xx
264 ........
266 static unsigned short top_right_angle_bits[] = {
267 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00};
269 /* Last line bitmap. An left-down angle. */
271 ........
272 xx......
273 xx......
274 xx......
275 xx......
276 xx......
277 xxxxxx..
278 xxxxxx..
280 static unsigned short bottom_left_angle_bits[] = {
281 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
283 /* Last line bitmap. An right-down angle. */
285 ........
286 ......xx
287 ......xx
288 ......xx
289 ......xx
290 ......xx
291 ..xxxxxx
292 ..xxxxxx
294 static unsigned short bottom_right_angle_bits[] = {
295 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
297 /* First/last line bitmap. An left bracket. */
299 xxxxxx..
300 xxxxxx..
301 xx......
302 xx......
303 xx......
304 xx......
305 xx......
306 xx......
307 xxxxxx..
308 xxxxxx..
310 static unsigned short left_bracket_bits[] = {
311 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
313 /* First/last line bitmap. An right bracket. */
315 ..xxxxxx
316 ..xxxxxx
317 ......xx
318 ......xx
319 ......xx
320 ......xx
321 ......xx
322 ......xx
323 ..xxxxxx
324 ..xxxxxx
326 static unsigned short right_bracket_bits[] = {
327 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
329 /* Filled box cursor bitmap. A filled box; max 13 pixels high. */
331 xxxxxxx.
332 xxxxxxx.
333 xxxxxxx.
334 xxxxxxx.
335 xxxxxxx.
336 xxxxxxx.
337 xxxxxxx.
338 xxxxxxx.
339 xxxxxxx.
340 xxxxxxx.
341 xxxxxxx.
342 xxxxxxx.
343 xxxxxxx.
345 static unsigned short filled_rectangle_bits[] = {
346 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe};
348 /* Hollow box cursor bitmap. A hollow box; max 13 pixels high. */
350 xxxxxxx.
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 x.....x.
362 xxxxxxx.
364 static unsigned short hollow_rectangle_bits[] = {
365 0xfe, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0xfe};
367 /* Hollow square bitmap. */
369 .xxxxxx.
370 .x....x.
371 .x....x.
372 .x....x.
373 .x....x.
374 .xxxxxx.
376 static unsigned short hollow_square_bits[] = {
377 0x7e, 0x42, 0x42, 0x42, 0x42, 0x7e};
379 /* Filled square bitmap. */
381 .xxxxxx.
382 .xxxxxx.
383 .xxxxxx.
384 .xxxxxx.
385 .xxxxxx.
386 .xxxxxx.
388 static unsigned short filled_square_bits[] = {
389 0x7e, 0x7e, 0x7e, 0x7e, 0x7e, 0x7e};
391 /* Bar cursor bitmap. A vertical bar; max 13 pixels high. */
393 xx......
394 xx......
395 xx......
396 xx......
397 xx......
398 xx......
399 xx......
400 xx......
401 xx......
402 xx......
403 xx......
404 xx......
405 xx......
407 static unsigned short vertical_bar_bits[] = {
408 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0};
410 /* HBar cursor bitmap. A horizontal bar; 2 pixels high. */
412 xxxxxxx.
413 xxxxxxx.
415 static unsigned short horizontal_bar_bits[] = {
416 0xfe, 0xfe};
419 /* Bitmap drawn to indicate lines not displaying text if
420 `indicate-empty-lines' is non-nil. */
422 ........
423 ..xxxx..
424 ........
425 ........
426 ..xxxx..
427 ........
429 static unsigned short empty_line_bits[] = {
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,
437 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
440 #define BYTES_PER_BITMAP_ROW (sizeof (unsigned short))
441 #define STANDARD_BITMAP_HEIGHT(bits) (sizeof (bits)/BYTES_PER_BITMAP_ROW)
442 #define FRBITS(bits) bits, STANDARD_BITMAP_HEIGHT (bits)
444 /* NOTE: The order of these bitmaps must match the sequence
445 used in fringe.el to define the corresponding symbols. */
447 static struct fringe_bitmap standard_bitmaps[] =
449 { NULL, 0, 0, 0, 0, 0 }, /* NO_FRINGE_BITMAP */
450 { FRBITS (question_mark_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
451 { FRBITS (exclamation_mark_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
452 { FRBITS (left_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
453 { FRBITS (right_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
454 { FRBITS (up_arrow_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
455 { FRBITS (down_arrow_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
456 { FRBITS (left_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
457 { FRBITS (right_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
458 { FRBITS (left_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
459 { FRBITS (right_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
460 { FRBITS (top_left_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
461 { FRBITS (top_right_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
462 { FRBITS (bottom_left_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
463 { FRBITS (bottom_right_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
464 { FRBITS (left_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
465 { FRBITS (right_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
466 { FRBITS (filled_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
467 { FRBITS (hollow_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
468 { FRBITS (filled_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
469 { FRBITS (hollow_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
470 { FRBITS (vertical_bar_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
471 { FRBITS (horizontal_bar_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
472 { FRBITS (empty_line_bits), 8, 3, ALIGN_BITMAP_TOP, 0 },
475 #define NO_FRINGE_BITMAP 0
476 #define UNDEF_FRINGE_BITMAP 1
477 #define MAX_STANDARD_FRINGE_BITMAPS (sizeof (standard_bitmaps)/sizeof (standard_bitmaps[0]))
479 static struct fringe_bitmap **fringe_bitmaps;
480 static Lisp_Object *fringe_faces;
481 static int max_fringe_bitmaps;
483 #ifndef HAVE_NS
484 static
485 #endif
486 int max_used_fringe_bitmap = MAX_STANDARD_FRINGE_BITMAPS;
489 /* Lookup bitmap number for symbol BITMAP.
490 Return 0 if not a bitmap. */
493 lookup_fringe_bitmap (Lisp_Object bitmap)
495 EMACS_INT bn;
497 bitmap = Fget (bitmap, Qfringe);
498 if (!INTEGERP (bitmap))
499 return 0;
501 bn = XINT (bitmap);
502 if (bn > NO_FRINGE_BITMAP
503 && bn < max_used_fringe_bitmap
504 && (bn < MAX_STANDARD_FRINGE_BITMAPS
505 || fringe_bitmaps[bn] != NULL))
506 return bn;
508 return 0;
511 /* Get fringe bitmap name for bitmap number BN.
513 Found by traversing Vfringe_bitmaps comparing BN to the
514 fringe property for each symbol.
516 Return BN if not found in Vfringe_bitmaps. */
518 static Lisp_Object
519 get_fringe_bitmap_name (int bn)
521 Lisp_Object bitmaps;
522 Lisp_Object num;
524 /* Zero means no bitmap -- return nil. */
525 if (bn <= 0)
526 return Qnil;
528 bitmaps = Vfringe_bitmaps;
529 num = make_number (bn);
531 while (CONSP (bitmaps))
533 Lisp_Object bitmap = XCAR (bitmaps);
534 if (EQ (num, Fget (bitmap, Qfringe)))
535 return bitmap;
536 bitmaps = XCDR (bitmaps);
539 return num;
542 /* Get fringe bitmap data for bitmap number BN. */
544 static struct fringe_bitmap *
545 get_fringe_bitmap_data (int bn)
547 struct fringe_bitmap *fb;
549 fb = fringe_bitmaps[bn];
550 if (fb == NULL)
551 fb = &standard_bitmaps[bn < MAX_STANDARD_FRINGE_BITMAPS
552 ? bn : UNDEF_FRINGE_BITMAP];
554 return fb;
557 /* Draw the bitmap WHICH in one of the left or right fringes of
558 window W. ROW is the glyph row for which to display the bitmap; it
559 determines the vertical position at which the bitmap has to be
560 drawn.
561 LEFT_P is 1 for left fringe, 0 for right fringe.
564 static void
565 draw_fringe_bitmap_1 (struct window *w, struct glyph_row *row, int left_p, int overlay, int which)
567 struct frame *f = XFRAME (WINDOW_FRAME (w));
568 struct draw_fringe_bitmap_params p;
569 struct fringe_bitmap *fb;
570 int period;
571 int face_id = DEFAULT_FACE_ID;
572 int offset, header_line_height;
574 p.overlay_p = (overlay & 1) == 1;
575 p.cursor_p = (overlay & 2) == 2;
577 if (which != NO_FRINGE_BITMAP)
579 offset = 0;
581 else if (left_p)
583 which = row->left_fringe_bitmap;
584 face_id = row->left_fringe_face_id;
585 offset = row->left_fringe_offset;
587 else
589 which = row->right_fringe_bitmap;
590 face_id = row->right_fringe_face_id;
591 offset = row->right_fringe_offset;
594 if (face_id == DEFAULT_FACE_ID)
596 Lisp_Object face = fringe_faces[which];
597 face_id = NILP (face) ? lookup_named_face (f, Qfringe, 0)
598 : lookup_derived_face (f, face, FRINGE_FACE_ID, 0);
599 if (face_id < 0)
600 face_id = FRINGE_FACE_ID;
603 fb = get_fringe_bitmap_data (which);
605 period = fb->period;
607 /* Convert row to frame coordinates. */
608 p.y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y) + offset;
610 p.which = which;
611 p.bits = fb->bits;
612 p.wd = fb->width;
614 p.h = fb->height;
615 p.dh = (period > 0 ? (p.y % period) : 0);
616 p.h -= p.dh;
618 /* Adjust y to the offset in the row to start drawing the bitmap. */
619 switch (fb->align)
621 case ALIGN_BITMAP_CENTER:
622 p.y += (row->height - p.h) / 2;
623 break;
624 case ALIGN_BITMAP_BOTTOM:
625 p.y += (row->visible_height - p.h);
626 break;
627 case ALIGN_BITMAP_TOP:
628 break;
631 p.face = FACE_FROM_ID (f, face_id);
633 if (p.face == NULL)
635 /* This could happen after clearing face cache.
636 But it shouldn't happen anymore. ++kfs */
637 return;
640 PREPARE_FACE_FOR_DISPLAY (f, p.face);
642 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
643 the fringe. */
644 p.bx = -1;
645 header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
646 p.by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, row->y));
647 p.ny = row->visible_height;
648 if (left_p)
650 int wd = WINDOW_LEFT_FRINGE_WIDTH (w);
651 int x = window_box_left (w, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
652 ? LEFT_MARGIN_AREA
653 : TEXT_AREA));
654 if (p.wd > wd)
655 p.wd = wd;
656 p.x = x - p.wd - (wd - p.wd) / 2;
658 if (p.wd < wd || p.y > p.by || p.y + p.h < p.by + p.ny)
660 /* If W has a vertical border to its left, don't draw over it. */
661 wd -= ((!WINDOW_LEFTMOST_P (w)
662 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
663 ? 1 : 0);
664 p.bx = x - wd;
665 p.nx = wd;
668 else
670 int x = window_box_right (w,
671 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
672 ? RIGHT_MARGIN_AREA
673 : TEXT_AREA));
674 int wd = WINDOW_RIGHT_FRINGE_WIDTH (w);
675 if (p.wd > wd)
676 p.wd = wd;
677 p.x = x + (wd - p.wd) / 2;
678 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
679 the fringe. */
680 if (p.wd < wd || p.y > p.by || p.y + p.h < p.by + p.ny)
682 p.bx = x;
683 p.nx = wd;
687 FRAME_RIF (f)->draw_fringe_bitmap (w, row, &p);
690 static int
691 get_logical_cursor_bitmap (struct window *w, Lisp_Object cursor)
693 Lisp_Object cmap, bm = Qnil;
695 if ((cmap = BVAR (XBUFFER (w->buffer), fringe_cursor_alist)), !NILP (cmap))
697 bm = Fassq (cursor, cmap);
698 if (CONSP (bm))
700 if ((bm = XCDR (bm)), NILP (bm))
701 return NO_FRINGE_BITMAP;
702 return lookup_fringe_bitmap (bm);
705 if (EQ (cmap, BVAR (&buffer_defaults, fringe_cursor_alist)))
706 return NO_FRINGE_BITMAP;
707 bm = Fassq (cursor, BVAR (&buffer_defaults, fringe_cursor_alist));
708 if (!CONSP (bm) || ((bm = XCDR (bm)), NILP (bm)))
709 return NO_FRINGE_BITMAP;
710 return lookup_fringe_bitmap (bm);
713 static int
714 get_logical_fringe_bitmap (struct window *w, Lisp_Object bitmap, int right_p, int partial_p)
716 Lisp_Object cmap, bm1 = Qnil, bm2 = Qnil, bm;
717 EMACS_INT ln1 = 0, ln2 = 0;
718 int ix1 = right_p;
719 int ix2 = ix1 + (partial_p ? 2 : 0);
721 /* Lookup in buffer-local fringe-indicator-alist before global alist.
723 Elements are:
724 BITMAP -- use for all
725 (L R) -- use for left right (whether partial or not)
726 (L R PL PR) -- use for left right partial-left partial-right
727 If any value in local binding is not present or t, use global value.
729 If partial, lookup partial bitmap in default value if not found here.
730 If not partial, or no partial spec is present, use non-partial bitmap. */
732 if ((cmap = BVAR (XBUFFER (w->buffer), fringe_indicator_alist)), !NILP (cmap))
734 bm1 = Fassq (bitmap, cmap);
735 if (CONSP (bm1))
737 if ((bm1 = XCDR (bm1)), NILP (bm1))
738 return NO_FRINGE_BITMAP;
739 if (CONSP (bm1))
741 ln1 = XINT (Flength (bm1));
742 if (partial_p)
744 if (ln1 > ix2)
746 bm = Fnth (make_number (ix2), bm1);
747 if (!EQ (bm, Qt))
748 goto found;
751 else
753 if (ln1 > ix1)
755 bm = Fnth (make_number (ix1), bm1);
756 if (!EQ (bm, Qt))
757 goto found;
761 else if ((bm = bm1, !EQ (bm, Qt)))
762 goto found;
766 if (!EQ (cmap, BVAR (&buffer_defaults, fringe_indicator_alist))
767 && !NILP (BVAR (&buffer_defaults, fringe_indicator_alist)))
769 bm2 = Fassq (bitmap, BVAR (&buffer_defaults, fringe_indicator_alist));
770 if (CONSP (bm2))
772 if ((bm2 = XCDR (bm2)), !NILP (bm2))
774 if (CONSP (bm2))
776 ln2 = XINT (Flength (bm2));
777 if (partial_p)
779 if (ln2 > ix2)
781 bm = Fnth (make_number (ix2), bm2);
782 if (!EQ (bm, Qt))
783 goto found;
791 if (ln1 > ix1)
793 bm = Fnth (make_number (ix1), bm1);
794 if (!EQ (bm, Qt))
795 goto found;
798 if (ln2 > ix1)
800 bm = Fnth (make_number (ix1), bm2);
801 if (!EQ (bm, Qt))
802 goto found;
803 return NO_FRINGE_BITMAP;
805 else if ((bm = bm2, NILP (bm)))
806 return NO_FRINGE_BITMAP;
808 found:
809 return lookup_fringe_bitmap (bm);
813 void
814 draw_fringe_bitmap (struct window *w, struct glyph_row *row, int left_p)
816 int overlay = 0;
818 if (left_p == row->reversed_p && row->cursor_in_fringe_p)
820 Lisp_Object cursor = Qnil;
822 switch (w->phys_cursor_type)
824 case HOLLOW_BOX_CURSOR:
825 if (row->visible_height >= STANDARD_BITMAP_HEIGHT (hollow_rectangle_bits))
826 cursor = Qhollow;
827 else
828 cursor = Qhollow_small;
829 break;
830 case FILLED_BOX_CURSOR:
831 cursor = Qbox;
832 break;
833 case BAR_CURSOR:
834 cursor = Qbar;
835 break;
836 case HBAR_CURSOR:
837 cursor = Qhbar;
838 break;
839 case NO_CURSOR:
840 default:
841 w->phys_cursor_on_p = 0;
842 row->cursor_in_fringe_p = 0;
843 break;
845 if (!NILP (cursor))
847 int bm = get_logical_cursor_bitmap (w, cursor);
848 if (bm != NO_FRINGE_BITMAP)
850 draw_fringe_bitmap_1 (w, row, left_p, 2, bm);
851 overlay = EQ (cursor, Qbox) ? 3 : 1;
856 draw_fringe_bitmap_1 (w, row, left_p, overlay, NO_FRINGE_BITMAP);
858 if (left_p && row->overlay_arrow_bitmap != NO_FRINGE_BITMAP)
859 draw_fringe_bitmap_1 (w, row, 1, 1, row->overlay_arrow_bitmap);
863 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
864 function with input blocked. */
866 void
867 draw_row_fringe_bitmaps (struct window *w, struct glyph_row *row)
869 eassert (interrupt_input_blocked);
871 /* If row is completely invisible, because of vscrolling, we
872 don't have to draw anything. */
873 if (row->visible_height <= 0)
874 return;
876 if (WINDOW_LEFT_FRINGE_WIDTH (w) != 0)
877 draw_fringe_bitmap (w, row, 1);
879 if (WINDOW_RIGHT_FRINGE_WIDTH (w) != 0)
880 draw_fringe_bitmap (w, row, 0);
883 /* Draw the fringes of window W. Only fringes for rows marked for
884 update in redraw_fringe_bitmaps_p are drawn.
886 Return >0 if left or right fringe was redrawn in any way.
888 If NO_FRINGE is non-zero, also return >0 if either fringe has zero width.
890 A return value >0 indicates that the vertical line between windows
891 needs update (as it may be drawn in the fringe).
895 draw_window_fringes (struct window *w, int no_fringe)
897 struct glyph_row *row;
898 int yb = window_text_bottom_y (w);
899 int nrows = w->current_matrix->nrows;
900 int y, rn;
901 int updated = 0;
903 if (w->pseudo_window_p)
904 return 0;
906 /* Must draw line if no fringe */
907 if (no_fringe
908 && (WINDOW_LEFT_FRINGE_WIDTH (w) == 0
909 || WINDOW_RIGHT_FRINGE_WIDTH (w) == 0))
910 updated++;
912 for (y = w->vscroll, rn = 0, row = w->current_matrix->rows;
913 y < yb && rn < nrows;
914 y += row->height, ++row, ++rn)
916 if (!row->redraw_fringe_bitmaps_p)
917 continue;
918 draw_row_fringe_bitmaps (w, row);
919 row->redraw_fringe_bitmaps_p = 0;
920 updated++;
923 return updated;
927 /* Recalculate the bitmaps to show in the fringes of window W.
928 Only mark rows with modified bitmaps for update in redraw_fringe_bitmaps_p.
930 If KEEP_CURRENT_P is 0, update current_matrix too. */
933 update_window_fringes (struct window *w, int keep_current_p)
935 struct glyph_row *row, *cur = 0;
936 int yb = window_text_bottom_y (w);
937 int rn, nrows = w->current_matrix->nrows;
938 int y;
939 int redraw_p = 0;
940 Lisp_Object boundary_top = Qnil, boundary_bot = Qnil;
941 Lisp_Object arrow_top = Qnil, arrow_bot = Qnil;
942 Lisp_Object empty_pos;
943 Lisp_Object ind = Qnil;
944 #define MAX_BITMAP_CACHE (8*4)
945 int bitmap_cache[MAX_BITMAP_CACHE];
946 int top_ind_rn, bot_ind_rn;
947 int top_ind_min_y, bot_ind_max_y;
949 /* top_ind_rn is set to a nonnegative value whenever
950 row->indicate_bob_p is set, so it's OK that top_row_ends_at_zv_p
951 is not initialized here. Similarly for bot_ind_rn,
952 row->indicate_eob_p and bot_row_ends_at_zv_p. */
953 int top_row_ends_at_zv_p IF_LINT (= 0), bot_row_ends_at_zv_p IF_LINT (= 0);
955 if (w->pseudo_window_p)
956 return 0;
958 if (!MINI_WINDOW_P (w)
959 && (ind = BVAR (XBUFFER (w->buffer), indicate_buffer_boundaries), !NILP (ind)))
961 if (EQ (ind, Qleft) || EQ (ind, Qright))
962 boundary_top = boundary_bot = arrow_top = arrow_bot = ind;
963 else if (CONSP (ind) && CONSP (XCAR (ind)))
965 Lisp_Object pos;
966 if (pos = Fassq (Qt, ind), !NILP (pos))
967 boundary_top = boundary_bot = arrow_top = arrow_bot = XCDR (pos);
968 if (pos = Fassq (Qtop, ind), !NILP (pos))
969 boundary_top = XCDR (pos);
970 if (pos = Fassq (Qbottom, ind), !NILP (pos))
971 boundary_bot = XCDR (pos);
972 if (pos = Fassq (Qup, ind), !NILP (pos))
973 arrow_top = XCDR (pos);
974 if (pos = Fassq (Qdown, ind), !NILP (pos))
975 arrow_bot = XCDR (pos);
977 else
978 /* Anything else means boundary on left and no arrows. */
979 boundary_top = boundary_bot = Qleft;
982 top_ind_rn = bot_ind_rn = -1;
983 if (!NILP (ind))
985 for (y = w->vscroll, rn = 0;
986 y < yb && rn < nrows;
987 y += row->height, ++rn)
989 row = w->desired_matrix->rows + rn;
990 if (!row->enabled_p)
991 row = w->current_matrix->rows + rn;
993 row->indicate_bob_p = row->indicate_top_line_p = 0;
994 row->indicate_eob_p = row->indicate_bottom_line_p = 0;
996 if (!row->mode_line_p)
998 if (top_ind_rn < 0 && row->visible_height > 0)
1000 if (MATRIX_ROW_START_CHARPOS (row) <= BUF_BEGV (XBUFFER (w->buffer))
1001 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w, row))
1002 row->indicate_bob_p = !NILP (boundary_top);
1003 else
1004 row->indicate_top_line_p = !NILP (arrow_top);
1005 top_ind_rn = rn;
1008 if (bot_ind_rn < 0)
1010 if (MATRIX_ROW_END_CHARPOS (row) >= BUF_ZV (XBUFFER (w->buffer))
1011 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row))
1012 row->indicate_eob_p = !NILP (boundary_bot), bot_ind_rn = rn;
1013 else if (y + row->height >= yb)
1014 row->indicate_bottom_line_p = !NILP (arrow_bot), bot_ind_rn = rn;
1020 empty_pos = BVAR (XBUFFER (w->buffer), indicate_empty_lines);
1021 if (!NILP (empty_pos) && !EQ (empty_pos, Qright))
1022 empty_pos = WINDOW_LEFT_FRINGE_WIDTH (w) == 0 ? Qright : Qleft;
1024 for (y = 0; y < MAX_BITMAP_CACHE; y++)
1025 bitmap_cache[y] = -1;
1027 #define LEFT_FRINGE(cache, which, partial_p) \
1028 (bitmap_cache[cache*4+partial_p] >= 0 \
1029 ? bitmap_cache[cache*4+partial_p] \
1030 : (bitmap_cache[cache*4+partial_p] = \
1031 get_logical_fringe_bitmap (w, which, 0, partial_p)))
1033 #define RIGHT_FRINGE(cache, which, partial_p) \
1034 (bitmap_cache[cache*4+2+partial_p] >= 0 \
1035 ? bitmap_cache[cache*4+2+partial_p] \
1036 : (bitmap_cache[cache*4+2+partial_p] = \
1037 get_logical_fringe_bitmap (w, which, 1, partial_p)))
1040 /* Extend top-aligned top indicator (or bottom-aligned bottom
1041 indicator) to adjacent rows if it doesn't fit in one row. */
1042 top_ind_min_y = bot_ind_max_y = -1;
1043 if (top_ind_rn >= 0)
1045 int bn = NO_FRINGE_BITMAP;
1047 row = w->desired_matrix->rows + top_ind_rn;
1048 if (!row->enabled_p)
1049 row = w->current_matrix->rows + top_ind_rn;
1051 top_row_ends_at_zv_p = row->ends_at_zv_p;
1052 if (row->indicate_bob_p)
1054 if (EQ (boundary_top, Qleft))
1055 bn = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1056 ? LEFT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1057 : LEFT_FRINGE (2, Qtop, 0));
1058 else
1059 bn = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1060 ? RIGHT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1061 : RIGHT_FRINGE (2, Qtop, 0));
1063 else if (row->indicate_top_line_p)
1065 if (EQ (arrow_top, Qleft))
1066 bn = LEFT_FRINGE (6, Qup, 0);
1067 else
1068 bn = RIGHT_FRINGE (6, Qup, 0);
1071 if (bn != NO_FRINGE_BITMAP)
1073 struct fringe_bitmap *fb = get_fringe_bitmap_data (bn);
1075 if (fb->align == ALIGN_BITMAP_TOP && fb->period == 0)
1077 struct glyph_row *row1;
1078 int top_ind_max_y;
1080 top_ind_min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1081 top_ind_max_y = top_ind_min_y + fb->height;
1082 if (top_ind_max_y > yb)
1083 top_ind_max_y = yb;
1085 for (y = row->y + row->height, rn = top_ind_rn + 1;
1086 y < top_ind_max_y && rn < nrows;
1087 y += row1->height, rn++)
1089 if (bot_ind_rn >= 0 && rn >= bot_ind_rn)
1090 break;
1092 row1 = w->desired_matrix->rows + rn;
1093 if (!row1->enabled_p)
1094 row1 = w->current_matrix->rows + rn;
1096 row1->indicate_bob_p = row->indicate_bob_p;
1097 row1->indicate_top_line_p = row->indicate_top_line_p;
1102 if (bot_ind_rn >= 0)
1104 int bn = NO_FRINGE_BITMAP;
1106 row = w->desired_matrix->rows + bot_ind_rn;
1107 if (!row->enabled_p)
1108 row = w->current_matrix->rows + bot_ind_rn;
1110 bot_row_ends_at_zv_p = row->ends_at_zv_p;
1111 if (row->indicate_eob_p)
1113 if (EQ (boundary_bot, Qleft))
1114 bn = LEFT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1115 else
1116 bn = RIGHT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1118 else if (row->indicate_bottom_line_p)
1120 if (EQ (arrow_bot, Qleft))
1121 bn = LEFT_FRINGE (7, Qdown, 0);
1122 else
1123 bn = RIGHT_FRINGE (7, Qdown, 0);
1126 if (bn != NO_FRINGE_BITMAP)
1128 struct fringe_bitmap *fb = get_fringe_bitmap_data (bn);
1130 if (fb->align == ALIGN_BITMAP_BOTTOM && fb->period == 0)
1132 struct glyph_row *row1;
1133 int bot_ind_min_y;
1135 bot_ind_max_y = row->y + row->visible_height;
1136 bot_ind_min_y = bot_ind_max_y - fb->height;
1137 if (bot_ind_min_y < WINDOW_HEADER_LINE_HEIGHT (w))
1138 bot_ind_min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1140 for (y = row->y, rn = bot_ind_rn - 1;
1141 y >= bot_ind_min_y && rn >= 0;
1142 y -= row1->height, rn--)
1144 if (top_ind_rn >= 0 && rn <= top_ind_rn)
1145 break;
1147 row1 = w->desired_matrix->rows + rn;
1148 if (!row1->enabled_p)
1149 row1 = w->current_matrix->rows + rn;
1151 row1->indicate_eob_p = row->indicate_eob_p;
1152 row1->indicate_bottom_line_p = row->indicate_bottom_line_p;
1158 for (y = w->vscroll, rn = 0;
1159 y < yb && rn < nrows;
1160 y += row->height, rn++)
1162 int left, right;
1163 unsigned left_face_id, right_face_id;
1164 int left_offset, right_offset;
1165 int periodic_p;
1167 row = w->desired_matrix->rows + rn;
1168 cur = w->current_matrix->rows + rn;
1169 if (!row->enabled_p)
1170 row = cur;
1172 left_face_id = right_face_id = DEFAULT_FACE_ID;
1173 left_offset = right_offset = 0;
1174 periodic_p = 0;
1176 /* Decide which bitmap to draw in the left fringe. */
1177 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
1178 left = NO_FRINGE_BITMAP;
1179 else if (row->left_user_fringe_bitmap != NO_FRINGE_BITMAP)
1181 left = row->left_user_fringe_bitmap;
1182 left_face_id = row->left_user_fringe_face_id;
1184 else if ((!row->reversed_p && row->truncated_on_left_p)
1185 || (row->reversed_p && row->truncated_on_right_p))
1186 left = LEFT_FRINGE (0, Qtruncation, 0);
1187 else if (row->indicate_bob_p && EQ (boundary_top, Qleft))
1189 left = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1190 ? LEFT_FRINGE (1, Qtop_bottom, top_row_ends_at_zv_p)
1191 : LEFT_FRINGE (2, Qtop, 0));
1192 if (top_ind_min_y >= 0)
1193 left_offset = top_ind_min_y - row->y;
1195 else if (row->indicate_eob_p && EQ (boundary_bot, Qleft))
1197 left = LEFT_FRINGE (3, Qbottom, bot_row_ends_at_zv_p);
1198 if (bot_ind_max_y >= 0)
1199 left_offset = bot_ind_max_y - (row->y + row->visible_height);
1201 else if ((!row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row))
1202 || (row->reversed_p && row->continued_p))
1203 left = LEFT_FRINGE (4, Qcontinuation, 0);
1204 else if (row->indicate_empty_line_p && EQ (empty_pos, Qleft))
1205 left = LEFT_FRINGE (5, Qempty_line, 0);
1206 else if (row->indicate_top_line_p && EQ (arrow_top, Qleft))
1208 left = LEFT_FRINGE (6, Qup, 0);
1209 if (top_ind_min_y >= 0)
1210 left_offset = top_ind_min_y - row->y;
1212 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qleft))
1214 left = LEFT_FRINGE (7, Qdown, 0);
1215 if (bot_ind_max_y >= 0)
1216 left_offset = bot_ind_max_y - (row->y + row->visible_height);
1218 else
1219 left = NO_FRINGE_BITMAP;
1221 /* Decide which bitmap to draw in the right fringe. */
1222 if (WINDOW_RIGHT_FRINGE_WIDTH (w) == 0)
1223 right = NO_FRINGE_BITMAP;
1224 else if (row->right_user_fringe_bitmap != NO_FRINGE_BITMAP)
1226 right = row->right_user_fringe_bitmap;
1227 right_face_id = row->right_user_fringe_face_id;
1229 else if ((!row->reversed_p && row->truncated_on_right_p)
1230 || (row->reversed_p && row->truncated_on_left_p))
1231 right = RIGHT_FRINGE (0, Qtruncation, 0);
1232 else if (row->indicate_bob_p && EQ (boundary_top, Qright))
1234 right = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1235 ? RIGHT_FRINGE (1, Qtop_bottom, top_row_ends_at_zv_p)
1236 : RIGHT_FRINGE (2, Qtop, 0));
1237 if (top_ind_min_y >= 0)
1238 right_offset = top_ind_min_y - row->y;
1240 else if (row->indicate_eob_p && EQ (boundary_bot, Qright))
1242 right = RIGHT_FRINGE (3, Qbottom, bot_row_ends_at_zv_p);
1243 if (bot_ind_max_y >= 0)
1244 right_offset = bot_ind_max_y - (row->y + row->visible_height);
1246 else if ((!row->reversed_p && row->continued_p)
1247 || (row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row)))
1248 right = RIGHT_FRINGE (4, Qcontinuation, 0);
1249 else if (row->indicate_top_line_p && EQ (arrow_top, Qright))
1251 right = RIGHT_FRINGE (6, Qup, 0);
1252 if (top_ind_min_y >= 0)
1253 right_offset = top_ind_min_y - row->y;
1255 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qright))
1257 right = RIGHT_FRINGE (7, Qdown, 0);
1258 if (bot_ind_max_y >= 0)
1259 right_offset = bot_ind_max_y - (row->y + row->visible_height);
1261 else if (row->indicate_empty_line_p && EQ (empty_pos, Qright))
1262 right = RIGHT_FRINGE (5, Qempty_line, 0);
1263 else
1264 right = NO_FRINGE_BITMAP;
1266 periodic_p = (get_fringe_bitmap_data (left)->period != 0
1267 || get_fringe_bitmap_data (right)->period != 0);
1269 if (row->y != cur->y
1270 || row->visible_height != cur->visible_height
1271 || row->ends_at_zv_p != cur->ends_at_zv_p
1272 || left != cur->left_fringe_bitmap
1273 || right != cur->right_fringe_bitmap
1274 || left_face_id != cur->left_fringe_face_id
1275 || right_face_id != cur->right_fringe_face_id
1276 || left_offset != cur->left_fringe_offset
1277 || right_offset != cur->right_fringe_offset
1278 || periodic_p != cur->fringe_bitmap_periodic_p
1279 || cur->redraw_fringe_bitmaps_p)
1281 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1282 if (!keep_current_p)
1284 cur->redraw_fringe_bitmaps_p = 1;
1285 cur->left_fringe_bitmap = left;
1286 cur->right_fringe_bitmap = right;
1287 cur->left_fringe_face_id = left_face_id;
1288 cur->right_fringe_face_id = right_face_id;
1289 cur->left_fringe_offset = left_offset;
1290 cur->right_fringe_offset = right_offset;
1291 cur->fringe_bitmap_periodic_p = periodic_p;
1295 if (row->overlay_arrow_bitmap < 0)
1296 row->overlay_arrow_bitmap = get_logical_fringe_bitmap (w, Qoverlay_arrow, 0, 0);
1298 if (row->overlay_arrow_bitmap != cur->overlay_arrow_bitmap)
1300 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1301 if (!keep_current_p)
1303 cur->redraw_fringe_bitmaps_p = 1;
1304 cur->overlay_arrow_bitmap = row->overlay_arrow_bitmap;
1308 row->left_fringe_bitmap = left;
1309 row->right_fringe_bitmap = right;
1310 row->left_fringe_face_id = left_face_id;
1311 row->right_fringe_face_id = right_face_id;
1312 row->left_fringe_offset = left_offset;
1313 row->right_fringe_offset = right_offset;
1314 row->fringe_bitmap_periodic_p = periodic_p;
1317 return redraw_p && !keep_current_p;
1321 /* Compute actual fringe widths for frame F.
1323 If REDRAW is 1, redraw F if the fringe settings was actually
1324 modified and F is visible.
1326 Since the combined left and right fringe must occupy an integral
1327 number of columns, we may need to add some pixels to each fringe.
1328 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
1329 but a negative width value is taken literally (after negating it).
1331 We never make the fringes narrower than specified.
1334 void
1335 compute_fringe_widths (struct frame *f, int redraw)
1337 int o_left = FRAME_LEFT_FRINGE_WIDTH (f);
1338 int o_right = FRAME_RIGHT_FRINGE_WIDTH (f);
1339 int o_cols = FRAME_FRINGE_COLS (f);
1341 Lisp_Object left_fringe = Fassq (Qleft_fringe, f->param_alist);
1342 Lisp_Object right_fringe = Fassq (Qright_fringe, f->param_alist);
1343 int left_fringe_width, right_fringe_width;
1345 if (!NILP (left_fringe))
1346 left_fringe = Fcdr (left_fringe);
1347 if (!NILP (right_fringe))
1348 right_fringe = Fcdr (right_fringe);
1350 left_fringe_width = ((NILP (left_fringe) || !INTEGERP (left_fringe)) ? 8 :
1351 XINT (left_fringe));
1352 right_fringe_width = ((NILP (right_fringe) || !INTEGERP (right_fringe)) ? 8 :
1353 XINT (right_fringe));
1355 if (left_fringe_width || right_fringe_width)
1357 int left_wid = left_fringe_width >= 0 ? left_fringe_width : -left_fringe_width;
1358 int right_wid = right_fringe_width >= 0 ? right_fringe_width : -right_fringe_width;
1359 int conf_wid = left_wid + right_wid;
1360 int font_wid = FRAME_COLUMN_WIDTH (f);
1361 int cols = (left_wid + right_wid + font_wid-1) / font_wid;
1362 int real_wid = cols * font_wid;
1363 if (left_wid && right_wid)
1365 if (left_fringe_width < 0)
1367 /* Left fringe width is fixed, adjust right fringe if necessary */
1368 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid;
1369 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid - left_wid;
1371 else if (right_fringe_width < 0)
1373 /* Right fringe width is fixed, adjust left fringe if necessary */
1374 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid - right_wid;
1375 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid;
1377 else
1379 /* Adjust both fringes with an equal amount.
1380 Note that we are doing integer arithmetic here, so don't
1381 lose a pixel if the total width is an odd number. */
1382 int fill = real_wid - conf_wid;
1383 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid + fill/2;
1384 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid + fill - fill/2;
1387 else if (left_fringe_width)
1389 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid;
1390 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1392 else
1394 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1395 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid;
1397 FRAME_FRINGE_COLS (f) = cols;
1399 else
1401 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1402 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1403 FRAME_FRINGE_COLS (f) = 0;
1406 if (redraw && FRAME_VISIBLE_P (f))
1407 if (o_left != FRAME_LEFT_FRINGE_WIDTH (f) ||
1408 o_right != FRAME_RIGHT_FRINGE_WIDTH (f) ||
1409 o_cols != FRAME_FRINGE_COLS (f))
1410 redraw_frame (f);
1414 /* Free resources used by a user-defined bitmap. */
1416 static void
1417 destroy_fringe_bitmap (int n)
1419 struct fringe_bitmap **fbp;
1421 fringe_faces[n] = Qnil;
1423 fbp = &fringe_bitmaps[n];
1424 if (*fbp && (*fbp)->dynamic)
1426 /* XXX Is SELECTED_FRAME OK here? */
1427 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1428 if (rif && rif->destroy_fringe_bitmap)
1429 rif->destroy_fringe_bitmap (n);
1430 xfree (*fbp);
1431 *fbp = NULL;
1434 while (max_used_fringe_bitmap > MAX_STANDARD_FRINGE_BITMAPS
1435 && fringe_bitmaps[max_used_fringe_bitmap - 1] == NULL)
1436 max_used_fringe_bitmap--;
1440 DEFUN ("destroy-fringe-bitmap", Fdestroy_fringe_bitmap, Sdestroy_fringe_bitmap,
1441 1, 1, 0,
1442 doc: /* Destroy fringe bitmap BITMAP.
1443 If BITMAP overrides a standard fringe bitmap, the original bitmap is restored. */)
1444 (Lisp_Object bitmap)
1446 int n;
1448 CHECK_SYMBOL (bitmap);
1449 n = lookup_fringe_bitmap (bitmap);
1450 if (!n)
1451 return Qnil;
1453 destroy_fringe_bitmap (n);
1455 if (n >= MAX_STANDARD_FRINGE_BITMAPS)
1457 Vfringe_bitmaps = Fdelq (bitmap, Vfringe_bitmaps);
1458 /* It would be better to remove the fringe property. */
1459 Fput (bitmap, Qfringe, Qnil);
1462 return Qnil;
1466 /* Initialize bitmap bit.
1468 On X, we bit-swap the built-in bitmaps and reduce bitmap
1469 from short to char array if width is <= 8 bits.
1471 On MAC with big-endian CPU, we need to byte-swap each short.
1473 On W32 and MAC (little endian), there's no need to do this.
1476 #if defined (HAVE_X_WINDOWS)
1477 static const unsigned char swap_nibble[16] = {
1478 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
1479 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
1480 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
1481 0x3, 0xb, 0x7, 0xf}; /* 0011 1011 0111 1111 */
1482 #endif /* HAVE_X_WINDOWS */
1484 static void
1485 init_fringe_bitmap (int which, struct fringe_bitmap *fb, int once_p)
1487 if (once_p || fb->dynamic)
1489 #if defined (HAVE_X_WINDOWS)
1490 unsigned short *bits = fb->bits;
1491 int j;
1493 if (fb->width <= 8)
1495 unsigned char *cbits = (unsigned char *)fb->bits;
1496 for (j = 0; j < fb->height; j++)
1498 unsigned short b = *bits++;
1499 unsigned char c;
1500 c = (unsigned char)((swap_nibble[b & 0xf] << 4)
1501 | (swap_nibble[(b>>4) & 0xf]));
1502 *cbits++ = (c >> (8 - fb->width));
1505 else
1507 for (j = 0; j < fb->height; j++)
1509 unsigned short b = *bits;
1510 b = (unsigned short)((swap_nibble[b & 0xf] << 12)
1511 | (swap_nibble[(b>>4) & 0xf] << 8)
1512 | (swap_nibble[(b>>8) & 0xf] << 4)
1513 | (swap_nibble[(b>>12) & 0xf]));
1514 b >>= (16 - fb->width);
1515 #ifdef WORDS_BIGENDIAN
1516 b = ((b >> 8) | (b << 8));
1517 #endif
1518 *bits++ = b;
1521 #endif /* HAVE_X_WINDOWS */
1525 if (!once_p)
1527 /* XXX Is SELECTED_FRAME OK here? */
1528 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1530 destroy_fringe_bitmap (which);
1532 if (rif && rif->define_fringe_bitmap)
1533 rif->define_fringe_bitmap (which, fb->bits, fb->height, fb->width);
1535 fringe_bitmaps[which] = fb;
1536 if (which >= max_used_fringe_bitmap)
1537 max_used_fringe_bitmap = which + 1;
1542 DEFUN ("define-fringe-bitmap", Fdefine_fringe_bitmap, Sdefine_fringe_bitmap,
1543 2, 5, 0,
1544 doc: /* Define fringe bitmap BITMAP from BITS of size HEIGHT x WIDTH.
1545 BITMAP is a symbol identifying the new fringe bitmap.
1546 BITS is either a string or a vector of integers.
1547 HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
1548 WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
1549 Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
1550 indicating the positioning of the bitmap relative to the rows where it
1551 is used; the default is to center the bitmap. Fifth arg may also be a
1552 list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap
1553 should be repeated.
1554 If BITMAP already exists, the existing definition is replaced. */)
1555 (Lisp_Object bitmap, Lisp_Object bits, Lisp_Object height, Lisp_Object width, Lisp_Object align)
1557 int n, h, i, j;
1558 unsigned short *b;
1559 struct fringe_bitmap fb, *xfb;
1560 int fill1 = 0, fill2 = 0;
1562 CHECK_SYMBOL (bitmap);
1564 if (STRINGP (bits))
1565 h = SCHARS (bits);
1566 else if (VECTORP (bits))
1567 h = ASIZE (bits);
1568 else
1569 wrong_type_argument (Qsequencep, bits);
1571 if (NILP (height))
1572 fb.height = h;
1573 else
1575 CHECK_NUMBER (height);
1576 fb.height = max (0, min (XINT (height), 255));
1577 if (fb.height > h)
1579 fill1 = (fb.height - h) / 2;
1580 fill2 = fb.height - h - fill1;
1584 if (NILP (width))
1585 fb.width = 8;
1586 else
1588 CHECK_NUMBER (width);
1589 fb.width = max (0, min (XINT (width), 255));
1592 fb.period = 0;
1593 fb.align = ALIGN_BITMAP_CENTER;
1595 if (CONSP (align))
1597 Lisp_Object period = XCDR (align);
1598 if (CONSP (period))
1600 period = XCAR (period);
1601 if (!NILP (period))
1603 fb.period = fb.height;
1604 fb.height = 255;
1607 align = XCAR (align);
1609 if (EQ (align, Qtop))
1610 fb.align = ALIGN_BITMAP_TOP;
1611 else if (EQ (align, Qbottom))
1612 fb.align = ALIGN_BITMAP_BOTTOM;
1613 else if (!NILP (align) && !EQ (align, Qcenter))
1614 error ("Bad align argument");
1616 n = lookup_fringe_bitmap (bitmap);
1617 if (!n)
1619 if (max_used_fringe_bitmap < max_fringe_bitmaps)
1620 n = max_used_fringe_bitmap++;
1621 else
1623 for (n = MAX_STANDARD_FRINGE_BITMAPS;
1624 n < max_fringe_bitmaps;
1625 n++)
1626 if (fringe_bitmaps[n] == NULL)
1627 break;
1629 if (n == max_fringe_bitmaps)
1631 int bitmaps = max_fringe_bitmaps + 20;
1632 if (MAX_FRINGE_BITMAPS < bitmaps)
1633 error ("No free fringe bitmap slots");
1635 i = max_fringe_bitmaps;
1636 fringe_bitmaps = xrealloc (fringe_bitmaps,
1637 bitmaps * sizeof *fringe_bitmaps);
1638 fringe_faces = xrealloc (fringe_faces,
1639 bitmaps * sizeof *fringe_faces);
1641 for (i = max_fringe_bitmaps; i < bitmaps; i++)
1643 fringe_bitmaps[i] = NULL;
1644 fringe_faces[i] = Qnil;
1647 max_fringe_bitmaps = bitmaps;
1651 Vfringe_bitmaps = Fcons (bitmap, Vfringe_bitmaps);
1652 Fput (bitmap, Qfringe, make_number (n));
1655 fb.dynamic = 1;
1657 xfb = xmalloc (sizeof fb + fb.height * BYTES_PER_BITMAP_ROW);
1658 fb.bits = b = (unsigned short *) (xfb + 1);
1659 memset (b, 0, fb.height);
1661 j = 0;
1662 while (j < fb.height)
1664 for (i = 0; i < fill1 && j < fb.height; i++)
1665 b[j++] = 0;
1666 for (i = 0; i < h && j < fb.height; i++)
1668 Lisp_Object elt = Faref (bits, make_number (i));
1669 b[j++] = NUMBERP (elt) ? XINT (elt) : 0;
1671 for (i = 0; i < fill2 && j < fb.height; i++)
1672 b[j++] = 0;
1675 *xfb = fb;
1677 init_fringe_bitmap (n, xfb, 0);
1679 return bitmap;
1682 DEFUN ("set-fringe-bitmap-face", Fset_fringe_bitmap_face, Sset_fringe_bitmap_face,
1683 1, 2, 0,
1684 doc: /* Set face for fringe bitmap BITMAP to FACE.
1685 If FACE is nil, reset face to default fringe face. */)
1686 (Lisp_Object bitmap, Lisp_Object face)
1688 int n;
1690 CHECK_SYMBOL (bitmap);
1691 n = lookup_fringe_bitmap (bitmap);
1692 if (!n)
1693 error ("Undefined fringe bitmap");
1695 /* The purpose of the following code is to signal an error if FACE
1696 is not a face. This is for the caller's convenience only; the
1697 redisplay code should be able to fail gracefully. Skip the check
1698 if FRINGE_FACE_ID is unrealized (as in batch mode and during
1699 daemon startup). */
1700 if (!NILP (face))
1702 struct frame *f = SELECTED_FRAME ();
1704 if (FACE_FROM_ID (f, FRINGE_FACE_ID)
1705 && lookup_derived_face (f, face, FRINGE_FACE_ID, 1) < 0)
1706 error ("No such face");
1709 fringe_faces[n] = face;
1710 return Qnil;
1713 DEFUN ("fringe-bitmaps-at-pos", Ffringe_bitmaps_at_pos, Sfringe_bitmaps_at_pos,
1714 0, 2, 0,
1715 doc: /* Return fringe bitmaps of row containing position POS in window WINDOW.
1716 If WINDOW is nil, use selected window. If POS is nil, use value of point
1717 in that window. Return value is a list (LEFT RIGHT OV), where LEFT
1718 is the symbol for the bitmap in the left fringe (or nil if no bitmap),
1719 RIGHT is similar for the right fringe, and OV is non-nil if there is an
1720 overlay arrow in the left fringe.
1721 Return nil if POS is not visible in WINDOW. */)
1722 (Lisp_Object pos, Lisp_Object window)
1724 struct window *w;
1725 struct glyph_row *row;
1726 ptrdiff_t textpos;
1728 if (NILP (window))
1729 window = selected_window;
1730 CHECK_WINDOW (window);
1731 w = XWINDOW (window);
1733 if (!NILP (pos))
1735 CHECK_NUMBER_COERCE_MARKER (pos);
1736 if (! (BEGV <= XINT (pos) && XINT (pos) <= ZV))
1737 args_out_of_range (window, pos);
1738 textpos = XINT (pos);
1740 else if (w == XWINDOW (selected_window))
1741 textpos = PT;
1742 else
1743 textpos = XMARKER (w->pointm)->charpos;
1745 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1746 row = row_containing_pos (w, textpos, row, NULL, 0);
1747 if (row)
1748 return list3 (get_fringe_bitmap_name (row->left_fringe_bitmap),
1749 get_fringe_bitmap_name (row->right_fringe_bitmap),
1750 (row->overlay_arrow_bitmap == 0 ? Qnil
1751 : row->overlay_arrow_bitmap < 0 ? Qt
1752 : get_fringe_bitmap_name (row->overlay_arrow_bitmap)));
1753 else
1754 return Qnil;
1758 /***********************************************************************
1759 Initialization
1760 ***********************************************************************/
1762 void
1763 syms_of_fringe (void)
1765 DEFSYM (Qtruncation, "truncation");
1766 DEFSYM (Qcontinuation, "continuation");
1767 DEFSYM (Qoverlay_arrow, "overlay-arrow");
1768 DEFSYM (Qempty_line, "empty-line");
1769 DEFSYM (Qtop_bottom, "top-bottom");
1770 DEFSYM (Qhollow_small, "hollow-small");
1772 defsubr (&Sdestroy_fringe_bitmap);
1773 defsubr (&Sdefine_fringe_bitmap);
1774 defsubr (&Sfringe_bitmaps_at_pos);
1775 defsubr (&Sset_fringe_bitmap_face);
1777 DEFVAR_LISP ("overflow-newline-into-fringe", Voverflow_newline_into_fringe,
1778 doc: /* Non-nil means that newline may flow into the right fringe.
1779 This means that display lines which are exactly as wide as the window
1780 (not counting the final newline) will only occupy one screen line, by
1781 showing (or hiding) the final newline in the right fringe; when point
1782 is at the final newline, the cursor is shown in the right fringe.
1783 If nil, also continue lines which are exactly as wide as the window. */);
1784 Voverflow_newline_into_fringe = Qt;
1786 DEFVAR_LISP ("fringe-bitmaps", Vfringe_bitmaps,
1787 doc: /* List of fringe bitmap symbols. */);
1788 Vfringe_bitmaps = Qnil;
1791 /* Garbage collection hook */
1793 void
1794 mark_fringe_data (void)
1796 int i;
1798 for (i = 0; i < max_fringe_bitmaps; i++)
1799 if (!NILP (fringe_faces[i]))
1800 mark_object (fringe_faces[i]);
1803 /* Initialize this module when Emacs starts. */
1805 void
1806 init_fringe_once (void)
1808 int bt;
1810 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1811 init_fringe_bitmap (bt, &standard_bitmaps[bt], 1);
1814 void
1815 init_fringe (void)
1817 int i;
1819 max_fringe_bitmaps = MAX_STANDARD_FRINGE_BITMAPS + 20;
1821 fringe_bitmaps = xzalloc (max_fringe_bitmaps * sizeof *fringe_bitmaps);
1822 fringe_faces = xmalloc (max_fringe_bitmaps * sizeof *fringe_faces);
1824 for (i = 0; i < max_fringe_bitmaps; i++)
1825 fringe_faces[i] = Qnil;
1828 #ifdef HAVE_NTGUI
1830 void
1831 w32_init_fringe (struct redisplay_interface *rif)
1833 int bt;
1835 if (!rif)
1836 return;
1838 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1840 struct fringe_bitmap *fb = &standard_bitmaps[bt];
1841 rif->define_fringe_bitmap (bt, fb->bits, fb->height, fb->width);
1845 void
1846 w32_reset_fringes (void)
1848 /* Destroy row bitmaps. */
1849 int bt;
1850 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1852 if (!rif)
1853 return;
1855 for (bt = NO_FRINGE_BITMAP + 1; bt < max_used_fringe_bitmap; bt++)
1856 rif->destroy_fringe_bitmap (bt);
1859 #endif /* HAVE_NTGUI */
1861 #endif /* HAVE_WINDOW_SYSTEM */