]> code.delx.au - gnu-emacs/blob - src/fringe.c
Merge from emacs--devo--0
[gnu-emacs] / src / fringe.c
1 /* Fringe handling (split from xdisp.c).
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 2006, 2007, 2008 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
22
23 #include <config.h>
24 #include <stdio.h>
25
26 #include "lisp.h"
27 #include "frame.h"
28 #include "window.h"
29 #include "dispextern.h"
30 #include "buffer.h"
31 #include "blockinput.h"
32 #include "termhooks.h"
33
34 #ifdef HAVE_WINDOW_SYSTEM
35
36 extern Lisp_Object Qfringe;
37 extern Lisp_Object Qtop, Qbottom, Qcenter;
38 extern Lisp_Object Qup, Qdown, Qleft, Qright;
39
40 /* Non-nil means that newline may flow into the right fringe. */
41
42 Lisp_Object Voverflow_newline_into_fringe;
43
44 /* List of known fringe bitmap symbols.
45
46 The fringe bitmap number is stored in the `fringe' property on
47 those symbols. Names for the built-in bitmaps are installed by
48 loading fringe.el.
49 */
50
51 Lisp_Object Vfringe_bitmaps;
52
53 /* Fringe bitmaps are represented in three different ways:
54
55 Logical bitmaps are used internally to denote things like
56 'end-of-buffer', 'left-truncation', 'overlay-arrow', etc.
57
58 Physical bitmaps specify the visual appearence of the bitmap,
59 e.g. 'bottom-left-angle', 'left-arrow', 'left-triangle', etc.
60 User defined bitmaps are physical bitmaps.
61
62 Internally, fringe bitmaps for a specific display row are
63 represented as a simple integer that is used as an index
64 into the table of all defined bitmaps. This index is stored
65 in the `fringe' property of the physical bitmap symbol.
66
67 Logical bitmaps are mapped to physical bitmaps through the
68 buffer-local `fringe-indicator-alist' variable.
69
70 Each element of this alist is a cons (LOGICAL . PHYSICAL)
71 mapping a logical bitmap to a physical bitmap.
72 PHYSICAL is either a symbol to use in both left and right fringe,
73 or a cons of two symbols (LEFT . RIGHT) denoting different
74 bitmaps to use in left and right fringe.
75
76 LOGICAL is first looked up in the window's buffer's buffer-local
77 value of the fringe-indicator-alist variable, and if not present,
78 in the global value of fringe-indicator-alist.
79
80 If LOGICAL is not present in either alist, or the PHYSICAL value
81 found is nil, no bitmap is shown for the logical bitmap.
82
83 The `left-fringe' and `right-fringe' display properties
84 must specify physical bitmap symbols.
85 */
86
87 extern Lisp_Object Qunknown;
88 Lisp_Object Qtruncation, Qcontinuation, Qoverlay_arrow;
89 Lisp_Object Qempty_line, Qtop_bottom;
90 extern Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
91 Lisp_Object Qhollow_small;
92
93 enum fringe_bitmap_align
94 {
95 ALIGN_BITMAP_CENTER = 0,
96 ALIGN_BITMAP_TOP,
97 ALIGN_BITMAP_BOTTOM
98 };
99
100 struct fringe_bitmap
101 {
102 unsigned short *bits;
103 unsigned height : 8;
104 unsigned width : 8;
105 unsigned period : 8;
106 unsigned align : 2;
107 unsigned dynamic : 1;
108 };
109
110 \f
111 /***********************************************************************
112 Fringe bitmaps
113 ***********************************************************************/
114
115 /* Undefined bitmap. A question mark. */
116 /*
117 ..xxxx..
118 .xxxxxx.
119 xx....xx
120 xx....xx
121 ....xx..
122 ...xx...
123 ...xx...
124 ........
125 ...xx...
126 ...xx...
127 */
128 static unsigned short question_mark_bits[] = {
129 0x3c, 0x7e, 0x7e, 0x0c, 0x18, 0x18, 0x00, 0x18, 0x18};
130
131 /* An arrow like this: `<-'. */
132 /*
133 ...xx...
134 ..xx....
135 .xx.....
136 xxxxxx..
137 xxxxxx..
138 .xx.....
139 ..xx....
140 ...xx...
141 */
142 static unsigned short left_arrow_bits[] = {
143 0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};
144
145
146 /* Right truncation arrow bitmap `->'. */
147 /*
148 ...xx...
149 ....xx..
150 .....xx.
151 ..xxxxxx
152 ..xxxxxx
153 .....xx.
154 ....xx..
155 ...xx...
156 */
157 static unsigned short right_arrow_bits[] = {
158 0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};
159
160
161 /* Up arrow bitmap. */
162 /*
163 ...xx...
164 ..xxxx..
165 .xxxxxx.
166 xxxxxxxx
167 ...xx...
168 ...xx...
169 ...xx...
170 ...xx...
171 */
172 static unsigned short up_arrow_bits[] = {
173 0x18, 0x3c, 0x7e, 0xff, 0x18, 0x18, 0x18, 0x18};
174
175
176 /* Down arrow bitmap. */
177 /*
178 ...xx...
179 ...xx...
180 ...xx...
181 ...xx...
182 xxxxxxxx
183 .xxxxxx.
184 ..xxxx..
185 ...xx...
186 */
187 static unsigned short down_arrow_bits[] = {
188 0x18, 0x18, 0x18, 0x18, 0xff, 0x7e, 0x3c, 0x18};
189
190 /* Marker for continuation lines. */
191 /*
192 ..xxxx..
193 .xxxxx..
194 xx......
195 xxx..x..
196 xxxxxx..
197 .xxxxx..
198 ..xxxx..
199 .xxxxx..
200 */
201 static unsigned short left_curly_arrow_bits[] = {
202 0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};
203
204 /* Marker for continued lines. */
205 /*
206 ..xxxx..
207 ..xxxxx.
208 ......xx
209 ..x..xxx
210 ..xxxxxx
211 ..xxxxx.
212 ..xxxx..
213 ..xxxxx.
214 */
215 static unsigned short right_curly_arrow_bits[] = {
216 0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
217
218 /* Reverse Overlay arrow bitmap. A triangular arrow. */
219 /*
220 ......xx
221 ....xxxx
222 ...xxxxx
223 ..xxxxxx
224 ..xxxxxx
225 ...xxxxx
226 ....xxxx
227 ......xx
228 */
229 static unsigned short left_triangle_bits[] = {
230 0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};
231
232 /* Overlay arrow bitmap. A triangular arrow. */
233 /*
234 xx......
235 xxxx....
236 xxxxx...
237 xxxxxx..
238 xxxxxx..
239 xxxxx...
240 xxxx....
241 xx......
242 */
243 static unsigned short right_triangle_bits[] = {
244 0xc0, 0xf0, 0xf8, 0xfc, 0xfc, 0xf8, 0xf0, 0xc0};
245
246 /* First line bitmap. An top-left angle. */
247 /*
248 xxxxxx..
249 xxxxxx..
250 xx......
251 xx......
252 xx......
253 xx......
254 xx......
255 ........
256 */
257 static unsigned short top_left_angle_bits[] = {
258 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00};
259
260 /* First line bitmap. An right-up angle. */
261 /*
262 ..xxxxxx
263 ..xxxxxx
264 ......xx
265 ......xx
266 ......xx
267 ......xx
268 ......xx
269 ........
270 */
271 static unsigned short top_right_angle_bits[] = {
272 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00};
273
274 /* Last line bitmap. An left-down angle. */
275 /*
276 ........
277 xx......
278 xx......
279 xx......
280 xx......
281 xx......
282 xxxxxx..
283 xxxxxx..
284 */
285 static unsigned short bottom_left_angle_bits[] = {
286 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
287
288 /* Last line bitmap. An right-down angle. */
289 /*
290 ........
291 ......xx
292 ......xx
293 ......xx
294 ......xx
295 ......xx
296 ..xxxxxx
297 ..xxxxxx
298 */
299 static unsigned short bottom_right_angle_bits[] = {
300 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
301
302 /* First/last line bitmap. An left bracket. */
303 /*
304 xxxxxx..
305 xxxxxx..
306 xx......
307 xx......
308 xx......
309 xx......
310 xx......
311 xx......
312 xxxxxx..
313 xxxxxx..
314 */
315 static unsigned short left_bracket_bits[] = {
316 0xfc, 0xfc, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xfc, 0xfc};
317
318 /* First/last line bitmap. An right bracket. */
319 /*
320 ..xxxxxx
321 ..xxxxxx
322 ......xx
323 ......xx
324 ......xx
325 ......xx
326 ......xx
327 ......xx
328 ..xxxxxx
329 ..xxxxxx
330 */
331 static unsigned short right_bracket_bits[] = {
332 0x3f, 0x3f, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x3f, 0x3f};
333
334 /* Filled box cursor bitmap. A filled box; max 13 pixels high. */
335 /*
336 xxxxxxx.
337 xxxxxxx.
338 xxxxxxx.
339 xxxxxxx.
340 xxxxxxx.
341 xxxxxxx.
342 xxxxxxx.
343 xxxxxxx.
344 xxxxxxx.
345 xxxxxxx.
346 xxxxxxx.
347 xxxxxxx.
348 xxxxxxx.
349 */
350 static unsigned short filled_rectangle_bits[] = {
351 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe};
352
353 /* Hollow box cursor bitmap. A hollow box; max 13 pixels high. */
354 /*
355 xxxxxxx.
356 x.....x.
357 x.....x.
358 x.....x.
359 x.....x.
360 x.....x.
361 x.....x.
362 x.....x.
363 x.....x.
364 x.....x.
365 x.....x.
366 x.....x.
367 xxxxxxx.
368 */
369 static unsigned short hollow_rectangle_bits[] = {
370 0xfe, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0x82, 0xfe};
371
372 /* Hollow square bitmap. */
373 /*
374 .xxxxxx.
375 .x....x.
376 .x....x.
377 .x....x.
378 .x....x.
379 .xxxxxx.
380 */
381 static unsigned short hollow_square_bits[] = {
382 0x7e, 0x42, 0x42, 0x42, 0x42, 0x7e};
383
384 /* Filled square bitmap. */
385 /*
386 .xxxxxx.
387 .xxxxxx.
388 .xxxxxx.
389 .xxxxxx.
390 .xxxxxx.
391 .xxxxxx.
392 */
393 static unsigned short filled_square_bits[] = {
394 0x7e, 0x7e, 0x7e, 0x7e, 0x7e, 0x7e};
395
396 /* Bar cursor bitmap. A vertical bar; max 13 pixels high. */
397 /*
398 xx......
399 xx......
400 xx......
401 xx......
402 xx......
403 xx......
404 xx......
405 xx......
406 xx......
407 xx......
408 xx......
409 xx......
410 xx......
411 */
412 static unsigned short vertical_bar_bits[] = {
413 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0};
414
415 /* HBar cursor bitmap. A horizontal bar; 2 pixels high. */
416 /*
417 xxxxxxx.
418 xxxxxxx.
419 */
420 static unsigned short horizontal_bar_bits[] = {
421 0xfe, 0xfe};
422
423
424 /* Bitmap drawn to indicate lines not displaying text if
425 `indicate-empty-lines' is non-nil. */
426 /*
427 ........
428 ..xxxx..
429 ........
430 ........
431 ..xxxx..
432 ........
433 */
434 static unsigned short empty_line_bits[] = {
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,
438 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
439 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
440 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
441 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
442 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
443
444
445 #define BYTES_PER_BITMAP_ROW (sizeof (unsigned short))
446 #define STANDARD_BITMAP_HEIGHT(bits) (sizeof (bits)/BYTES_PER_BITMAP_ROW)
447 #define FRBITS(bits) bits, STANDARD_BITMAP_HEIGHT (bits)
448
449 /* NOTE: The order of these bitmaps must match the sequence
450 used in fringe.el to define the corresponding symbols. */
451
452 struct fringe_bitmap standard_bitmaps[] =
453 {
454 { NULL, 0, 0, 0, 0, 0 }, /* NO_FRINGE_BITMAP */
455 { FRBITS (question_mark_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
456 { FRBITS (left_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
457 { FRBITS (right_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
458 { FRBITS (up_arrow_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
459 { FRBITS (down_arrow_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
460 { FRBITS (left_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
461 { FRBITS (right_curly_arrow_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
462 { FRBITS (left_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
463 { FRBITS (right_triangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
464 { FRBITS (top_left_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
465 { FRBITS (top_right_angle_bits), 8, 0, ALIGN_BITMAP_TOP, 0 },
466 { FRBITS (bottom_left_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
467 { FRBITS (bottom_right_angle_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
468 { FRBITS (left_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
469 { FRBITS (right_bracket_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
470 { FRBITS (filled_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
471 { FRBITS (hollow_rectangle_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
472 { FRBITS (filled_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
473 { FRBITS (hollow_square_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
474 { FRBITS (vertical_bar_bits), 8, 0, ALIGN_BITMAP_CENTER, 0 },
475 { FRBITS (horizontal_bar_bits), 8, 0, ALIGN_BITMAP_BOTTOM, 0 },
476 { FRBITS (empty_line_bits), 8, 3, ALIGN_BITMAP_TOP, 0 },
477 };
478
479 #define NO_FRINGE_BITMAP 0
480 #define UNDEF_FRINGE_BITMAP 1
481 #define MAX_STANDARD_FRINGE_BITMAPS (sizeof(standard_bitmaps)/sizeof(standard_bitmaps[0]))
482
483 static struct fringe_bitmap **fringe_bitmaps;
484 static Lisp_Object *fringe_faces;
485 static int max_fringe_bitmaps;
486
487 static int max_used_fringe_bitmap = MAX_STANDARD_FRINGE_BITMAPS;
488
489
490 /* Lookup bitmap number for symbol BITMAP.
491 Return 0 if not a bitmap. */
492
493 int
494 lookup_fringe_bitmap (bitmap)
495 Lisp_Object bitmap;
496 {
497 int bn;
498
499 bitmap = Fget (bitmap, Qfringe);
500 if (!INTEGERP (bitmap))
501 return 0;
502
503 bn = XINT (bitmap);
504 if (bn > NO_FRINGE_BITMAP
505 && bn < max_used_fringe_bitmap
506 && (bn < MAX_STANDARD_FRINGE_BITMAPS
507 || fringe_bitmaps[bn] != NULL))
508 return bn;
509
510 return 0;
511 }
512
513 /* Get fringe bitmap name for bitmap number BN.
514
515 Found by traversing Vfringe_bitmaps comparing BN to the
516 fringe property for each symbol.
517
518 Return BN if not found in Vfringe_bitmaps. */
519
520 static Lisp_Object
521 get_fringe_bitmap_name (bn)
522 int bn;
523 {
524 Lisp_Object bitmaps;
525 Lisp_Object num;
526
527 /* Zero means no bitmap -- return nil. */
528 if (bn <= 0)
529 return Qnil;
530
531 bitmaps = Vfringe_bitmaps;
532 num = make_number (bn);
533
534 while (CONSP (bitmaps))
535 {
536 Lisp_Object bitmap = XCAR (bitmaps);
537 if (EQ (num, Fget (bitmap, Qfringe)))
538 return bitmap;
539 bitmaps = XCDR (bitmaps);
540 }
541
542 return num;
543 }
544
545
546 /* Draw the bitmap WHICH in one of the left or right fringes of
547 window W. ROW is the glyph row for which to display the bitmap; it
548 determines the vertical position at which the bitmap has to be
549 drawn.
550 LEFT_P is 1 for left fringe, 0 for right fringe.
551 */
552
553 static void
554 draw_fringe_bitmap_1 (w, row, left_p, overlay, which)
555 struct window *w;
556 struct glyph_row *row;
557 int left_p, overlay;
558 int which;
559 {
560 struct frame *f = XFRAME (WINDOW_FRAME (w));
561 struct draw_fringe_bitmap_params p;
562 struct fringe_bitmap *fb;
563 int period;
564 int face_id = DEFAULT_FACE_ID;
565
566 p.cursor_p = 0;
567 p.overlay_p = (overlay & 1) == 1;
568 p.cursor_p = (overlay & 2) == 2;
569
570 if (which != NO_FRINGE_BITMAP)
571 {
572 }
573 else if (left_p)
574 {
575 which = row->left_fringe_bitmap;
576 face_id = row->left_fringe_face_id;
577 }
578 else
579 {
580 which = row->right_fringe_bitmap;
581 face_id = row->right_fringe_face_id;
582 }
583
584 if (face_id == DEFAULT_FACE_ID)
585 {
586 Lisp_Object face;
587
588 if ((face = fringe_faces[which], NILP (face))
589 || (face_id = lookup_derived_face (f, face, FRINGE_FACE_ID, 0),
590 face_id < 0))
591 face_id = FRINGE_FACE_ID;
592 }
593
594 fb = fringe_bitmaps[which];
595 if (fb == NULL)
596 fb = &standard_bitmaps[which < MAX_STANDARD_FRINGE_BITMAPS
597 ? which : UNDEF_FRINGE_BITMAP];
598
599 period = fb->period;
600
601 /* Convert row to frame coordinates. */
602 p.y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
603
604 p.which = which;
605 p.bits = fb->bits;
606 p.wd = fb->width;
607
608 p.h = fb->height;
609 p.dh = (period > 0 ? (p.y % period) : 0);
610 p.h -= p.dh;
611 /* Clip bitmap if too high. */
612 if (p.h > row->height)
613 p.h = row->height;
614
615 p.face = FACE_FROM_ID (f, face_id);
616
617 if (p.face == NULL)
618 {
619 /* This could happen after clearing face cache.
620 But it shouldn't happen anymore. ++kfs */
621 return;
622 }
623
624 PREPARE_FACE_FOR_DISPLAY (f, p.face);
625
626 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
627 the fringe. */
628 p.bx = -1;
629 if (left_p)
630 {
631 int wd = WINDOW_LEFT_FRINGE_WIDTH (w);
632 int x = window_box_left (w, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
633 ? LEFT_MARGIN_AREA
634 : TEXT_AREA));
635 if (p.wd > wd)
636 p.wd = wd;
637 p.x = x - p.wd - (wd - p.wd) / 2;
638
639 if (p.wd < wd || row->height > p.h)
640 {
641 /* If W has a vertical border to its left, don't draw over it. */
642 wd -= ((!WINDOW_LEFTMOST_P (w)
643 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
644 ? 1 : 0);
645 p.bx = x - wd;
646 p.nx = wd;
647 }
648 }
649 else
650 {
651 int x = window_box_right (w,
652 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
653 ? RIGHT_MARGIN_AREA
654 : TEXT_AREA));
655 int wd = WINDOW_RIGHT_FRINGE_WIDTH (w);
656 if (p.wd > wd)
657 p.wd = wd;
658 p.x = x + (wd - p.wd) / 2;
659 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
660 the fringe. */
661 if (p.wd < wd || row->height > p.h)
662 {
663 p.bx = x;
664 p.nx = wd;
665 }
666 }
667
668 if (p.bx >= 0)
669 {
670 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
671
672 p.by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, row->y));
673 p.ny = row->visible_height;
674 }
675
676 /* Adjust y to the offset in the row to start drawing the bitmap. */
677 switch (fb->align)
678 {
679 case ALIGN_BITMAP_CENTER:
680 p.y += (row->height - p.h) / 2;
681 break;
682 case ALIGN_BITMAP_BOTTOM:
683 p.h = fb->height;
684 p.y += (row->visible_height - p.h);
685 break;
686 case ALIGN_BITMAP_TOP:
687 break;
688 }
689
690 FRAME_RIF (f)->draw_fringe_bitmap (w, row, &p);
691 }
692
693 static int
694 get_logical_cursor_bitmap (w, cursor)
695 struct window *w;
696 Lisp_Object cursor;
697 {
698 Lisp_Object cmap, bm = Qnil;
699
700 if ((cmap = XBUFFER (w->buffer)->fringe_cursor_alist), !NILP (cmap))
701 {
702 bm = Fassq (cursor, cmap);
703 if (CONSP (bm))
704 {
705 if ((bm = XCDR (bm)), NILP (bm))
706 return NO_FRINGE_BITMAP;
707 return lookup_fringe_bitmap (bm);
708 }
709 }
710 if (EQ (cmap, buffer_defaults.fringe_cursor_alist))
711 return NO_FRINGE_BITMAP;
712 bm = Fassq (cursor, buffer_defaults.fringe_cursor_alist);
713 if (!CONSP (bm) || ((bm = XCDR (bm)), NILP (bm)))
714 return NO_FRINGE_BITMAP;
715 return lookup_fringe_bitmap (bm);
716 }
717
718 static int
719 get_logical_fringe_bitmap (w, bitmap, right_p, partial_p)
720 struct window *w;
721 Lisp_Object bitmap;
722 int right_p, partial_p;
723 {
724 Lisp_Object cmap, bm1 = Qnil, bm2 = Qnil, bm;
725 int ln1 = 0, ln2 = 0;
726 int ix1 = right_p;
727 int ix2 = ix1 + (partial_p ? 2 : 0);
728
729 /* Lookup in buffer-local fringe-indicator-alist before global alist.
730
731 Elements are:
732 BITMAP -- use for all
733 (L R) -- use for left right (whether partial or not)
734 (L R PL PR) -- use for left rigth partial-left partial-right
735 If any value in local binding is not present or t, use global value.
736
737 If partial, lookup partial bitmap in default value if not found here.
738 If not partial, or no partial spec is present, use non-partial bitmap. */
739
740 if ((cmap = XBUFFER (w->buffer)->fringe_indicator_alist), !NILP (cmap))
741 {
742 bm1 = Fassq (bitmap, cmap);
743 if (CONSP (bm1))
744 {
745 if ((bm1 = XCDR (bm1)), NILP (bm1))
746 return NO_FRINGE_BITMAP;
747 if (CONSP (bm1))
748 {
749 ln1 = XINT (Flength (bm1));
750 if (partial_p)
751 {
752 if (ln1 > ix2)
753 {
754 bm = Fnth (make_number (ix2), bm1);
755 if (!EQ (bm, Qt))
756 goto found;
757 }
758 }
759 else
760 {
761 if (ln1 > ix1)
762 {
763 bm = Fnth (make_number (ix1), bm1);
764 if (!EQ (bm, Qt))
765 goto found;
766 }
767 }
768 }
769 else if ((bm = bm1, !EQ (bm, Qt)))
770 goto found;
771 }
772 }
773
774 if (!EQ (cmap, buffer_defaults.fringe_indicator_alist)
775 && !NILP (buffer_defaults.fringe_indicator_alist))
776 {
777 bm2 = Fassq (bitmap, buffer_defaults.fringe_indicator_alist);
778 if (CONSP (bm2))
779 {
780 if ((bm2 = XCDR (bm2)), !NILP (bm2))
781 {
782 if (CONSP (bm2))
783 {
784 ln2 = XINT (Flength (bm2));
785 if (partial_p)
786 {
787 if (ln2 > ix2)
788 {
789 bm = Fnth (make_number (ix2), bm2);
790 if (!EQ (bm, Qt))
791 goto found;
792 }
793 }
794 }
795 }
796 }
797 }
798
799 if (ln1 > ix1)
800 {
801 bm = Fnth (make_number (ix1), bm1);
802 if (!EQ (bm, Qt))
803 goto found;
804 }
805
806 if (ln2 > ix1)
807 {
808 bm = Fnth (make_number (ix1), bm2);
809 if (!EQ (bm, Qt))
810 goto found;
811 return NO_FRINGE_BITMAP;
812 }
813 else if ((bm = bm2, NILP (bm)))
814 return NO_FRINGE_BITMAP;
815
816 found:
817 return lookup_fringe_bitmap (bm);
818 }
819
820
821 void
822 draw_fringe_bitmap (w, row, left_p)
823 struct window *w;
824 struct glyph_row *row;
825 int left_p;
826 {
827 int overlay = 0;
828
829 if (!left_p && row->cursor_in_fringe_p)
830 {
831 Lisp_Object cursor = Qnil;
832
833 switch (w->phys_cursor_type)
834 {
835 case HOLLOW_BOX_CURSOR:
836 if (row->visible_height >= STANDARD_BITMAP_HEIGHT (hollow_rectangle_bits))
837 cursor = Qhollow;
838 else
839 cursor = Qhollow_small;
840 break;
841 case FILLED_BOX_CURSOR:
842 cursor = Qbox;
843 break;
844 case BAR_CURSOR:
845 cursor = Qbar;
846 break;
847 case HBAR_CURSOR:
848 cursor = Qhbar;
849 break;
850 case NO_CURSOR:
851 default:
852 w->phys_cursor_on_p = 0;
853 row->cursor_in_fringe_p = 0;
854 break;
855 }
856 if (!NILP (cursor))
857 {
858 int bm = get_logical_cursor_bitmap (w, cursor);
859 if (bm != NO_FRINGE_BITMAP)
860 {
861 draw_fringe_bitmap_1 (w, row, 0, 2, bm);
862 overlay = EQ (cursor, Qbox) ? 3 : 1;
863 }
864 }
865 }
866
867 draw_fringe_bitmap_1 (w, row, left_p, overlay, NO_FRINGE_BITMAP);
868
869 if (left_p && row->overlay_arrow_bitmap != NO_FRINGE_BITMAP)
870 draw_fringe_bitmap_1 (w, row, 1, 1, row->overlay_arrow_bitmap);
871 }
872
873
874 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
875 function with input blocked. */
876
877 void
878 draw_row_fringe_bitmaps (w, row)
879 struct window *w;
880 struct glyph_row *row;
881 {
882 xassert (interrupt_input_blocked);
883
884 /* If row is completely invisible, because of vscrolling, we
885 don't have to draw anything. */
886 if (row->visible_height <= 0)
887 return;
888
889 if (WINDOW_LEFT_FRINGE_WIDTH (w) != 0)
890 draw_fringe_bitmap (w, row, 1);
891
892 if (WINDOW_RIGHT_FRINGE_WIDTH (w) != 0)
893 draw_fringe_bitmap (w, row, 0);
894 }
895
896 /* Draw the fringes of window W. Only fringes for rows marked for
897 update in redraw_fringe_bitmaps_p are drawn.
898
899 Return >0 if left or right fringe was redrawn in any way.
900
901 If NO_FRINGE is non-zero, also return >0 if either fringe has zero width.
902
903 A return value >0 indicates that the vertical line between windows
904 needs update (as it may be drawn in the fringe).
905 */
906
907 int
908 draw_window_fringes (w, no_fringe)
909 struct window *w;
910 int no_fringe;
911 {
912 struct glyph_row *row;
913 int yb = window_text_bottom_y (w);
914 int nrows = w->current_matrix->nrows;
915 int y = 0, rn;
916 int updated = 0;
917
918 if (w->pseudo_window_p)
919 return 0;
920
921 /* Must draw line if no fringe */
922 if (no_fringe
923 && (WINDOW_LEFT_FRINGE_WIDTH (w) == 0
924 || WINDOW_RIGHT_FRINGE_WIDTH (w) == 0))
925 updated++;
926
927 for (y = 0, rn = 0, row = w->current_matrix->rows;
928 y < yb && rn < nrows;
929 y += row->height, ++row, ++rn)
930 {
931 if (!row->redraw_fringe_bitmaps_p)
932 continue;
933 draw_row_fringe_bitmaps (w, row);
934 row->redraw_fringe_bitmaps_p = 0;
935 updated++;
936 }
937
938 return updated;
939 }
940
941
942 /* Recalculate the bitmaps to show in the fringes of window W.
943 Only mark rows with modified bitmaps for update in redraw_fringe_bitmaps_p.
944
945 If KEEP_CURRENT_P is 0, update current_matrix too. */
946
947 int
948 update_window_fringes (w, keep_current_p)
949 struct window *w;
950 int keep_current_p;
951 {
952 struct glyph_row *row, *cur = 0;
953 int yb = window_text_bottom_y (w);
954 int rn, nrows = w->current_matrix->nrows;
955 int y;
956 int redraw_p = 0;
957 Lisp_Object boundary_top = Qnil, boundary_bot = Qnil;
958 Lisp_Object arrow_top = Qnil, arrow_bot = Qnil;
959 Lisp_Object empty_pos;
960 Lisp_Object ind = Qnil;
961 #define MAX_BITMAP_CACHE (8*4)
962 int bitmap_cache[MAX_BITMAP_CACHE];
963
964 if (w->pseudo_window_p)
965 return 0;
966
967 if (!MINI_WINDOW_P (w)
968 && (ind = XBUFFER (w->buffer)->indicate_buffer_boundaries, !NILP (ind)))
969 {
970 if (EQ (ind, Qleft) || EQ (ind, Qright))
971 boundary_top = boundary_bot = arrow_top = arrow_bot = ind;
972 else if (CONSP (ind) && CONSP (XCAR (ind)))
973 {
974 Lisp_Object pos;
975 if (pos = Fassq (Qt, ind), !NILP (pos))
976 boundary_top = boundary_bot = arrow_top = arrow_bot = XCDR (pos);
977 if (pos = Fassq (Qtop, ind), !NILP (pos))
978 boundary_top = XCDR (pos);
979 if (pos = Fassq (Qbottom, ind), !NILP (pos))
980 boundary_bot = XCDR (pos);
981 if (pos = Fassq (Qup, ind), !NILP (pos))
982 arrow_top = XCDR (pos);
983 if (pos = Fassq (Qdown, ind), !NILP (pos))
984 arrow_bot = XCDR (pos);
985 }
986 else
987 /* Anything else means boundary on left and no arrows. */
988 boundary_top = boundary_bot = Qleft;
989 }
990
991 if (!NILP (ind))
992 {
993 int done_top = 0, done_bot = 0;
994
995 for (y = 0, rn = 0;
996 y < yb && rn < nrows;
997 y += row->height, ++rn)
998 {
999 unsigned indicate_bob_p, indicate_top_line_p;
1000 unsigned indicate_eob_p, indicate_bottom_line_p;
1001
1002 row = w->desired_matrix->rows + rn;
1003 if (!row->enabled_p)
1004 row = w->current_matrix->rows + rn;
1005
1006 indicate_bob_p = row->indicate_bob_p;
1007 indicate_top_line_p = row->indicate_top_line_p;
1008 indicate_eob_p = row->indicate_eob_p;
1009 indicate_bottom_line_p = row->indicate_bottom_line_p;
1010
1011 row->indicate_bob_p = row->indicate_top_line_p = 0;
1012 row->indicate_eob_p = row->indicate_bottom_line_p = 0;
1013
1014 if (!row->mode_line_p)
1015 {
1016 if (!done_top)
1017 {
1018 if (MATRIX_ROW_START_CHARPOS (row) <= BUF_BEGV (XBUFFER (w->buffer))
1019 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w, row))
1020 row->indicate_bob_p = !NILP (boundary_top);
1021 else
1022 row->indicate_top_line_p = !NILP (arrow_top);
1023 done_top = 1;
1024 }
1025
1026 if (!done_bot)
1027 {
1028 if (MATRIX_ROW_END_CHARPOS (row) >= BUF_ZV (XBUFFER (w->buffer))
1029 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row))
1030 row->indicate_eob_p = !NILP (boundary_bot), done_bot = 1;
1031 else if (y + row->height >= yb)
1032 row->indicate_bottom_line_p = !NILP (arrow_bot), done_bot = 1;
1033 }
1034 }
1035
1036 if (indicate_bob_p != row->indicate_bob_p
1037 || indicate_top_line_p != row->indicate_top_line_p
1038 || indicate_eob_p != row->indicate_eob_p
1039 || indicate_bottom_line_p != row->indicate_bottom_line_p)
1040 row->redraw_fringe_bitmaps_p = 1;
1041 }
1042 }
1043
1044 empty_pos = XBUFFER (w->buffer)->indicate_empty_lines;
1045 if (!NILP (empty_pos) && !EQ (empty_pos, Qright))
1046 empty_pos = WINDOW_LEFT_FRINGE_WIDTH (w) == 0 ? Qright : Qleft;
1047
1048 for (y = 0; y < MAX_BITMAP_CACHE; y++)
1049 bitmap_cache[y] = -1;
1050
1051 #define LEFT_FRINGE(cache, which, partial_p) \
1052 (bitmap_cache[cache*4+partial_p] >= 0 \
1053 ? bitmap_cache[cache*4+partial_p] \
1054 : (bitmap_cache[cache*4+partial_p] = \
1055 get_logical_fringe_bitmap (w, which, 0, partial_p)))
1056
1057 #define RIGHT_FRINGE(cache, which, partial_p) \
1058 (bitmap_cache[cache*4+2+partial_p] >= 0 \
1059 ? bitmap_cache[cache*4+2+partial_p] \
1060 : (bitmap_cache[cache*4+2+partial_p] = \
1061 get_logical_fringe_bitmap (w, which, 1, partial_p)))
1062
1063
1064 for (y = 0, rn = 0;
1065 y < yb && rn < nrows;
1066 y += row->height, rn++)
1067 {
1068 int left, right;
1069 unsigned left_face_id, right_face_id;
1070
1071 row = w->desired_matrix->rows + rn;
1072 cur = w->current_matrix->rows + rn;
1073 if (!row->enabled_p)
1074 row = cur;
1075
1076 left_face_id = right_face_id = DEFAULT_FACE_ID;
1077
1078 /* Decide which bitmap to draw in the left fringe. */
1079 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
1080 left = NO_FRINGE_BITMAP;
1081 else if (row->left_user_fringe_bitmap != NO_FRINGE_BITMAP)
1082 {
1083 left = row->left_user_fringe_bitmap;
1084 left_face_id = row->left_user_fringe_face_id;
1085 }
1086 else if (row->truncated_on_left_p)
1087 left = LEFT_FRINGE(0, Qtruncation, 0);
1088 else if (row->indicate_bob_p && EQ (boundary_top, Qleft))
1089 left = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1090 ? LEFT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1091 : LEFT_FRINGE (2, Qtop, 0));
1092 else if (row->indicate_eob_p && EQ (boundary_bot, Qleft))
1093 left = LEFT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1094 else if (MATRIX_ROW_CONTINUATION_LINE_P (row))
1095 left = LEFT_FRINGE (4, Qcontinuation, 0);
1096 else if (row->indicate_empty_line_p && EQ (empty_pos, Qleft))
1097 left = LEFT_FRINGE (5, Qempty_line, 0);
1098 else if (row->indicate_top_line_p && EQ (arrow_top, Qleft))
1099 left = LEFT_FRINGE (6, Qup, 0);
1100 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qleft))
1101 left = LEFT_FRINGE (7, Qdown, 0);
1102 else
1103 left = NO_FRINGE_BITMAP;
1104
1105 /* Decide which bitmap to draw in the right fringe. */
1106 if (WINDOW_RIGHT_FRINGE_WIDTH (w) == 0)
1107 right = NO_FRINGE_BITMAP;
1108 else if (row->right_user_fringe_bitmap != NO_FRINGE_BITMAP)
1109 {
1110 right = row->right_user_fringe_bitmap;
1111 right_face_id = row->right_user_fringe_face_id;
1112 }
1113 else if (row->truncated_on_right_p)
1114 right = RIGHT_FRINGE (0, Qtruncation, 0);
1115 else if (row->indicate_bob_p && EQ (boundary_top, Qright))
1116 right = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1117 ? RIGHT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1118 : RIGHT_FRINGE (2, Qtop, 0));
1119 else if (row->indicate_eob_p && EQ (boundary_bot, Qright))
1120 right = RIGHT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1121 else if (row->continued_p)
1122 right = RIGHT_FRINGE (4, Qcontinuation, 0);
1123 else if (row->indicate_top_line_p && EQ (arrow_top, Qright))
1124 right = RIGHT_FRINGE (6, Qup, 0);
1125 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qright))
1126 right = RIGHT_FRINGE (7, Qdown, 0);
1127 else if (row->indicate_empty_line_p && EQ (empty_pos, Qright))
1128 right = RIGHT_FRINGE (5, Qempty_line, 0);
1129 else
1130 right = NO_FRINGE_BITMAP;
1131
1132 if (row->y != cur->y
1133 || row->visible_height != cur->visible_height
1134 || row->ends_at_zv_p != cur->ends_at_zv_p
1135 || left != cur->left_fringe_bitmap
1136 || right != cur->right_fringe_bitmap
1137 || left_face_id != cur->left_fringe_face_id
1138 || right_face_id != cur->right_fringe_face_id
1139 || cur->redraw_fringe_bitmaps_p)
1140 {
1141 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1142 if (!keep_current_p)
1143 {
1144 cur->redraw_fringe_bitmaps_p = 1;
1145 cur->left_fringe_bitmap = left;
1146 cur->right_fringe_bitmap = right;
1147 cur->left_fringe_face_id = left_face_id;
1148 cur->right_fringe_face_id = right_face_id;
1149 }
1150 }
1151
1152 if (row->overlay_arrow_bitmap < 0)
1153 row->overlay_arrow_bitmap = get_logical_fringe_bitmap (w, Qoverlay_arrow, 0, 0);
1154
1155 if (row->overlay_arrow_bitmap != cur->overlay_arrow_bitmap)
1156 {
1157 redraw_p = row->redraw_fringe_bitmaps_p = cur->redraw_fringe_bitmaps_p = 1;
1158 cur->overlay_arrow_bitmap = row->overlay_arrow_bitmap;
1159 }
1160
1161 row->left_fringe_bitmap = left;
1162 row->right_fringe_bitmap = right;
1163 row->left_fringe_face_id = left_face_id;
1164 row->right_fringe_face_id = right_face_id;
1165
1166 if (rn > 0 && row->redraw_fringe_bitmaps_p)
1167 row[-1].redraw_fringe_bitmaps_p = cur[-1].redraw_fringe_bitmaps_p = 1;
1168 }
1169
1170 return redraw_p && !keep_current_p;
1171 }
1172
1173
1174 /* Compute actual fringe widths for frame F.
1175
1176 If REDRAW is 1, redraw F if the fringe settings was actually
1177 modified and F is visible.
1178
1179 Since the combined left and right fringe must occupy an integral
1180 number of columns, we may need to add some pixels to each fringe.
1181 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
1182 but a negative width value is taken literally (after negating it).
1183
1184 We never make the fringes narrower than specified.
1185 */
1186
1187 void
1188 compute_fringe_widths (f, redraw)
1189 struct frame *f;
1190 int redraw;
1191 {
1192 int o_left = FRAME_LEFT_FRINGE_WIDTH (f);
1193 int o_right = FRAME_RIGHT_FRINGE_WIDTH (f);
1194 int o_cols = FRAME_FRINGE_COLS (f);
1195
1196 Lisp_Object left_fringe = Fassq (Qleft_fringe, f->param_alist);
1197 Lisp_Object right_fringe = Fassq (Qright_fringe, f->param_alist);
1198 int left_fringe_width, right_fringe_width;
1199
1200 if (!NILP (left_fringe))
1201 left_fringe = Fcdr (left_fringe);
1202 if (!NILP (right_fringe))
1203 right_fringe = Fcdr (right_fringe);
1204
1205 left_fringe_width = ((NILP (left_fringe) || !INTEGERP (left_fringe)) ? 8 :
1206 XINT (left_fringe));
1207 right_fringe_width = ((NILP (right_fringe) || !INTEGERP (right_fringe)) ? 8 :
1208 XINT (right_fringe));
1209
1210 if (left_fringe_width || right_fringe_width)
1211 {
1212 int left_wid = left_fringe_width >= 0 ? left_fringe_width : -left_fringe_width;
1213 int right_wid = right_fringe_width >= 0 ? right_fringe_width : -right_fringe_width;
1214 int conf_wid = left_wid + right_wid;
1215 int font_wid = FRAME_COLUMN_WIDTH (f);
1216 int cols = (left_wid + right_wid + font_wid-1) / font_wid;
1217 int real_wid = cols * font_wid;
1218 if (left_wid && right_wid)
1219 {
1220 if (left_fringe_width < 0)
1221 {
1222 /* Left fringe width is fixed, adjust right fringe if necessary */
1223 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid;
1224 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid - left_wid;
1225 }
1226 else if (right_fringe_width < 0)
1227 {
1228 /* Right fringe width is fixed, adjust left fringe if necessary */
1229 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid - right_wid;
1230 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid;
1231 }
1232 else
1233 {
1234 /* Adjust both fringes with an equal amount.
1235 Note that we are doing integer arithmetic here, so don't
1236 lose a pixel if the total width is an odd number. */
1237 int fill = real_wid - conf_wid;
1238 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid + fill/2;
1239 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid + fill - fill/2;
1240 }
1241 }
1242 else if (left_fringe_width)
1243 {
1244 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid;
1245 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1246 }
1247 else
1248 {
1249 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1250 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid;
1251 }
1252 FRAME_FRINGE_COLS (f) = cols;
1253 }
1254 else
1255 {
1256 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1257 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1258 FRAME_FRINGE_COLS (f) = 0;
1259 }
1260
1261 if (redraw && FRAME_VISIBLE_P (f))
1262 if (o_left != FRAME_LEFT_FRINGE_WIDTH (f) ||
1263 o_right != FRAME_RIGHT_FRINGE_WIDTH (f) ||
1264 o_cols != FRAME_FRINGE_COLS (f))
1265 redraw_frame (f);
1266 }
1267
1268
1269 /* Free resources used by a user-defined bitmap. */
1270
1271 void
1272 destroy_fringe_bitmap (n)
1273 int n;
1274 {
1275 struct fringe_bitmap **fbp;
1276
1277 fringe_faces[n] = Qnil;
1278
1279 fbp = &fringe_bitmaps[n];
1280 if (*fbp && (*fbp)->dynamic)
1281 {
1282 /* XXX Is SELECTED_FRAME OK here? */
1283 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1284 if (rif && rif->destroy_fringe_bitmap)
1285 rif->destroy_fringe_bitmap (n);
1286 xfree (*fbp);
1287 *fbp = NULL;
1288 }
1289
1290 while (max_used_fringe_bitmap > MAX_STANDARD_FRINGE_BITMAPS
1291 && fringe_bitmaps[max_used_fringe_bitmap - 1] == NULL)
1292 max_used_fringe_bitmap--;
1293 }
1294
1295
1296 DEFUN ("destroy-fringe-bitmap", Fdestroy_fringe_bitmap, Sdestroy_fringe_bitmap,
1297 1, 1, 0,
1298 doc: /* Destroy fringe bitmap BITMAP.
1299 If BITMAP overrides a standard fringe bitmap, the original bitmap is restored. */)
1300 (bitmap)
1301 Lisp_Object bitmap;
1302 {
1303 int n;
1304
1305 CHECK_SYMBOL (bitmap);
1306 n = lookup_fringe_bitmap (bitmap);
1307 if (!n)
1308 return Qnil;
1309
1310 destroy_fringe_bitmap (n);
1311
1312 if (n >= MAX_STANDARD_FRINGE_BITMAPS)
1313 {
1314 Vfringe_bitmaps = Fdelq (bitmap, Vfringe_bitmaps);
1315 /* It would be better to remove the fringe property. */
1316 Fput (bitmap, Qfringe, Qnil);
1317 }
1318
1319 return Qnil;
1320 }
1321
1322
1323 /* Initialize bitmap bit.
1324
1325 On X, we bit-swap the built-in bitmaps and reduce bitmap
1326 from short to char array if width is <= 8 bits.
1327
1328 On MAC with big-endian CPU, we need to byte-swap each short.
1329
1330 On W32 and MAC (little endian), there's no need to do this.
1331 */
1332
1333 #if defined (HAVE_X_WINDOWS)
1334 static unsigned char swap_nibble[16] = {
1335 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
1336 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
1337 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
1338 0x3, 0xb, 0x7, 0xf}; /* 0011 1011 0111 1111 */
1339 #endif /* HAVE_X_WINDOWS */
1340
1341 void
1342 init_fringe_bitmap (which, fb, once_p)
1343 int which;
1344 struct fringe_bitmap *fb;
1345 int once_p;
1346 {
1347 if (once_p || fb->dynamic)
1348 {
1349 #if defined (HAVE_X_WINDOWS)
1350 unsigned short *bits = fb->bits;
1351 int j;
1352
1353 if (fb->width <= 8)
1354 {
1355 unsigned char *cbits = (unsigned char *)fb->bits;
1356 for (j = 0; j < fb->height; j++)
1357 {
1358 unsigned short b = *bits++;
1359 unsigned char c;
1360 c = (unsigned char)((swap_nibble[b & 0xf] << 4)
1361 | (swap_nibble[(b>>4) & 0xf]));
1362 *cbits++ = (c >> (8 - fb->width));
1363 }
1364 }
1365 else
1366 {
1367 for (j = 0; j < fb->height; j++)
1368 {
1369 unsigned short b = *bits;
1370 b = (unsigned short)((swap_nibble[b & 0xf] << 12)
1371 | (swap_nibble[(b>>4) & 0xf] << 8)
1372 | (swap_nibble[(b>>8) & 0xf] << 4)
1373 | (swap_nibble[(b>>12) & 0xf]));
1374 *bits++ = (b >> (16 - fb->width));
1375 }
1376 }
1377 #endif /* HAVE_X_WINDOWS */
1378
1379 #if defined (MAC_OS) && defined (WORDS_BIG_ENDIAN)
1380 unsigned short *bits = fb->bits;
1381 int j;
1382 for (j = 0; j < fb->height; j++)
1383 {
1384 unsigned short b = *bits;
1385 *bits++ = ((b >> 8) & 0xff) | ((b & 0xff) << 8);
1386 }
1387 #endif /* MAC_OS && WORDS_BIG_ENDIAN */
1388 }
1389
1390 if (!once_p)
1391 {
1392 /* XXX Is SELECTED_FRAME OK here? */
1393 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1394
1395 destroy_fringe_bitmap (which);
1396
1397 if (rif && rif->define_fringe_bitmap)
1398 rif->define_fringe_bitmap (which, fb->bits, fb->height, fb->width);
1399
1400 fringe_bitmaps[which] = fb;
1401 if (which >= max_used_fringe_bitmap)
1402 max_used_fringe_bitmap = which + 1;
1403 }
1404 }
1405
1406
1407 DEFUN ("define-fringe-bitmap", Fdefine_fringe_bitmap, Sdefine_fringe_bitmap,
1408 2, 5, 0,
1409 doc: /* Define fringe bitmap BITMAP from BITS of size HEIGHT x WIDTH.
1410 BITMAP is a symbol identifying the new fringe bitmap.
1411 BITS is either a string or a vector of integers.
1412 HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
1413 WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
1414 Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
1415 indicating the positioning of the bitmap relative to the rows where it
1416 is used; the default is to center the bitmap. Fourth arg may also be a
1417 list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap
1418 should be repeated.
1419 If BITMAP already exists, the existing definition is replaced. */)
1420 (bitmap, bits, height, width, align)
1421 Lisp_Object bitmap, bits, height, width, align;
1422 {
1423 int n, h, i, j;
1424 unsigned short *b;
1425 struct fringe_bitmap fb, *xfb;
1426 int fill1 = 0, fill2 = 0;
1427
1428 CHECK_SYMBOL (bitmap);
1429
1430 if (STRINGP (bits))
1431 h = SCHARS (bits);
1432 else if (VECTORP (bits))
1433 h = XVECTOR (bits)->size;
1434 else
1435 wrong_type_argument (Qsequencep, bits);
1436
1437 if (NILP (height))
1438 fb.height = h;
1439 else
1440 {
1441 CHECK_NUMBER (height);
1442 fb.height = min (XINT (height), 255);
1443 if (fb.height > h)
1444 {
1445 fill1 = (fb.height - h) / 2;
1446 fill2 = fb.height - h - fill1;
1447 }
1448 }
1449
1450 if (NILP (width))
1451 fb.width = 8;
1452 else
1453 {
1454 CHECK_NUMBER (width);
1455 fb.width = min (XINT (width), 255);
1456 }
1457
1458 fb.period = 0;
1459 fb.align = ALIGN_BITMAP_CENTER;
1460
1461 if (CONSP (align))
1462 {
1463 Lisp_Object period = XCDR (align);
1464 if (CONSP (period))
1465 {
1466 period = XCAR (period);
1467 if (!NILP (period))
1468 {
1469 fb.period = fb.height;
1470 fb.height = 255;
1471 }
1472 }
1473 align = XCAR (align);
1474 }
1475 if (EQ (align, Qtop))
1476 fb.align = ALIGN_BITMAP_TOP;
1477 else if (EQ (align, Qbottom))
1478 fb.align = ALIGN_BITMAP_BOTTOM;
1479 else if (!NILP (align) && !EQ (align, Qcenter))
1480 error ("Bad align argument");
1481
1482 n = lookup_fringe_bitmap (bitmap);
1483 if (!n)
1484 {
1485 if (max_used_fringe_bitmap < max_fringe_bitmaps)
1486 n = max_used_fringe_bitmap++;
1487 else
1488 {
1489 for (n = MAX_STANDARD_FRINGE_BITMAPS;
1490 n < max_fringe_bitmaps;
1491 n++)
1492 if (fringe_bitmaps[n] == NULL)
1493 break;
1494
1495 if (n == max_fringe_bitmaps)
1496 {
1497 if ((max_fringe_bitmaps + 20) > MAX_FRINGE_BITMAPS)
1498 error ("No free fringe bitmap slots");
1499
1500 i = max_fringe_bitmaps;
1501 max_fringe_bitmaps += 20;
1502 fringe_bitmaps
1503 = ((struct fringe_bitmap **)
1504 xrealloc (fringe_bitmaps, max_fringe_bitmaps * sizeof (struct fringe_bitmap *)));
1505 fringe_faces
1506 = (Lisp_Object *) xrealloc (fringe_faces, max_fringe_bitmaps * sizeof (Lisp_Object));
1507
1508 for (; i < max_fringe_bitmaps; i++)
1509 {
1510 fringe_bitmaps[i] = NULL;
1511 fringe_faces[i] = Qnil;
1512 }
1513 }
1514 }
1515
1516 Vfringe_bitmaps = Fcons (bitmap, Vfringe_bitmaps);
1517 Fput (bitmap, Qfringe, make_number (n));
1518 }
1519
1520 fb.dynamic = 1;
1521
1522 xfb = (struct fringe_bitmap *) xmalloc (sizeof fb
1523 + fb.height * BYTES_PER_BITMAP_ROW);
1524 fb.bits = b = (unsigned short *) (xfb + 1);
1525 bzero (b, fb.height);
1526
1527 j = 0;
1528 while (j < fb.height)
1529 {
1530 for (i = 0; i < fill1 && j < fb.height; i++)
1531 b[j++] = 0;
1532 for (i = 0; i < h && j < fb.height; i++)
1533 {
1534 Lisp_Object elt = Faref (bits, make_number (i));
1535 b[j++] = NUMBERP (elt) ? XINT (elt) : 0;
1536 }
1537 for (i = 0; i < fill2 && j < fb.height; i++)
1538 b[j++] = 0;
1539 }
1540
1541 *xfb = fb;
1542
1543 init_fringe_bitmap (n, xfb, 0);
1544
1545 return bitmap;
1546 }
1547
1548 DEFUN ("set-fringe-bitmap-face", Fset_fringe_bitmap_face, Sset_fringe_bitmap_face,
1549 1, 2, 0,
1550 doc: /* Set face for fringe bitmap BITMAP to FACE.
1551 If FACE is nil, reset face to default fringe face. */)
1552 (bitmap, face)
1553 Lisp_Object bitmap, face;
1554 {
1555 int n;
1556 int face_id;
1557
1558 CHECK_SYMBOL (bitmap);
1559 n = lookup_fringe_bitmap (bitmap);
1560 if (!n)
1561 error ("Undefined fringe bitmap");
1562
1563 if (!NILP (face))
1564 {
1565 face_id = lookup_derived_face (SELECTED_FRAME (), face,
1566 FRINGE_FACE_ID, 1);
1567 if (face_id < 0)
1568 error ("No such face");
1569 }
1570
1571 fringe_faces[n] = face;
1572
1573 return Qnil;
1574 }
1575
1576 DEFUN ("fringe-bitmaps-at-pos", Ffringe_bitmaps_at_pos, Sfringe_bitmaps_at_pos,
1577 0, 2, 0,
1578 doc: /* Return fringe bitmaps of row containing position POS in window WINDOW.
1579 If WINDOW is nil, use selected window. If POS is nil, use value of point
1580 in that window. Return value is a list (LEFT RIGHT OV), where LEFT
1581 is the symbol for the bitmap in the left fringe (or nil if no bitmap),
1582 RIGHT is similar for the right fringe, and OV is non-nil if there is an
1583 overlay arrow in the left fringe.
1584 Return nil if POS is not visible in WINDOW. */)
1585 (pos, window)
1586 Lisp_Object pos, window;
1587 {
1588 struct window *w;
1589 struct glyph_row *row;
1590 int textpos;
1591
1592 if (NILP (window))
1593 window = selected_window;
1594 CHECK_WINDOW (window);
1595 w = XWINDOW (window);
1596
1597 if (!NILP (pos))
1598 {
1599 CHECK_NUMBER_COERCE_MARKER (pos);
1600 textpos = XINT (pos);
1601 }
1602 else if (w == XWINDOW (selected_window))
1603 textpos = PT;
1604 else
1605 textpos = XMARKER (w->pointm)->charpos;
1606
1607 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1608 row = row_containing_pos (w, textpos, row, NULL, 0);
1609 if (row)
1610 return list3 (get_fringe_bitmap_name (row->left_fringe_bitmap),
1611 get_fringe_bitmap_name (row->right_fringe_bitmap),
1612 (row->overlay_arrow_bitmap == 0 ? Qnil
1613 : row->overlay_arrow_bitmap < 0 ? Qt
1614 : get_fringe_bitmap_name (row->overlay_arrow_bitmap)));
1615 else
1616 return Qnil;
1617 }
1618
1619
1620 /***********************************************************************
1621 Initialization
1622 ***********************************************************************/
1623
1624 void
1625 syms_of_fringe ()
1626 {
1627 Qtruncation = intern ("truncation");
1628 staticpro (&Qtruncation);
1629 Qcontinuation = intern ("continuation");
1630 staticpro (&Qcontinuation);
1631 Qoverlay_arrow = intern ("overlay-arrow");
1632 staticpro (&Qoverlay_arrow);
1633 Qempty_line = intern ("empty-line");
1634 staticpro (&Qempty_line);
1635 Qtop_bottom = intern ("top-bottom");
1636 staticpro (&Qtop_bottom);
1637 Qhollow_small = intern ("hollow-small");
1638 staticpro (&Qhollow_small);
1639
1640 defsubr (&Sdestroy_fringe_bitmap);
1641 defsubr (&Sdefine_fringe_bitmap);
1642 defsubr (&Sfringe_bitmaps_at_pos);
1643 defsubr (&Sset_fringe_bitmap_face);
1644
1645 DEFVAR_LISP ("overflow-newline-into-fringe", &Voverflow_newline_into_fringe,
1646 doc: /* *Non-nil means that newline may flow into the right fringe.
1647 This means that display lines which are exactly as wide as the window
1648 (not counting the final newline) will only occupy one screen line, by
1649 showing (or hiding) the final newline in the right fringe; when point
1650 is at the final newline, the cursor is shown in the right fringe.
1651 If nil, also continue lines which are exactly as wide as the window. */);
1652 Voverflow_newline_into_fringe = Qt;
1653
1654 DEFVAR_LISP ("fringe-bitmaps", &Vfringe_bitmaps,
1655 doc: /* List of fringe bitmap symbols. */);
1656 Vfringe_bitmaps = Qnil;
1657 }
1658
1659 /* Garbage collection hook */
1660
1661 void
1662 mark_fringe_data ()
1663 {
1664 int i;
1665
1666 for (i = 0; i < max_fringe_bitmaps; i++)
1667 if (!NILP (fringe_faces[i]))
1668 mark_object (fringe_faces[i]);
1669 }
1670
1671 /* Initialize this module when Emacs starts. */
1672
1673 void
1674 init_fringe_once ()
1675 {
1676 int bt;
1677
1678 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1679 init_fringe_bitmap(bt, &standard_bitmaps[bt], 1);
1680 }
1681
1682 void
1683 init_fringe ()
1684 {
1685 int i;
1686
1687 max_fringe_bitmaps = MAX_STANDARD_FRINGE_BITMAPS + 20;
1688
1689 fringe_bitmaps
1690 = (struct fringe_bitmap **) xmalloc (max_fringe_bitmaps * sizeof (struct fringe_bitmap *));
1691 fringe_faces
1692 = (Lisp_Object *) xmalloc (max_fringe_bitmaps * sizeof (Lisp_Object));
1693
1694 for (i = 0; i < max_fringe_bitmaps; i++)
1695 {
1696 fringe_bitmaps[i] = NULL;
1697 fringe_faces[i] = Qnil;
1698 }
1699 }
1700
1701 #if defined (HAVE_NTGUI) || defined (MAC_OS)
1702
1703 void
1704 #ifdef HAVE_NTGUI
1705 w32_init_fringe (rif)
1706 #else /* MAC_OS */
1707 mac_init_fringe (rif)
1708 #endif
1709 struct redisplay_interface *rif;
1710 {
1711 int bt;
1712
1713 if (!rif)
1714 return;
1715
1716 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1717 {
1718 struct fringe_bitmap *fb = &standard_bitmaps[bt];
1719 rif->define_fringe_bitmap (bt, fb->bits, fb->height, fb->width);
1720 }
1721 }
1722 #endif
1723
1724 #ifdef HAVE_NTGUI
1725 void
1726 w32_reset_fringes ()
1727 {
1728 /* Destroy row bitmaps. */
1729 int bt;
1730 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1731
1732 if (!rif)
1733 return;
1734
1735 for (bt = NO_FRINGE_BITMAP + 1; bt < max_used_fringe_bitmap; bt++)
1736 rif->destroy_fringe_bitmap (bt);
1737 }
1738
1739 #endif /* HAVE_NTGUI */
1740
1741 #endif /* HAVE_WINDOW_SYSTEM */
1742
1743 /* arch-tag: 04596920-43eb-473d-b319-82712338162d
1744 (do not change this comment) */