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 INCLUDED_gutter_h_
24 #define INCLUDED_gutter_h_
26 #include "specifier.h"
28 #define DEVICE_SUPPORTS_GUTTERS_P(d) HAS_DEVMETH_P (d, output_frame_gutters)
30 DECLARE_SPECIFIER_TYPE (gutter);
31 #define XGUTTER_SPECIFIER(x) XSPECIFIER_TYPE (x, gutter)
32 #define XSETGUTTER_SPECIFIER(x, p) XSETSPECIFIER_TYPE (x, p, gutter)
33 #define GUTTER_SPECIFIERP(x) SPECIFIER_TYPEP (x, gutter)
34 #define CHECK_GUTTER_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, gutter)
35 #define CONCHECK_GUTTER_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, gutter)
37 #define DEFAULT_GUTTER_WIDTH 40
38 #define DEFAULT_GUTTER_BORDER_WIDTH 2
48 /* Iterate over all possible gutter positions */
49 #define GUTTER_POS_LOOP(var) \
50 for (var = (enum gutter_pos) 0; var < 4; var = (enum gutter_pos) (var + 1))
52 extern Lisp_Object Qgutter;
54 extern Lisp_Object Vgutter_size[4];
55 extern Lisp_Object Vgutter_border_width[4];
56 void update_frame_gutters (struct frame *f);
57 void update_frame_gutter_geometry (struct frame *f);
58 void mark_gutters (struct frame* f);
59 void init_frame_gutters (struct frame *f);
60 void init_device_gutters (struct device *d);
61 void init_global_gutters (struct device *d);
62 void free_frame_gutters (struct frame *f);
63 void redraw_exposed_gutters (struct frame *f, int x, int y, int width,
65 void reset_gutter_display_lines (struct frame* f);
66 void gutter_extent_signal_changed_region_maybe (Lisp_Object obj,
67 Bufpos start, Bufpos end);
69 #define WINDOW_GUTTER_BORDER_WIDTH(w, pos) \
70 (INTP ((w)->gutter_border_width[pos]) ? XINT ((w)->gutter_border_width[pos]) : 0)
71 #define WINDOW_GUTTER_SIZE(w, pos) \
72 (INTP ((w)->gutter_size[pos]) ? XINT ((w)->gutter_size[pos]) : 0)
73 #define WINDOW_GUTTER_SIZE_INTERNAL(w, pos) \
74 (INTP ((w)->real_gutter_size[pos]) ? XINT ((w)->real_gutter_size[pos]) : 0)
75 #define WINDOW_GUTTER_VISIBLE(w, pos) \
76 ((w)->gutter_visible_p[pos])
77 #define WINDOW_GUTTER(w, pos) \
78 ((w)->real_gutter[pos])
79 #define RAW_WINDOW_GUTTER(w, pos) \
82 #define WINDOW_REAL_GUTTER_SIZE(w, pos) \
83 (!NILP (WINDOW_GUTTER_VISIBLE (w, pos)) \
84 ? WINDOW_GUTTER_SIZE_INTERNAL (w, pos) \
86 #define WINDOW_REAL_GUTTER_VISIBLE(f, pos) \
87 (WINDOW_REAL_GUTTER_SIZE (f, pos) > 0)
88 #define WINDOW_REAL_GUTTER_BORDER_WIDTH(f, pos) \
89 ((!NILP (WINDOW_GUTTER_VISIBLE (f, pos)) \
90 && WINDOW_GUTTER_SIZE_INTERNAL (f,pos) > 0) \
91 ? WINDOW_GUTTER_BORDER_WIDTH (f, pos) \
93 #define WINDOW_REAL_GUTTER_BOUNDS(f, pos) \
94 (WINDOW_REAL_GUTTER_SIZE (f,pos) + \
95 2 * WINDOW_REAL_GUTTER_BORDER_WIDTH (f,pos))
97 /* these macros predicate size on position and type of window */
98 #define WINDOW_REAL_TOP_GUTTER_BOUNDS(w) \
99 WINDOW_REAL_GUTTER_BOUNDS (w,TOP_GUTTER)
100 #define WINDOW_REAL_BOTTOM_GUTTER_BOUNDS(w) \
101 WINDOW_REAL_GUTTER_BOUNDS (w,BOTTOM_GUTTER)
102 #define WINDOW_REAL_LEFT_GUTTER_BOUNDS(w) \
103 WINDOW_REAL_GUTTER_BOUNDS (w,LEFT_GUTTER)
104 #define WINDOW_REAL_RIGHT_GUTTER_BOUNDS(w) \
105 WINDOW_REAL_GUTTER_BOUNDS (w,RIGHT_GUTTER)
107 #define FRAME_GUTTER_VISIBLE(f, pos) \
108 WINDOW_REAL_GUTTER_VISIBLE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
109 #define FRAME_GUTTER_SIZE(f, pos) \
110 WINDOW_REAL_GUTTER_SIZE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
111 #define FRAME_GUTTER_BOUNDS(f, pos) \
112 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
113 #define FRAME_GUTTER_BORDER_WIDTH(f, pos) \
114 WINDOW_REAL_GUTTER_BORDER_WIDTH (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
116 #define FRAME_GUTTER(f, pos) \
117 WINDOW_GUTTER (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
119 /* these macros predicate size on position and type of window */
120 #define FRAME_TOP_GUTTER_BOUNDS(f) \
121 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), TOP_GUTTER)
122 #define FRAME_BOTTOM_GUTTER_BOUNDS(f) \
123 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), BOTTOM_GUTTER)
124 #define FRAME_LEFT_GUTTER_BOUNDS(f) \
125 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), LEFT_GUTTER)
126 #define FRAME_RIGHT_GUTTER_BOUNDS(f) \
127 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), RIGHT_GUTTER)
129 #endif /* INCLUDED_gutter_h_ */