annotate src/gutter.h @ 422:95016f13131a r21-2-19

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