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