This commit was manufactured by cvs2svn to create branch 'XEmacs-21_4'.
[chise/xemacs-chise.git-] / src / gutter.h
1 /* Define general gutter support.
2    Copyright (C) 1999 Andy Piper.
3
4 This file is part of XEmacs.
5
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
9 later version.
10
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
14 for more details.
15
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.  */
20
21 /* Synched up with: Not in FSF. */
22
23 #ifndef INCLUDED_gutter_h_
24 #define INCLUDED_gutter_h_
25
26 #include "specifier.h"
27
28 #define DEVICE_SUPPORTS_GUTTERS_P(d) HAS_DEVMETH_P (d, output_frame_gutters)
29
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)
36
37 #define DEFAULT_GUTTER_WIDTH            40
38 #define DEFAULT_GUTTER_BORDER_WIDTH     2
39
40 enum gutter_pos
41 {
42   TOP_GUTTER     = 0,
43   BOTTOM_GUTTER  = 1,
44   LEFT_GUTTER    = 2,
45   RIGHT_GUTTER   = 3
46 };
47
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))
51
52 extern Lisp_Object Qgutter;
53
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,
64                              int height);
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);
68 int display_boxes_in_gutter_p (struct frame *f, struct display_box* db,
69                                struct display_glyph_area* dga);
70
71 #define WINDOW_GUTTER_BORDER_WIDTH(w, pos) \
72   (INTP ((w)->gutter_border_width[pos]) ? XINT ((w)->gutter_border_width[pos]) : 0)
73 #define WINDOW_GUTTER_SIZE(w, pos) \
74   (INTP ((w)->gutter_size[pos]) ? XINT ((w)->gutter_size[pos]) : 0)
75 #define WINDOW_GUTTER_SIZE_INTERNAL(w, pos) \
76   (INTP ((w)->real_gutter_size[pos]) ? XINT ((w)->real_gutter_size[pos]) : 0)
77 #define WINDOW_GUTTER_VISIBLE(w, pos) \
78   ((w)->gutter_visible_p[pos])
79 #define WINDOW_GUTTER(w, pos) \
80   ((w)->real_gutter[pos])
81 #define RAW_WINDOW_GUTTER(w, pos) \
82   ((w)->gutter[pos])
83
84 #define WINDOW_REAL_GUTTER_SIZE(w, pos) \
85   (!NILP (WINDOW_GUTTER_VISIBLE (w, pos))               \
86    ? WINDOW_GUTTER_SIZE_INTERNAL (w, pos)       \
87    : 0)
88 #define WINDOW_REAL_GUTTER_VISIBLE(f, pos)      \
89    (WINDOW_REAL_GUTTER_SIZE (f, pos) > 0)
90 #define WINDOW_REAL_GUTTER_BORDER_WIDTH(f, pos) \
91   ((!NILP (WINDOW_GUTTER_VISIBLE (f, pos))              \
92    && WINDOW_GUTTER_SIZE_INTERNAL (f,pos) > 0)  \
93    ? WINDOW_GUTTER_BORDER_WIDTH (f, pos)        \
94    : 0)
95 #define WINDOW_REAL_GUTTER_BOUNDS(f, pos)       \
96    (WINDOW_REAL_GUTTER_SIZE (f,pos) +           \
97     2 * WINDOW_REAL_GUTTER_BORDER_WIDTH (f,pos))
98
99 /* these macros predicate size on position and type of window */
100 #define WINDOW_REAL_TOP_GUTTER_BOUNDS(w)        \
101    WINDOW_REAL_GUTTER_BOUNDS (w,TOP_GUTTER)
102 #define WINDOW_REAL_BOTTOM_GUTTER_BOUNDS(w)     \
103    WINDOW_REAL_GUTTER_BOUNDS (w,BOTTOM_GUTTER)
104 #define WINDOW_REAL_LEFT_GUTTER_BOUNDS(w)       \
105    WINDOW_REAL_GUTTER_BOUNDS (w,LEFT_GUTTER)
106 #define WINDOW_REAL_RIGHT_GUTTER_BOUNDS(w)      \
107    WINDOW_REAL_GUTTER_BOUNDS (w,RIGHT_GUTTER)
108
109 #define FRAME_GUTTER_VISIBLE(f, pos) \
110    WINDOW_REAL_GUTTER_VISIBLE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
111 #define FRAME_GUTTER_SIZE(f, pos) \
112    WINDOW_REAL_GUTTER_SIZE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
113 #define FRAME_GUTTER_BOUNDS(f, pos) \
114    WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
115 #define FRAME_GUTTER_BORDER_WIDTH(f, pos) \
116    WINDOW_REAL_GUTTER_BORDER_WIDTH (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
117
118 #define FRAME_GUTTER(f, pos) \
119 WINDOW_GUTTER (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
120
121 /* these macros predicate size on position and type of window */
122 #define FRAME_TOP_GUTTER_BOUNDS(f) \
123    WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), TOP_GUTTER)
124 #define FRAME_BOTTOM_GUTTER_BOUNDS(f) \
125    WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), BOTTOM_GUTTER)
126 #define FRAME_LEFT_GUTTER_BOUNDS(f) \
127    WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), LEFT_GUTTER)
128 #define FRAME_RIGHT_GUTTER_BOUNDS(f) \
129    WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), RIGHT_GUTTER)
130
131 #endif /* INCLUDED_gutter_h_ */