428
+ − 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
440
+ − 23 #ifndef INCLUDED_gutter_h_
+ − 24 #define INCLUDED_gutter_h_
428
+ − 25
+ − 26 #include "specifier.h"
+ − 27
434
+ − 28 #define DEVICE_SUPPORTS_GUTTERS_P(d) HAS_DEVMETH_P (d, output_frame_gutters)
428
+ − 29
+ − 30 DECLARE_SPECIFIER_TYPE (gutter);
+ − 31 #define XGUTTER_SPECIFIER(x) XSPECIFIER_TYPE (x, gutter)
+ − 32 #define GUTTER_SPECIFIERP(x) SPECIFIER_TYPEP (x, gutter)
+ − 33 #define CHECK_GUTTER_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, gutter)
+ − 34 #define CONCHECK_GUTTER_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, gutter)
+ − 35
+ − 36 #define DEFAULT_GUTTER_WIDTH 40
+ − 37 #define DEFAULT_GUTTER_BORDER_WIDTH 2
+ − 38
+ − 39 enum gutter_pos
+ − 40 {
+ − 41 TOP_GUTTER = 0,
+ − 42 BOTTOM_GUTTER = 1,
+ − 43 LEFT_GUTTER = 2,
+ − 44 RIGHT_GUTTER = 3
+ − 45 };
+ − 46
+ − 47 /* Iterate over all possible gutter positions */
+ − 48 #define GUTTER_POS_LOOP(var) \
826
+ − 49 for (var = (enum gutter_pos) 0; var < 4; var = (enum gutter_pos) (var + 1))
428
+ − 50
+ − 51 extern Lisp_Object Qgutter;
+ − 52
+ − 53 extern Lisp_Object Vgutter_size[4];
+ − 54 extern Lisp_Object Vgutter_border_width[4];
+ − 55 void update_frame_gutters (struct frame *f);
442
+ − 56 void update_frame_gutter_geometry (struct frame *f);
+ − 57 void mark_gutters (struct frame* f);
428
+ − 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,
+ − 63 int height);
+ − 64 void reset_gutter_display_lines (struct frame* f);
442
+ − 65 void gutter_extent_signal_changed_region_maybe (Lisp_Object obj,
665
+ − 66 Charbpos start, Charbpos end);
446
+ − 67 int display_boxes_in_gutter_p (struct frame *f, struct display_box* db,
+ − 68 struct display_glyph_area* dga);
428
+ − 69
+ − 70 #define WINDOW_GUTTER_BORDER_WIDTH(w, pos) \
442
+ − 71 (INTP ((w)->gutter_border_width[pos]) ? XINT ((w)->gutter_border_width[pos]) : 0)
428
+ − 72 #define WINDOW_GUTTER_SIZE(w, pos) \
442
+ − 73 (INTP ((w)->gutter_size[pos]) ? XINT ((w)->gutter_size[pos]) : 0)
428
+ − 74 #define WINDOW_GUTTER_SIZE_INTERNAL(w, pos) \
442
+ − 75 (INTP ((w)->real_gutter_size[pos]) ? XINT ((w)->real_gutter_size[pos]) : 0)
428
+ − 76 #define WINDOW_GUTTER_VISIBLE(w, pos) \
442
+ − 77 ((w)->gutter_visible_p[pos])
428
+ − 78 #define WINDOW_GUTTER(w, pos) \
442
+ − 79 ((w)->real_gutter[pos])
+ − 80 #define RAW_WINDOW_GUTTER(w, pos) \
+ − 81 ((w)->gutter[pos])
428
+ − 82
+ − 83 #define WINDOW_REAL_GUTTER_SIZE(w, pos) \
+ − 84 (!NILP (WINDOW_GUTTER_VISIBLE (w, pos)) \
+ − 85 ? WINDOW_GUTTER_SIZE_INTERNAL (w, pos) \
+ − 86 : 0)
+ − 87 #define WINDOW_REAL_GUTTER_VISIBLE(f, pos) \
+ − 88 (WINDOW_REAL_GUTTER_SIZE (f, pos) > 0)
+ − 89 #define WINDOW_REAL_GUTTER_BORDER_WIDTH(f, pos) \
+ − 90 ((!NILP (WINDOW_GUTTER_VISIBLE (f, pos)) \
+ − 91 && WINDOW_GUTTER_SIZE_INTERNAL (f,pos) > 0) \
+ − 92 ? WINDOW_GUTTER_BORDER_WIDTH (f, pos) \
+ − 93 : 0)
+ − 94 #define WINDOW_REAL_GUTTER_BOUNDS(f, pos) \
+ − 95 (WINDOW_REAL_GUTTER_SIZE (f,pos) + \
+ − 96 2 * WINDOW_REAL_GUTTER_BORDER_WIDTH (f,pos))
+ − 97
+ − 98 /* these macros predicate size on position and type of window */
+ − 99 #define WINDOW_REAL_TOP_GUTTER_BOUNDS(w) \
442
+ − 100 WINDOW_REAL_GUTTER_BOUNDS (w,TOP_GUTTER)
428
+ − 101 #define WINDOW_REAL_BOTTOM_GUTTER_BOUNDS(w) \
442
+ − 102 WINDOW_REAL_GUTTER_BOUNDS (w,BOTTOM_GUTTER)
428
+ − 103 #define WINDOW_REAL_LEFT_GUTTER_BOUNDS(w) \
442
+ − 104 WINDOW_REAL_GUTTER_BOUNDS (w,LEFT_GUTTER)
428
+ − 105 #define WINDOW_REAL_RIGHT_GUTTER_BOUNDS(w) \
442
+ − 106 WINDOW_REAL_GUTTER_BOUNDS (w,RIGHT_GUTTER)
428
+ − 107
+ − 108 #define FRAME_GUTTER_VISIBLE(f, pos) \
+ − 109 WINDOW_REAL_GUTTER_VISIBLE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
+ − 110 #define FRAME_GUTTER_SIZE(f, pos) \
+ − 111 WINDOW_REAL_GUTTER_SIZE (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
+ − 112 #define FRAME_GUTTER_BOUNDS(f, pos) \
+ − 113 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
+ − 114 #define FRAME_GUTTER_BORDER_WIDTH(f, pos) \
+ − 115 WINDOW_REAL_GUTTER_BORDER_WIDTH (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
+ − 116
+ − 117 #define FRAME_GUTTER(f, pos) \
+ − 118 WINDOW_GUTTER (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
+ − 119
+ − 120 /* these macros predicate size on position and type of window */
+ − 121 #define FRAME_TOP_GUTTER_BOUNDS(f) \
+ − 122 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), TOP_GUTTER)
+ − 123 #define FRAME_BOTTOM_GUTTER_BOUNDS(f) \
+ − 124 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), BOTTOM_GUTTER)
+ − 125 #define FRAME_LEFT_GUTTER_BOUNDS(f) \
+ − 126 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), LEFT_GUTTER)
+ − 127 #define FRAME_RIGHT_GUTTER_BOUNDS(f) \
+ − 128 WINDOW_REAL_GUTTER_BOUNDS (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), RIGHT_GUTTER)
+ − 129
440
+ − 130 #endif /* INCLUDED_gutter_h_ */
