cgit.sxemacs.org Git - sxemacs/blob - src/ui/gutter.h

   1 /* Define general gutter support.
   2    Copyright (C) 1999 Andy Piper.
   3
   4 This file is part of SXEmacs
   5
   6 SXEmacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 SXEmacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  18
  19
  20 /* Synched up with: Not in FSF. */
  21
  22 #ifndef INCLUDED_gutter_h_
  23 #define INCLUDED_gutter_h_
  24
  25 #include "specifier.h"
  26
  27 #define DEVICE_SUPPORTS_GUTTERS_P(d) HAS_DEVMETH_P (d, output_frame_gutters)
  28
  29 DECLARE_SPECIFIER_TYPE(gutter);
  30 #define XGUTTER_SPECIFIER(x) XSPECIFIER_TYPE (x, gutter)
  31 #define XSETGUTTER_SPECIFIER(x, p) XSETSPECIFIER_TYPE (x, p, 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         TOP_GUTTER = 0,
  41         BOTTOM_GUTTER = 1,
  42         LEFT_GUTTER = 2,
  43         RIGHT_GUTTER = 3
  44 };
  45
  46 /* Iterate over all possible gutter positions */
  47 #define GUTTER_POS_LOOP(var) \
  48 for (var = (enum gutter_pos) 0; var < 4; var = (enum gutter_pos) (var + 1))
  49
  50 extern Lisp_Object Qgutter;
  51
  52 extern Lisp_Object Vgutter_size[4];
  53 extern Lisp_Object Vgutter_border_width[4];
  54 void update_frame_gutters(struct frame *f);
  55 void update_frame_gutter_geometry(struct frame *f);
  56 void mark_gutters(struct frame *f);
  57 void init_frame_gutters(struct frame *f);
  58 void init_device_gutters(struct device *d);
  59 void init_global_gutters(struct device *d);
  60 void free_frame_gutters(struct frame *f);
  61 void redraw_exposed_gutters(struct frame *f, int x, int y, int width,
  62                             int height);
  63 void reset_gutter_display_lines(struct frame *f);
  64 void gutter_extent_signal_changed_region_maybe(Lisp_Object obj,
  65                                                Bufpos start, Bufpos end);
  66 int display_boxes_in_gutter_p(struct frame *f, struct display_box *db,
  67                               struct display_glyph_area *dga);
  68
  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) \
  80   ((w)->gutter[pos])
  81
  82 #define WINDOW_REAL_GUTTER_SIZE(w, pos) \
  83   (!NILP (WINDOW_GUTTER_VISIBLE (w, pos))               \
  84    ? WINDOW_GUTTER_SIZE_INTERNAL (w, pos)       \
  85    : 0)
  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)        \
  92    : 0)
  93 #define WINDOW_REAL_GUTTER_BOUNDS(f, pos)       \
  94    (WINDOW_REAL_GUTTER_SIZE (f,pos) +           \
  95     2 * WINDOW_REAL_GUTTER_BORDER_WIDTH (f,pos))
  96
  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)
 106
 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)
 115
 116 #define FRAME_GUTTER(f, pos) \
 117 WINDOW_GUTTER (XWINDOW (FRAME_LAST_NONMINIBUF_WINDOW (f)), pos)
 118
 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)
 128
 129 #endif                          /* INCLUDED_gutter_h_ */