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