annotate src/gutter.h @ 400:a86b2b5e0111 r21-2-30

Import from CVS: tag r21-2-30
author cvs
date Mon, 13 Aug 2007 11:14:34 +0200
parents 74fd4e045ea6
children 2f8bb876ab1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
1 /* Define general gutter support.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2 Copyright (C) 1999 Andy Piper.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
3
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4 This file is part of XEmacs.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
5
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 later version.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
10
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
14 for more details.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
15
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
20
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21 /* Synched up with: Not in FSF. */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
22
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23 #ifndef INCLUDED_gutter_h_
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24 #define INCLUDED_gutter_h_
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26 #include "specifier.h"
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
28 #define DEVICE_SUPPORTS_GUTTERS_P(d) HAS_DEVMETH_P (d, output_frame_gutters)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
29
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
30 DECLARE_SPECIFIER_TYPE (gutter);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
31 #define XGUTTER_SPECIFIER(x) XSPECIFIER_TYPE (x, gutter)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
32 #define XSETGUTTER_SPECIFIER(x, p) XSETSPECIFIER_TYPE (x, p, gutter)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
33 #define GUTTER_SPECIFIERP(x) SPECIFIER_TYPEP (x, gutter)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
34 #define CHECK_GUTTER_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, gutter)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
35 #define CONCHECK_GUTTER_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, gutter)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
36
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
37 #define DEFAULT_GUTTER_WIDTH 40
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
38 #define DEFAULT_GUTTER_BORDER_WIDTH 2
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
39
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
40 enum gutter_pos
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
41 {
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
42 TOP_GUTTER = 0,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
43 BOTTOM_GUTTER = 1,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
44 LEFT_GUTTER = 2,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
45 RIGHT_GUTTER = 3
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
46 };
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
47
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
48 /* Iterate over all possible gutter positions */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
49 #define GUTTER_POS_LOOP(var) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
50 for (var = (enum gutter_pos) 0; var < 4; var = (enum gutter_pos) (var + 1))
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
51
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
52 extern Lisp_Object Qgutter;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
53
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
54 extern Lisp_Object Vgutter_size[4];
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
55 extern Lisp_Object Vgutter_border_width[4];
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
56 void update_frame_gutters (struct frame *f);
400
a86b2b5e0111 Import from CVS: tag r21-2-30
cvs
parents: 398
diff changeset
57 void mark_gutters (struct frame* f);
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
58 void init_frame_gutters (struct frame *f);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
59 void init_device_gutters (struct device *d);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
60 void init_global_gutters (struct device *d);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
61 void free_frame_gutters (struct frame *f);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
62 void redraw_exposed_gutters (struct frame *f, int x, int y, int width,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
63 int height);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
64 void reset_gutter_display_lines (struct frame* f);
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
65
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
66 #define WINDOW_GUTTER_BORDER_WIDTH(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
67 (NILP ((w)->gutter_border_width[pos]) ? 0 : XINT ((w)->gutter_border_width[pos]))
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
68 #define WINDOW_GUTTER_SIZE(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
69 (NILP ((w)->gutter_size[pos]) ? 0 : XINT ((w)->gutter_size[pos]))
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
70 #define WINDOW_GUTTER_SIZE_INTERNAL(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
71 (NILP ((w)->real_gutter_size[pos]) ? 0 : XINT ((w)->real_gutter_size[pos]))
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
72 #define WINDOW_GUTTER_VISIBLE(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
73 ((w)->gutter_visible_p[pos])
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
74 #define WINDOW_GUTTER(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
75 ((w)->gutter[pos])
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
76
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
77 #define WINDOW_REAL_GUTTER_SIZE(w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
78 (!NILP (WINDOW_GUTTER_VISIBLE (w, pos)) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
79 ? WINDOW_GUTTER_SIZE_INTERNAL (w, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
80 : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
81 #define WINDOW_REAL_GUTTER_VISIBLE(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
82 (WINDOW_REAL_GUTTER_SIZE (f, pos) > 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
83 #define WINDOW_REAL_GUTTER_BORDER_WIDTH(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
84 ((!NILP (WINDOW_GUTTER_VISIBLE (f, pos)) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
85 && WINDOW_GUTTER_SIZE_INTERNAL (f,pos) > 0) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
86 ? WINDOW_GUTTER_BORDER_WIDTH (f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
87 : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
88 #define WINDOW_REAL_GUTTER_BOUNDS(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
89 (WINDOW_REAL_GUTTER_SIZE (f,pos) + \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
90 2 * WINDOW_REAL_GUTTER_BORDER_WIDTH (f,pos))
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
91
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
92 /* these macros predicate size on position and type of window */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
93 #define WINDOW_REAL_TOP_GUTTER_BOUNDS(w) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
94 ((!MINI_WINDOW_P (w) && window_is_highest (w)) ? \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
95 WINDOW_REAL_GUTTER_BOUNDS (w,TOP_GUTTER) : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
96 #define WINDOW_REAL_BOTTOM_GUTTER_BOUNDS(w) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
97 ((!MINI_WINDOW_P (w) && window_is_lowest (w)) ? \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
98 WINDOW_REAL_GUTTER_BOUNDS (w,BOTTOM_GUTTER) : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
99 #define WINDOW_REAL_LEFT_GUTTER_BOUNDS(w) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
100 ((!MINI_WINDOW_P (w) && window_is_leftmost (w)) ? \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
101 WINDOW_REAL_GUTTER_BOUNDS (w,LEFT_GUTTER) : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
102 #define WINDOW_REAL_RIGHT_GUTTER_BOUNDS(w) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
103 ((!MINI_WINDOW_P (w) && window_is_rightmost (w)) ? \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
104 WINDOW_REAL_GUTTER_BOUNDS (w,RIGHT_GUTTER) : 0)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
105
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
106 #define FRAME_GUTTER_VISIBLE(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
107 WINDOW_REAL_GUTTER_VISIBLE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
108 #define FRAME_GUTTER_SIZE(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
109 WINDOW_REAL_GUTTER_SIZE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
110 #define FRAME_GUTTER_BOUNDS(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
111 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
112 #define FRAME_GUTTER_BORDER_WIDTH(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
113 WINDOW_REAL_GUTTER_BORDER_WIDTH (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
114
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
115 #define FRAME_GUTTER(f, pos) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
116 WINDOW_GUTTER (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
117
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
118 /* these macros predicate size on position and type of window */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
119 #define FRAME_TOP_GUTTER_BOUNDS(f) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
120 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), TOP_GUTTER)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
121 #define FRAME_BOTTOM_GUTTER_BOUNDS(f) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
122 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), BOTTOM_GUTTER)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
123 #define FRAME_LEFT_GUTTER_BOUNDS(f) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
124 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), LEFT_GUTTER)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
125 #define FRAME_RIGHT_GUTTER_BOUNDS(f) \
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
126 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), RIGHT_GUTTER)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
127
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
128 #endif /* INCLUDED_gutter_h_ */