Convert (most) functions in src to standard C.
[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 (Lisp_Object bitmap)
494 {
495 int bn;
496
497 bitmap = Fget (bitmap, Qfringe);
498 if (!INTEGERP (bitmap))
499 return 0;
500
501 bn = XINT (bitmap);
502 if (bn > NO_FRINGE_BITMAP
503 && bn < max_used_fringe_bitmap
504 && (bn < MAX_STANDARD_FRINGE_BITMAPS
505 || fringe_bitmaps[bn] != NULL))
506 return bn;
507
508 return 0;
509 }
510
511 /* Get fringe bitmap name for bitmap number BN.
512
513 Found by traversing Vfringe_bitmaps comparing BN to the
514 fringe property for each symbol.
515
516 Return BN if not found in Vfringe_bitmaps. */
517
518 static Lisp_Object
519 get_fringe_bitmap_name (int bn)
520 {
521 Lisp_Object bitmaps;
522 Lisp_Object num;
523
524 /* Zero means no bitmap -- return nil. */
525 if (bn <= 0)
526 return Qnil;
527
528 bitmaps = Vfringe_bitmaps;
529 num = make_number (bn);
530
531 while (CONSP (bitmaps))
532 {
533 Lisp_Object bitmap = XCAR (bitmaps);
534 if (EQ (num, Fget (bitmap, Qfringe)))
535 return bitmap;
536 bitmaps = XCDR (bitmaps);
537 }
538
539 return num;
540 }
541
542
543 /* Draw the bitmap WHICH in one of the left or right fringes of
544 window W. ROW is the glyph row for which to display the bitmap; it
545 determines the vertical position at which the bitmap has to be
546 drawn.
547 LEFT_P is 1 for left fringe, 0 for right fringe.
548 */
549
550 static void
551 draw_fringe_bitmap_1 (struct window *w, struct glyph_row *row, int left_p, int overlay, int which)
552 {
553 struct frame *f = XFRAME (WINDOW_FRAME (w));
554 struct draw_fringe_bitmap_params p;
555 struct fringe_bitmap *fb;
556 int period;
557 int face_id = DEFAULT_FACE_ID;
558
559 p.cursor_p = 0;
560 p.overlay_p = (overlay & 1) == 1;
561 p.cursor_p = (overlay & 2) == 2;
562
563 if (which != NO_FRINGE_BITMAP)
564 {
565 }
566 else if (left_p)
567 {
568 which = row->left_fringe_bitmap;
569 face_id = row->left_fringe_face_id;
570 }
571 else
572 {
573 which = row->right_fringe_bitmap;
574 face_id = row->right_fringe_face_id;
575 }
576
577 if (face_id == DEFAULT_FACE_ID)
578 {
579 Lisp_Object face;
580
581 if ((face = fringe_faces[which], NILP (face))
582 || (face_id = lookup_derived_face (f, face, FRINGE_FACE_ID, 0),
583 face_id < 0))
584 face_id = FRINGE_FACE_ID;
585 }
586
587 fb = fringe_bitmaps[which];
588 if (fb == NULL)
589 fb = &standard_bitmaps[which < MAX_STANDARD_FRINGE_BITMAPS
590 ? which : UNDEF_FRINGE_BITMAP];
591
592 period = fb->period;
593
594 /* Convert row to frame coordinates. */
595 p.y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
596
597 p.which = which;
598 p.bits = fb->bits;
599 p.wd = fb->width;
600
601 p.h = fb->height;
602 p.dh = (period > 0 ? (p.y % period) : 0);
603 p.h -= p.dh;
604 /* Clip bitmap if too high. */
605 if (p.h > row->height)
606 p.h = row->height;
607
608 p.face = FACE_FROM_ID (f, face_id);
609
610 if (p.face == NULL)
611 {
612 /* This could happen after clearing face cache.
613 But it shouldn't happen anymore. ++kfs */
614 return;
615 }
616
617 PREPARE_FACE_FOR_DISPLAY (f, p.face);
618
619 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
620 the fringe. */
621 p.bx = -1;
622 if (left_p)
623 {
624 int wd = WINDOW_LEFT_FRINGE_WIDTH (w);
625 int x = window_box_left (w, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
626 ? LEFT_MARGIN_AREA
627 : TEXT_AREA));
628 if (p.wd > wd)
629 p.wd = wd;
630 p.x = x - p.wd - (wd - p.wd) / 2;
631
632 if (p.wd < wd || row->height > p.h)
633 {
634 /* If W has a vertical border to its left, don't draw over it. */
635 wd -= ((!WINDOW_LEFTMOST_P (w)
636 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
637 ? 1 : 0);
638 p.bx = x - wd;
639 p.nx = wd;
640 }
641 }
642 else
643 {
644 int x = window_box_right (w,
645 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
646 ? RIGHT_MARGIN_AREA
647 : TEXT_AREA));
648 int wd = WINDOW_RIGHT_FRINGE_WIDTH (w);
649 if (p.wd > wd)
650 p.wd = wd;
651 p.x = x + (wd - p.wd) / 2;
652 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
653 the fringe. */
654 if (p.wd < wd || row->height > p.h)
655 {
656 p.bx = x;
657 p.nx = wd;
658 }
659 }
660
661 if (p.bx >= 0)
662 {
663 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
664
665 p.by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, row->y));
666 p.ny = row->visible_height;
667 }
668
669 /* Adjust y to the offset in the row to start drawing the bitmap. */
670 switch (fb->align)
671 {
672 case ALIGN_BITMAP_CENTER:
673 p.y += (row->height - p.h) / 2;
674 break;
675 case ALIGN_BITMAP_BOTTOM:
676 p.h = fb->height;
677 p.y += (row->visible_height - p.h);
678 break;
679 case ALIGN_BITMAP_TOP:
680 break;
681 }
682
683 FRAME_RIF (f)->draw_fringe_bitmap (w, row, &p);
684 }
685
686 static int
687 get_logical_cursor_bitmap (struct window *w, Lisp_Object cursor)
688 {
689 Lisp_Object cmap, bm = Qnil;
690
691 if ((cmap = XBUFFER (w->buffer)->fringe_cursor_alist), !NILP (cmap))
692 {
693 bm = Fassq (cursor, cmap);
694 if (CONSP (bm))
695 {
696 if ((bm = XCDR (bm)), NILP (bm))
697 return NO_FRINGE_BITMAP;
698 return lookup_fringe_bitmap (bm);
699 }
700 }
701 if (EQ (cmap, buffer_defaults.fringe_cursor_alist))
702 return NO_FRINGE_BITMAP;
703 bm = Fassq (cursor, buffer_defaults.fringe_cursor_alist);
704 if (!CONSP (bm) || ((bm = XCDR (bm)), NILP (bm)))
705 return NO_FRINGE_BITMAP;
706 return lookup_fringe_bitmap (bm);
707 }
708
709 static int
710 get_logical_fringe_bitmap (struct window *w, Lisp_Object bitmap, int right_p, int partial_p)
711 {
712 Lisp_Object cmap, bm1 = Qnil, bm2 = Qnil, bm;
713 int ln1 = 0, ln2 = 0;
714 int ix1 = right_p;
715 int ix2 = ix1 + (partial_p ? 2 : 0);
716
717 /* Lookup in buffer-local fringe-indicator-alist before global alist.
718
719 Elements are:
720 BITMAP -- use for all
721 (L R) -- use for left right (whether partial or not)
722 (L R PL PR) -- use for left right partial-left partial-right
723 If any value in local binding is not present or t, use global value.
724
725 If partial, lookup partial bitmap in default value if not found here.
726 If not partial, or no partial spec is present, use non-partial bitmap. */
727
728 if ((cmap = XBUFFER (w->buffer)->fringe_indicator_alist), !NILP (cmap))
729 {
730 bm1 = Fassq (bitmap, cmap);
731 if (CONSP (bm1))
732 {
733 if ((bm1 = XCDR (bm1)), NILP (bm1))
734 return NO_FRINGE_BITMAP;
735 if (CONSP (bm1))
736 {
737 ln1 = XINT (Flength (bm1));
738 if (partial_p)
739 {
740 if (ln1 > ix2)
741 {
742 bm = Fnth (make_number (ix2), bm1);
743 if (!EQ (bm, Qt))
744 goto found;
745 }
746 }
747 else
748 {
749 if (ln1 > ix1)
750 {
751 bm = Fnth (make_number (ix1), bm1);
752 if (!EQ (bm, Qt))
753 goto found;
754 }
755 }
756 }
757 else if ((bm = bm1, !EQ (bm, Qt)))
758 goto found;
759 }
760 }
761
762 if (!EQ (cmap, buffer_defaults.fringe_indicator_alist)
763 && !NILP (buffer_defaults.fringe_indicator_alist))
764 {
765 bm2 = Fassq (bitmap, buffer_defaults.fringe_indicator_alist);
766 if (CONSP (bm2))
767 {
768 if ((bm2 = XCDR (bm2)), !NILP (bm2))
769 {
770 if (CONSP (bm2))
771 {
772 ln2 = XINT (Flength (bm2));
773 if (partial_p)
774 {
775 if (ln2 > ix2)
776 {
777 bm = Fnth (make_number (ix2), bm2);
778 if (!EQ (bm, Qt))
779 goto found;
780 }
781 }
782 }
783 }
784 }
785 }
786
787 if (ln1 > ix1)
788 {
789 bm = Fnth (make_number (ix1), bm1);
790 if (!EQ (bm, Qt))
791 goto found;
792 }
793
794 if (ln2 > ix1)
795 {
796 bm = Fnth (make_number (ix1), bm2);
797 if (!EQ (bm, Qt))
798 goto found;
799 return NO_FRINGE_BITMAP;
800 }
801 else if ((bm = bm2, NILP (bm)))
802 return NO_FRINGE_BITMAP;
803
804 found:
805 return lookup_fringe_bitmap (bm);
806 }
807
808
809 void
810 draw_fringe_bitmap (struct window *w, struct glyph_row *row, int left_p)
811 {
812 int overlay = 0;
813
814 if (left_p == row->reversed_p && row->cursor_in_fringe_p)
815 {
816 Lisp_Object cursor = Qnil;
817
818 switch (w->phys_cursor_type)
819 {
820 case HOLLOW_BOX_CURSOR:
821 if (row->visible_height >= STANDARD_BITMAP_HEIGHT (hollow_rectangle_bits))
822 cursor = Qhollow;
823 else
824 cursor = Qhollow_small;
825 break;
826 case FILLED_BOX_CURSOR:
827 cursor = Qbox;
828 break;
829 case BAR_CURSOR:
830 cursor = Qbar;
831 break;
832 case HBAR_CURSOR:
833 cursor = Qhbar;
834 break;
835 case NO_CURSOR:
836 default:
837 w->phys_cursor_on_p = 0;
838 row->cursor_in_fringe_p = 0;
839 break;
840 }
841 if (!NILP (cursor))
842 {
843 int bm = get_logical_cursor_bitmap (w, cursor);
844 if (bm != NO_FRINGE_BITMAP)
845 {
846 draw_fringe_bitmap_1 (w, row, left_p, 2, bm);
847 overlay = EQ (cursor, Qbox) ? 3 : 1;
848 }
849 }
850 }
851
852 draw_fringe_bitmap_1 (w, row, left_p, overlay, NO_FRINGE_BITMAP);
853
854 if (left_p && row->overlay_arrow_bitmap != NO_FRINGE_BITMAP)
855 draw_fringe_bitmap_1 (w, row, 1, 1, row->overlay_arrow_bitmap);
856 }
857
858
859 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
860 function with input blocked. */
861
862 void
863 draw_row_fringe_bitmaps (struct window *w, struct glyph_row *row)
864 {
865 xassert (interrupt_input_blocked);
866
867 /* If row is completely invisible, because of vscrolling, we
868 don't have to draw anything. */
869 if (row->visible_height <= 0)
870 return;
871
872 if (WINDOW_LEFT_FRINGE_WIDTH (w) != 0)
873 draw_fringe_bitmap (w, row, 1);
874
875 if (WINDOW_RIGHT_FRINGE_WIDTH (w) != 0)
876 draw_fringe_bitmap (w, row, 0);
877 }
878
879 /* Draw the fringes of window W. Only fringes for rows marked for
880 update in redraw_fringe_bitmaps_p are drawn.
881
882 Return >0 if left or right fringe was redrawn in any way.
883
884 If NO_FRINGE is non-zero, also return >0 if either fringe has zero width.
885
886 A return value >0 indicates that the vertical line between windows
887 needs update (as it may be drawn in the fringe).
888 */
889
890 int
891 draw_window_fringes (struct window *w, int no_fringe)
892 {
893 struct glyph_row *row;
894 int yb = window_text_bottom_y (w);
895 int nrows = w->current_matrix->nrows;
896 int y = 0, rn;
897 int updated = 0;
898
899 if (w->pseudo_window_p)
900 return 0;
901
902 /* Must draw line if no fringe */
903 if (no_fringe
904 && (WINDOW_LEFT_FRINGE_WIDTH (w) == 0
905 || WINDOW_RIGHT_FRINGE_WIDTH (w) == 0))
906 updated++;
907
908 for (y = 0, rn = 0, row = w->current_matrix->rows;
909 y < yb && rn < nrows;
910 y += row->height, ++row, ++rn)
911 {
912 if (!row->redraw_fringe_bitmaps_p)
913 continue;
914 draw_row_fringe_bitmaps (w, row);
915 row->redraw_fringe_bitmaps_p = 0;
916 updated++;
917 }
918
919 return updated;
920 }
921
922
923 /* Recalculate the bitmaps to show in the fringes of window W.
924 Only mark rows with modified bitmaps for update in redraw_fringe_bitmaps_p.
925
926 If KEEP_CURRENT_P is 0, update current_matrix too. */
927
928 int
929 update_window_fringes (struct window *w, int keep_current_p)
930 {
931 struct glyph_row *row, *cur = 0;
932 int yb = window_text_bottom_y (w);
933 int rn, nrows = w->current_matrix->nrows;
934 int y;
935 int redraw_p = 0;
936 Lisp_Object boundary_top = Qnil, boundary_bot = Qnil;
937 Lisp_Object arrow_top = Qnil, arrow_bot = Qnil;
938 Lisp_Object empty_pos;
939 Lisp_Object ind = Qnil;
940 #define MAX_BITMAP_CACHE (8*4)
941 int bitmap_cache[MAX_BITMAP_CACHE];
942
943 if (w->pseudo_window_p)
944 return 0;
945
946 if (!MINI_WINDOW_P (w)
947 && (ind = XBUFFER (w->buffer)->indicate_buffer_boundaries, !NILP (ind)))
948 {
949 if (EQ (ind, Qleft) || EQ (ind, Qright))
950 boundary_top = boundary_bot = arrow_top = arrow_bot = ind;
951 else if (CONSP (ind) && CONSP (XCAR (ind)))
952 {
953 Lisp_Object pos;
954 if (pos = Fassq (Qt, ind), !NILP (pos))
955 boundary_top = boundary_bot = arrow_top = arrow_bot = XCDR (pos);
956 if (pos = Fassq (Qtop, ind), !NILP (pos))
957 boundary_top = XCDR (pos);
958 if (pos = Fassq (Qbottom, ind), !NILP (pos))
959 boundary_bot = XCDR (pos);
960 if (pos = Fassq (Qup, ind), !NILP (pos))
961 arrow_top = XCDR (pos);
962 if (pos = Fassq (Qdown, ind), !NILP (pos))
963 arrow_bot = XCDR (pos);
964 }
965 else
966 /* Anything else means boundary on left and no arrows. */
967 boundary_top = boundary_bot = Qleft;
968 }
969
970 if (!NILP (ind))
971 {
972 int done_top = 0, done_bot = 0;
973
974 for (y = 0, rn = 0;
975 y < yb && rn < nrows;
976 y += row->height, ++rn)
977 {
978 unsigned indicate_bob_p, indicate_top_line_p;
979 unsigned indicate_eob_p, indicate_bottom_line_p;
980
981 row = w->desired_matrix->rows + rn;
982 if (!row->enabled_p)
983 row = w->current_matrix->rows + rn;
984
985 indicate_bob_p = row->indicate_bob_p;
986 indicate_top_line_p = row->indicate_top_line_p;
987 indicate_eob_p = row->indicate_eob_p;
988 indicate_bottom_line_p = row->indicate_bottom_line_p;
989
990 row->indicate_bob_p = row->indicate_top_line_p = 0;
991 row->indicate_eob_p = row->indicate_bottom_line_p = 0;
992
993 if (!row->mode_line_p)
994 {
995 if (!done_top)
996 {
997 if (MATRIX_ROW_START_CHARPOS (row) <= BUF_BEGV (XBUFFER (w->buffer))
998 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w, row))
999 row->indicate_bob_p = !NILP (boundary_top);
1000 else
1001 row->indicate_top_line_p = !NILP (arrow_top);
1002 done_top = 1;
1003 }
1004
1005 if (!done_bot)
1006 {
1007 if (MATRIX_ROW_END_CHARPOS (row) >= BUF_ZV (XBUFFER (w->buffer))
1008 && !MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row))
1009 row->indicate_eob_p = !NILP (boundary_bot), done_bot = 1;
1010 else if (y + row->height >= yb)
1011 row->indicate_bottom_line_p = !NILP (arrow_bot), done_bot = 1;
1012 }
1013 }
1014
1015 if (indicate_bob_p != row->indicate_bob_p
1016 || indicate_top_line_p != row->indicate_top_line_p
1017 || indicate_eob_p != row->indicate_eob_p
1018 || indicate_bottom_line_p != row->indicate_bottom_line_p)
1019 row->redraw_fringe_bitmaps_p = 1;
1020 }
1021 }
1022
1023 empty_pos = XBUFFER (w->buffer)->indicate_empty_lines;
1024 if (!NILP (empty_pos) && !EQ (empty_pos, Qright))
1025 empty_pos = WINDOW_LEFT_FRINGE_WIDTH (w) == 0 ? Qright : Qleft;
1026
1027 for (y = 0; y < MAX_BITMAP_CACHE; y++)
1028 bitmap_cache[y] = -1;
1029
1030 #define LEFT_FRINGE(cache, which, partial_p) \
1031 (bitmap_cache[cache*4+partial_p] >= 0 \
1032 ? bitmap_cache[cache*4+partial_p] \
1033 : (bitmap_cache[cache*4+partial_p] = \
1034 get_logical_fringe_bitmap (w, which, 0, partial_p)))
1035
1036 #define RIGHT_FRINGE(cache, which, partial_p) \
1037 (bitmap_cache[cache*4+2+partial_p] >= 0 \
1038 ? bitmap_cache[cache*4+2+partial_p] \
1039 : (bitmap_cache[cache*4+2+partial_p] = \
1040 get_logical_fringe_bitmap (w, which, 1, partial_p)))
1041
1042
1043 for (y = 0, rn = 0;
1044 y < yb && rn < nrows;
1045 y += row->height, rn++)
1046 {
1047 int left, right;
1048 unsigned left_face_id, right_face_id;
1049
1050 row = w->desired_matrix->rows + rn;
1051 cur = w->current_matrix->rows + rn;
1052 if (!row->enabled_p)
1053 row = cur;
1054
1055 left_face_id = right_face_id = DEFAULT_FACE_ID;
1056
1057 /* Decide which bitmap to draw in the left fringe. */
1058 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
1059 left = NO_FRINGE_BITMAP;
1060 else if (row->left_user_fringe_bitmap != NO_FRINGE_BITMAP)
1061 {
1062 left = row->left_user_fringe_bitmap;
1063 left_face_id = row->left_user_fringe_face_id;
1064 }
1065 else if ((!row->reversed_p && row->truncated_on_left_p)
1066 || (row->reversed_p && row->truncated_on_right_p))
1067 left = LEFT_FRINGE(0, Qtruncation, 0);
1068 else if (row->indicate_bob_p && EQ (boundary_top, Qleft))
1069 left = ((row->indicate_eob_p && EQ (boundary_bot, Qleft))
1070 ? LEFT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1071 : LEFT_FRINGE (2, Qtop, 0));
1072 else if (row->indicate_eob_p && EQ (boundary_bot, Qleft))
1073 left = LEFT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1074 else if ((!row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row))
1075 || (row->reversed_p && row->continued_p))
1076 left = LEFT_FRINGE (4, Qcontinuation, 0);
1077 else if (row->indicate_empty_line_p && EQ (empty_pos, Qleft))
1078 left = LEFT_FRINGE (5, Qempty_line, 0);
1079 else if (row->indicate_top_line_p && EQ (arrow_top, Qleft))
1080 left = LEFT_FRINGE (6, Qup, 0);
1081 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qleft))
1082 left = LEFT_FRINGE (7, Qdown, 0);
1083 else
1084 left = NO_FRINGE_BITMAP;
1085
1086 /* Decide which bitmap to draw in the right fringe. */
1087 if (WINDOW_RIGHT_FRINGE_WIDTH (w) == 0)
1088 right = NO_FRINGE_BITMAP;
1089 else if (row->right_user_fringe_bitmap != NO_FRINGE_BITMAP)
1090 {
1091 right = row->right_user_fringe_bitmap;
1092 right_face_id = row->right_user_fringe_face_id;
1093 }
1094 else if ((!row->reversed_p && row->truncated_on_right_p)
1095 || (row->reversed_p && row->truncated_on_left_p))
1096 right = RIGHT_FRINGE (0, Qtruncation, 0);
1097 else if (row->indicate_bob_p && EQ (boundary_top, Qright))
1098 right = ((row->indicate_eob_p && EQ (boundary_bot, Qright))
1099 ? RIGHT_FRINGE (1, Qtop_bottom, row->ends_at_zv_p)
1100 : RIGHT_FRINGE (2, Qtop, 0));
1101 else if (row->indicate_eob_p && EQ (boundary_bot, Qright))
1102 right = RIGHT_FRINGE (3, Qbottom, row->ends_at_zv_p);
1103 else if ((!row->reversed_p && row->continued_p)
1104 || (row->reversed_p && MATRIX_ROW_CONTINUATION_LINE_P (row)))
1105 right = RIGHT_FRINGE (4, Qcontinuation, 0);
1106 else if (row->indicate_top_line_p && EQ (arrow_top, Qright))
1107 right = RIGHT_FRINGE (6, Qup, 0);
1108 else if (row->indicate_bottom_line_p && EQ (arrow_bot, Qright))
1109 right = RIGHT_FRINGE (7, Qdown, 0);
1110 else if (row->indicate_empty_line_p && EQ (empty_pos, Qright))
1111 right = RIGHT_FRINGE (5, Qempty_line, 0);
1112 else
1113 right = NO_FRINGE_BITMAP;
1114
1115 if (row->y != cur->y
1116 || row->visible_height != cur->visible_height
1117 || row->ends_at_zv_p != cur->ends_at_zv_p
1118 || left != cur->left_fringe_bitmap
1119 || right != cur->right_fringe_bitmap
1120 || left_face_id != cur->left_fringe_face_id
1121 || right_face_id != cur->right_fringe_face_id
1122 || cur->redraw_fringe_bitmaps_p)
1123 {
1124 redraw_p = row->redraw_fringe_bitmaps_p = 1;
1125 if (!keep_current_p)
1126 {
1127 cur->redraw_fringe_bitmaps_p = 1;
1128 cur->left_fringe_bitmap = left;
1129 cur->right_fringe_bitmap = right;
1130 cur->left_fringe_face_id = left_face_id;
1131 cur->right_fringe_face_id = right_face_id;
1132 }
1133 }
1134
1135 if (row->overlay_arrow_bitmap < 0)
1136 row->overlay_arrow_bitmap = get_logical_fringe_bitmap (w, Qoverlay_arrow, 0, 0);
1137
1138 if (row->overlay_arrow_bitmap != cur->overlay_arrow_bitmap)
1139 {
1140 redraw_p = row->redraw_fringe_bitmaps_p = cur->redraw_fringe_bitmaps_p = 1;
1141 cur->overlay_arrow_bitmap = row->overlay_arrow_bitmap;
1142 }
1143
1144 row->left_fringe_bitmap = left;
1145 row->right_fringe_bitmap = right;
1146 row->left_fringe_face_id = left_face_id;
1147 row->right_fringe_face_id = right_face_id;
1148
1149 if (rn > 0 && row->redraw_fringe_bitmaps_p)
1150 row[-1].redraw_fringe_bitmaps_p = cur[-1].redraw_fringe_bitmaps_p = 1;
1151 }
1152
1153 return redraw_p && !keep_current_p;
1154 }
1155
1156
1157 /* Compute actual fringe widths for frame F.
1158
1159 If REDRAW is 1, redraw F if the fringe settings was actually
1160 modified and F is visible.
1161
1162 Since the combined left and right fringe must occupy an integral
1163 number of columns, we may need to add some pixels to each fringe.
1164 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
1165 but a negative width value is taken literally (after negating it).
1166
1167 We never make the fringes narrower than specified.
1168 */
1169
1170 void
1171 compute_fringe_widths (struct frame *f, int redraw)
1172 {
1173 int o_left = FRAME_LEFT_FRINGE_WIDTH (f);
1174 int o_right = FRAME_RIGHT_FRINGE_WIDTH (f);
1175 int o_cols = FRAME_FRINGE_COLS (f);
1176
1177 Lisp_Object left_fringe = Fassq (Qleft_fringe, f->param_alist);
1178 Lisp_Object right_fringe = Fassq (Qright_fringe, f->param_alist);
1179 int left_fringe_width, right_fringe_width;
1180
1181 if (!NILP (left_fringe))
1182 left_fringe = Fcdr (left_fringe);
1183 if (!NILP (right_fringe))
1184 right_fringe = Fcdr (right_fringe);
1185
1186 left_fringe_width = ((NILP (left_fringe) || !INTEGERP (left_fringe)) ? 8 :
1187 XINT (left_fringe));
1188 right_fringe_width = ((NILP (right_fringe) || !INTEGERP (right_fringe)) ? 8 :
1189 XINT (right_fringe));
1190
1191 if (left_fringe_width || right_fringe_width)
1192 {
1193 int left_wid = left_fringe_width >= 0 ? left_fringe_width : -left_fringe_width;
1194 int right_wid = right_fringe_width >= 0 ? right_fringe_width : -right_fringe_width;
1195 int conf_wid = left_wid + right_wid;
1196 int font_wid = FRAME_COLUMN_WIDTH (f);
1197 int cols = (left_wid + right_wid + font_wid-1) / font_wid;
1198 int real_wid = cols * font_wid;
1199 if (left_wid && right_wid)
1200 {
1201 if (left_fringe_width < 0)
1202 {
1203 /* Left fringe width is fixed, adjust right fringe if necessary */
1204 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid;
1205 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid - left_wid;
1206 }
1207 else if (right_fringe_width < 0)
1208 {
1209 /* Right fringe width is fixed, adjust left fringe if necessary */
1210 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid - right_wid;
1211 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid;
1212 }
1213 else
1214 {
1215 /* Adjust both fringes with an equal amount.
1216 Note that we are doing integer arithmetic here, so don't
1217 lose a pixel if the total width is an odd number. */
1218 int fill = real_wid - conf_wid;
1219 FRAME_LEFT_FRINGE_WIDTH (f) = left_wid + fill/2;
1220 FRAME_RIGHT_FRINGE_WIDTH (f) = right_wid + fill - fill/2;
1221 }
1222 }
1223 else if (left_fringe_width)
1224 {
1225 FRAME_LEFT_FRINGE_WIDTH (f) = real_wid;
1226 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1227 }
1228 else
1229 {
1230 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1231 FRAME_RIGHT_FRINGE_WIDTH (f) = real_wid;
1232 }
1233 FRAME_FRINGE_COLS (f) = cols;
1234 }
1235 else
1236 {
1237 FRAME_LEFT_FRINGE_WIDTH (f) = 0;
1238 FRAME_RIGHT_FRINGE_WIDTH (f) = 0;
1239 FRAME_FRINGE_COLS (f) = 0;
1240 }
1241
1242 if (redraw && FRAME_VISIBLE_P (f))
1243 if (o_left != FRAME_LEFT_FRINGE_WIDTH (f) ||
1244 o_right != FRAME_RIGHT_FRINGE_WIDTH (f) ||
1245 o_cols != FRAME_FRINGE_COLS (f))
1246 redraw_frame (f);
1247 }
1248
1249
1250 /* Free resources used by a user-defined bitmap. */
1251
1252 void
1253 destroy_fringe_bitmap (int n)
1254 {
1255 struct fringe_bitmap **fbp;
1256
1257 fringe_faces[n] = Qnil;
1258
1259 fbp = &fringe_bitmaps[n];
1260 if (*fbp && (*fbp)->dynamic)
1261 {
1262 /* XXX Is SELECTED_FRAME OK here? */
1263 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1264 if (rif && rif->destroy_fringe_bitmap)
1265 rif->destroy_fringe_bitmap (n);
1266 xfree (*fbp);
1267 *fbp = NULL;
1268 }
1269
1270 while (max_used_fringe_bitmap > MAX_STANDARD_FRINGE_BITMAPS
1271 && fringe_bitmaps[max_used_fringe_bitmap - 1] == NULL)
1272 max_used_fringe_bitmap--;
1273 }
1274
1275
1276 DEFUN ("destroy-fringe-bitmap", Fdestroy_fringe_bitmap, Sdestroy_fringe_bitmap,
1277 1, 1, 0,
1278 doc: /* Destroy fringe bitmap BITMAP.
1279 If BITMAP overrides a standard fringe bitmap, the original bitmap is restored. */)
1280 (bitmap)
1281 Lisp_Object bitmap;
1282 {
1283 int n;
1284
1285 CHECK_SYMBOL (bitmap);
1286 n = lookup_fringe_bitmap (bitmap);
1287 if (!n)
1288 return Qnil;
1289
1290 destroy_fringe_bitmap (n);
1291
1292 if (n >= MAX_STANDARD_FRINGE_BITMAPS)
1293 {
1294 Vfringe_bitmaps = Fdelq (bitmap, Vfringe_bitmaps);
1295 /* It would be better to remove the fringe property. */
1296 Fput (bitmap, Qfringe, Qnil);
1297 }
1298
1299 return Qnil;
1300 }
1301
1302
1303 /* Initialize bitmap bit.
1304
1305 On X, we bit-swap the built-in bitmaps and reduce bitmap
1306 from short to char array if width is <= 8 bits.
1307
1308 On MAC with big-endian CPU, we need to byte-swap each short.
1309
1310 On W32 and MAC (little endian), there's no need to do this.
1311 */
1312
1313 #if defined (HAVE_X_WINDOWS)
1314 static const unsigned char swap_nibble[16] = {
1315 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
1316 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
1317 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
1318 0x3, 0xb, 0x7, 0xf}; /* 0011 1011 0111 1111 */
1319 #endif /* HAVE_X_WINDOWS */
1320
1321 void
1322 init_fringe_bitmap (int which, struct fringe_bitmap *fb, int once_p)
1323 {
1324 if (once_p || fb->dynamic)
1325 {
1326 #if defined (HAVE_X_WINDOWS)
1327 unsigned short *bits = fb->bits;
1328 int j;
1329
1330 if (fb->width <= 8)
1331 {
1332 unsigned char *cbits = (unsigned char *)fb->bits;
1333 for (j = 0; j < fb->height; j++)
1334 {
1335 unsigned short b = *bits++;
1336 unsigned char c;
1337 c = (unsigned char)((swap_nibble[b & 0xf] << 4)
1338 | (swap_nibble[(b>>4) & 0xf]));
1339 *cbits++ = (c >> (8 - fb->width));
1340 }
1341 }
1342 else
1343 {
1344 for (j = 0; j < fb->height; j++)
1345 {
1346 unsigned short b = *bits;
1347 b = (unsigned short)((swap_nibble[b & 0xf] << 12)
1348 | (swap_nibble[(b>>4) & 0xf] << 8)
1349 | (swap_nibble[(b>>8) & 0xf] << 4)
1350 | (swap_nibble[(b>>12) & 0xf]));
1351 b >>= (16 - fb->width);
1352 #ifdef WORDS_BIG_ENDIAN
1353 b = ((b >> 8) | (b << 8));
1354 #endif
1355 *bits++ = b;
1356 }
1357 }
1358 #endif /* HAVE_X_WINDOWS */
1359
1360 }
1361
1362 if (!once_p)
1363 {
1364 /* XXX Is SELECTED_FRAME OK here? */
1365 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1366
1367 destroy_fringe_bitmap (which);
1368
1369 if (rif && rif->define_fringe_bitmap)
1370 rif->define_fringe_bitmap (which, fb->bits, fb->height, fb->width);
1371
1372 fringe_bitmaps[which] = fb;
1373 if (which >= max_used_fringe_bitmap)
1374 max_used_fringe_bitmap = which + 1;
1375 }
1376 }
1377
1378
1379 DEFUN ("define-fringe-bitmap", Fdefine_fringe_bitmap, Sdefine_fringe_bitmap,
1380 2, 5, 0,
1381 doc: /* Define fringe bitmap BITMAP from BITS of size HEIGHT x WIDTH.
1382 BITMAP is a symbol identifying the new fringe bitmap.
1383 BITS is either a string or a vector of integers.
1384 HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
1385 WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
1386 Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
1387 indicating the positioning of the bitmap relative to the rows where it
1388 is used; the default is to center the bitmap. Fifth arg may also be a
1389 list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap
1390 should be repeated.
1391 If BITMAP already exists, the existing definition is replaced. */)
1392 (bitmap, bits, height, width, align)
1393 Lisp_Object bitmap, bits, height, width, align;
1394 {
1395 int n, h, i, j;
1396 unsigned short *b;
1397 struct fringe_bitmap fb, *xfb;
1398 int fill1 = 0, fill2 = 0;
1399
1400 CHECK_SYMBOL (bitmap);
1401
1402 if (STRINGP (bits))
1403 h = SCHARS (bits);
1404 else if (VECTORP (bits))
1405 h = XVECTOR (bits)->size;
1406 else
1407 wrong_type_argument (Qsequencep, bits);
1408
1409 if (NILP (height))
1410 fb.height = h;
1411 else
1412 {
1413 CHECK_NUMBER (height);
1414 fb.height = min (XINT (height), 255);
1415 if (fb.height > h)
1416 {
1417 fill1 = (fb.height - h) / 2;
1418 fill2 = fb.height - h - fill1;
1419 }
1420 }
1421
1422 if (NILP (width))
1423 fb.width = 8;
1424 else
1425 {
1426 CHECK_NUMBER (width);
1427 fb.width = min (XINT (width), 255);
1428 }
1429
1430 fb.period = 0;
1431 fb.align = ALIGN_BITMAP_CENTER;
1432
1433 if (CONSP (align))
1434 {
1435 Lisp_Object period = XCDR (align);
1436 if (CONSP (period))
1437 {
1438 period = XCAR (period);
1439 if (!NILP (period))
1440 {
1441 fb.period = fb.height;
1442 fb.height = 255;
1443 }
1444 }
1445 align = XCAR (align);
1446 }
1447 if (EQ (align, Qtop))
1448 fb.align = ALIGN_BITMAP_TOP;
1449 else if (EQ (align, Qbottom))
1450 fb.align = ALIGN_BITMAP_BOTTOM;
1451 else if (!NILP (align) && !EQ (align, Qcenter))
1452 error ("Bad align argument");
1453
1454 n = lookup_fringe_bitmap (bitmap);
1455 if (!n)
1456 {
1457 if (max_used_fringe_bitmap < max_fringe_bitmaps)
1458 n = max_used_fringe_bitmap++;
1459 else
1460 {
1461 for (n = MAX_STANDARD_FRINGE_BITMAPS;
1462 n < max_fringe_bitmaps;
1463 n++)
1464 if (fringe_bitmaps[n] == NULL)
1465 break;
1466
1467 if (n == max_fringe_bitmaps)
1468 {
1469 if ((max_fringe_bitmaps + 20) > MAX_FRINGE_BITMAPS)
1470 error ("No free fringe bitmap slots");
1471
1472 i = max_fringe_bitmaps;
1473 max_fringe_bitmaps += 20;
1474 fringe_bitmaps
1475 = ((struct fringe_bitmap **)
1476 xrealloc (fringe_bitmaps, max_fringe_bitmaps * sizeof (struct fringe_bitmap *)));
1477 fringe_faces
1478 = (Lisp_Object *) xrealloc (fringe_faces, max_fringe_bitmaps * sizeof (Lisp_Object));
1479
1480 for (; i < max_fringe_bitmaps; i++)
1481 {
1482 fringe_bitmaps[i] = NULL;
1483 fringe_faces[i] = Qnil;
1484 }
1485 }
1486 }
1487
1488 Vfringe_bitmaps = Fcons (bitmap, Vfringe_bitmaps);
1489 Fput (bitmap, Qfringe, make_number (n));
1490 }
1491
1492 fb.dynamic = 1;
1493
1494 xfb = (struct fringe_bitmap *) xmalloc (sizeof fb
1495 + fb.height * BYTES_PER_BITMAP_ROW);
1496 fb.bits = b = (unsigned short *) (xfb + 1);
1497 bzero (b, fb.height);
1498
1499 j = 0;
1500 while (j < fb.height)
1501 {
1502 for (i = 0; i < fill1 && j < fb.height; i++)
1503 b[j++] = 0;
1504 for (i = 0; i < h && j < fb.height; i++)
1505 {
1506 Lisp_Object elt = Faref (bits, make_number (i));
1507 b[j++] = NUMBERP (elt) ? XINT (elt) : 0;
1508 }
1509 for (i = 0; i < fill2 && j < fb.height; i++)
1510 b[j++] = 0;
1511 }
1512
1513 *xfb = fb;
1514
1515 init_fringe_bitmap (n, xfb, 0);
1516
1517 return bitmap;
1518 }
1519
1520 DEFUN ("set-fringe-bitmap-face", Fset_fringe_bitmap_face, Sset_fringe_bitmap_face,
1521 1, 2, 0,
1522 doc: /* Set face for fringe bitmap BITMAP to FACE.
1523 If FACE is nil, reset face to default fringe face. */)
1524 (bitmap, face)
1525 Lisp_Object bitmap, face;
1526 {
1527 int n;
1528 int face_id;
1529
1530 CHECK_SYMBOL (bitmap);
1531 n = lookup_fringe_bitmap (bitmap);
1532 if (!n)
1533 error ("Undefined fringe bitmap");
1534
1535 if (!NILP (face))
1536 {
1537 face_id = lookup_derived_face (SELECTED_FRAME (), face,
1538 FRINGE_FACE_ID, 1);
1539 if (face_id < 0)
1540 error ("No such face");
1541 }
1542
1543 fringe_faces[n] = face;
1544
1545 return Qnil;
1546 }
1547
1548 DEFUN ("fringe-bitmaps-at-pos", Ffringe_bitmaps_at_pos, Sfringe_bitmaps_at_pos,
1549 0, 2, 0,
1550 doc: /* Return fringe bitmaps of row containing position POS in window WINDOW.
1551 If WINDOW is nil, use selected window. If POS is nil, use value of point
1552 in that window. Return value is a list (LEFT RIGHT OV), where LEFT
1553 is the symbol for the bitmap in the left fringe (or nil if no bitmap),
1554 RIGHT is similar for the right fringe, and OV is non-nil if there is an
1555 overlay arrow in the left fringe.
1556 Return nil if POS is not visible in WINDOW. */)
1557 (pos, window)
1558 Lisp_Object pos, window;
1559 {
1560 struct window *w;
1561 struct glyph_row *row;
1562 int textpos;
1563
1564 if (NILP (window))
1565 window = selected_window;
1566 CHECK_WINDOW (window);
1567 w = XWINDOW (window);
1568
1569 if (!NILP (pos))
1570 {
1571 CHECK_NUMBER_COERCE_MARKER (pos);
1572 textpos = XINT (pos);
1573 }
1574 else if (w == XWINDOW (selected_window))
1575 textpos = PT;
1576 else
1577 textpos = XMARKER (w->pointm)->charpos;
1578
1579 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1580 row = row_containing_pos (w, textpos, row, NULL, 0);
1581 if (row)
1582 return list3 (get_fringe_bitmap_name (row->left_fringe_bitmap),
1583 get_fringe_bitmap_name (row->right_fringe_bitmap),
1584 (row->overlay_arrow_bitmap == 0 ? Qnil
1585 : row->overlay_arrow_bitmap < 0 ? Qt
1586 : get_fringe_bitmap_name (row->overlay_arrow_bitmap)));
1587 else
1588 return Qnil;
1589 }
1590
1591
1592 /***********************************************************************
1593 Initialization
1594 ***********************************************************************/
1595
1596 void
1597 syms_of_fringe (void)
1598 {
1599 Qtruncation = intern_c_string ("truncation");
1600 staticpro (&Qtruncation);
1601 Qcontinuation = intern_c_string ("continuation");
1602 staticpro (&Qcontinuation);
1603 Qoverlay_arrow = intern_c_string ("overlay-arrow");
1604 staticpro (&Qoverlay_arrow);
1605 Qempty_line = intern_c_string ("empty-line");
1606 staticpro (&Qempty_line);
1607 Qtop_bottom = intern_c_string ("top-bottom");
1608 staticpro (&Qtop_bottom);
1609 Qhollow_small = intern_c_string ("hollow-small");
1610 staticpro (&Qhollow_small);
1611
1612 defsubr (&Sdestroy_fringe_bitmap);
1613 defsubr (&Sdefine_fringe_bitmap);
1614 defsubr (&Sfringe_bitmaps_at_pos);
1615 defsubr (&Sset_fringe_bitmap_face);
1616
1617 DEFVAR_LISP ("overflow-newline-into-fringe", &Voverflow_newline_into_fringe,
1618 doc: /* *Non-nil means that newline may flow into the right fringe.
1619 This means that display lines which are exactly as wide as the window
1620 (not counting the final newline) will only occupy one screen line, by
1621 showing (or hiding) the final newline in the right fringe; when point
1622 is at the final newline, the cursor is shown in the right fringe.
1623 If nil, also continue lines which are exactly as wide as the window. */);
1624 Voverflow_newline_into_fringe = Qt;
1625
1626 DEFVAR_LISP ("fringe-bitmaps", &Vfringe_bitmaps,
1627 doc: /* List of fringe bitmap symbols. */);
1628 Vfringe_bitmaps = Qnil;
1629 }
1630
1631 /* Garbage collection hook */
1632
1633 void
1634 mark_fringe_data (void)
1635 {
1636 int i;
1637
1638 for (i = 0; i < max_fringe_bitmaps; i++)
1639 if (!NILP (fringe_faces[i]))
1640 mark_object (fringe_faces[i]);
1641 }
1642
1643 /* Initialize this module when Emacs starts. */
1644
1645 void
1646 init_fringe_once (void)
1647 {
1648 int bt;
1649
1650 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1651 init_fringe_bitmap(bt, &standard_bitmaps[bt], 1);
1652 }
1653
1654 void
1655 init_fringe (void)
1656 {
1657 int i;
1658
1659 max_fringe_bitmaps = MAX_STANDARD_FRINGE_BITMAPS + 20;
1660
1661 fringe_bitmaps
1662 = (struct fringe_bitmap **) xmalloc (max_fringe_bitmaps * sizeof (struct fringe_bitmap *));
1663 fringe_faces
1664 = (Lisp_Object *) xmalloc (max_fringe_bitmaps * sizeof (Lisp_Object));
1665
1666 for (i = 0; i < max_fringe_bitmaps; i++)
1667 {
1668 fringe_bitmaps[i] = NULL;
1669 fringe_faces[i] = Qnil;
1670 }
1671 }
1672
1673 #ifdef HAVE_NTGUI
1674
1675 void
1676 w32_init_fringe (struct redisplay_interface *rif)
1677 {
1678 int bt;
1679
1680 if (!rif)
1681 return;
1682
1683 for (bt = NO_FRINGE_BITMAP + 1; bt < MAX_STANDARD_FRINGE_BITMAPS; bt++)
1684 {
1685 struct fringe_bitmap *fb = &standard_bitmaps[bt];
1686 rif->define_fringe_bitmap (bt, fb->bits, fb->height, fb->width);
1687 }
1688 }
1689
1690 void
1691 w32_reset_fringes ()
1692 {
1693 /* Destroy row bitmaps. */
1694 int bt;
1695 struct redisplay_interface *rif = FRAME_RIF (SELECTED_FRAME ());
1696
1697 if (!rif)
1698 return;
1699
1700 for (bt = NO_FRINGE_BITMAP + 1; bt < max_used_fringe_bitmap; bt++)
1701 rif->destroy_fringe_bitmap (bt);
1702 }
1703
1704 #endif /* HAVE_NTGUI */
1705
1706 #endif /* HAVE_WINDOW_SYSTEM */
1707
1708 /* arch-tag: 04596920-43eb-473d-b319-82712338162d
1709 (do not change this comment) */