*** empty log message ***
[dana/urxvt.git] / src / rxvtlib.h.in
1 #ifndef _RXVTLIB_H_             /* include once only */
2 #define _RXVTLIB_H_
3
4 #include <cstdio>
5 #include <cctype>
6 #include <cerrno>
7 @include_stdarg_h@
8 @include_stdlib_h@
9 @include_stdint_h@
10 #include <sys/types.h>
11 @include_unistd_h@
12 @include_string_h@
13 @include_fcntl_h@
14 @include_util_h@
15 @include_assert_h@
16 @include_sys_ioctl_h@
17 @include_sys_time_h@
18 @include_time_h@
19 @include_sys_select_h@
20 @include_sys_strredir_h@
21
22 #include <sys/wait.h>
23 #include <sys/stat.h>
24
25 #include <cwchar>
26
27 #include "ptytty.h"
28
29 extern "C" {
30 #include <X11/Intrinsic.h>      /* Xlib, Xutil, Xresource, Xfuncproto */
31 }
32
33 /*
34  * If we haven't pulled in typedef's like  int16_t  then do them ourself
35  * type of (normal and unsigned) basic sizes
36  */
37 @rxvt_int16_typedef@
38 @rxvt_uint16_typedef@
39 @rxvt_int32_typedef@
40 @rxvt_uint32_typedef@
41
42 /* whatever normal size corresponds to a integer pointer */
43 @rxvt_intp_define@
44 /* whatever normal size corresponds to a unsigned integer pointer */
45 @rxvt_u_intp_define@
46
47 struct rxvt_fontset;
48 struct rxvt_color;
49 struct rxvt_vars;               /* defined later on */
50 struct rxvt_term;
51 struct rxvt_display;
52 struct rxvt_im;
53 struct rxvt_drawable;
54
55 typedef struct rxvt_term *rxvt_t;
56
57 extern rxvt_t rxvt_current_term;
58
59 # define SET_R(r) rxvt_current_term = (r)
60 # define GET_R rxvt_current_term
61
62 #define scrollbar_visible()    scrollBar.state
63 #define menubar_visible()      menuBar.state
64
65 typedef struct {
66   int32_t         row;
67   int32_t         col;
68 } row_col_t;
69
70 #if UNICODE_3
71 typedef uint32_t text_t;
72 #else
73 typedef uint16_t text_t; // saves lots of memory
74 #endif
75 typedef uint32_t rend_t;
76
77 /*
78  * TermWin elements limits
79  *  width     : 1 <= width
80  *  height    : 1 <= height
81  *  ncol      : 1 <= ncol       <= MAX(int16_t)
82  *  nrow      : 1 <= nrow       <= MAX(int16_t)
83  *  saveLines : 0 <= saveLines  <= MAX(int16_t)
84  *  nscrolled : 0 <= nscrolled  <= saveLines
85  *  view_start: 0 <= view_start <= nscrolled
86  */
87
88 typedef struct {
89   unsigned int   width;         /* window width                    [pixels] */
90   unsigned int   height;        /* window height                   [pixels] */
91   unsigned int   fwidth;        /* font width                      [pixels] */
92   unsigned int   fheight;       /* font height                     [pixels] */
93   unsigned int   fweight, fslant;
94   unsigned int   fbase;         /* font ascent (baseline)          [pixels] */
95   unsigned int   ncol;          /* window columns              [characters] */
96   unsigned int   nrow;          /* window rows                 [characters] */
97   unsigned int   focus;         /* window has focus                         */
98   unsigned int   mapped;        /* window state mapped?                     */
99   unsigned int   int_bwidth;    /* internal border width                    */
100   unsigned int   ext_bwidth;    /* external border width                    */
101   unsigned int   lineSpace;     /* number of extra pixels between rows      */
102   unsigned int   saveLines;     /* number of lines that fit in scrollback   */
103   unsigned int   nscrolled;     /* number of line actually scrolled         */
104   unsigned int   view_start;    /* scrollback view starts here              */
105   Window         parent[6];     /* parent identifiers - we're parent[0]     */
106   Window         vt;            /* vt100 window                             */
107   GC             gc;            /* GC for drawing                           */
108   Pixmap         pixmap;
109   rxvt_drawable *drawable;
110   rxvt_fontset  *fontset[4];
111 } TermWin_t;
112
113 /*
114  * screen accounting:
115  * screen_t elements
116  *   text:      Contains all text information including the scrollback buffer.
117  *              Each line is length TermWin.ncol
118  *   tlen:      The length of the line or -1 for wrapped lines.
119  *   rend:      Contains rendition information: font, bold, colour, etc.
120  * * Note: Each line for both text and rend are only allocated on demand, and
121  *         text[x] is allocated <=> rend[x] is allocated  for all x.
122  *   row:       Cursor row position                   : 0 <= row < TermWin.nrow
123  *   col:       Cursor column position                : 0 <= col < TermWin.ncol
124  *   tscroll:   Scrolling region top row inclusive    : 0 <= row < TermWin.nrow
125  *   bscroll:   Scrolling region bottom row inclusive : 0 <= row < TermWin.nrow
126  *
127  * selection_t elements
128  *   clicks:    1, 2 or 3 clicks - 4 indicates a special condition of 1 where
129  *              nothing is selected
130  *   beg:       row/column of beginning of selection  : never past mark
131  *   mark:      row/column of initial click           : never past end
132  *   end:       row/column of one character past end of selection
133  * * Note: -TermWin.nscrolled <= beg.row <= mark.row <= end.row < TermWin.nrow
134  * * Note: col == -1 ==> we're left of screen
135  *
136  * Layout of text/rend information in the screen_t text/rend structures:
137  *   Rows [0] ... [TermWin.saveLines - 1]
138  *     scrollback region : we're only here if TermWin.view_start != 0
139  *   Rows [TermWin.saveLines] ... [TermWin.saveLines + TermWin.nrow - 1]
140  *     normal `unscrolled' screen region
141  */
142 typedef struct {
143   int16_t        *tlen; /* length of each text line                  */
144   text_t        **text; /* _all_ the text                            */
145   rend_t        **rend; /* rendition, uses RS_ flags                 */
146   row_col_t       cur;  /* cursor position on the screen             */
147   unsigned int    tscroll;      /* top of settable scroll region             */
148   unsigned int    bscroll;      /* bottom of settable scroll region          */
149   unsigned int    charset;      /* character set number [0..3]               */
150   unsigned int    flags;        /* see below                                 */
151   row_col_t       s_cur;        /* saved cursor position                     */
152   unsigned int    s_charset;    /* saved character set number [0..3]         */
153   char            s_charset_char;
154   rend_t          s_rstyle;     /* saved rendition style                     */
155 } screen_t;
156
157 enum selection_op_t {
158   SELECTION_CLEAR = 0,  /* nothing selected                          */
159   SELECTION_INIT,       /* marked a point                            */
160   SELECTION_BEGIN,      /* started a selection                       */
161   SELECTION_CONT,       /* continued selection                       */
162   SELECTION_DONE        /* selection put in CUT_BUFFER0              */
163 };
164
165 typedef struct {
166   wchar_t        *text;       /* selected text                             */
167   unsigned int    len;        /* length of selected text                   */
168   unsigned int    screen;     /* screen being used                         */
169   unsigned int    clicks;     /* number of clicks                          */
170   selection_op_t  op;         /* current operation                         */
171   row_col_t       beg;        /* beginning of selection   <= mark          */
172   row_col_t       mark;       /* point of initial click   <= end           */
173   row_col_t       end;        /* one character past end point              */
174 } selection_t;
175
176 /* ------------------------------------------------------------------------- */
177
178 /* screen_t flags */
179 #define Screen_Relative         (1<<0)  /* relative origin mode flag         */
180 #define Screen_VisibleCursor    (1<<1)  /* cursor visible?                   */
181 #define Screen_Autowrap         (1<<2)  /* auto-wrap flag                    */
182 #define Screen_Insert           (1<<3)  /* insert mode (vs. overstrike)      */
183 #define Screen_WrapNext         (1<<4)  /* need to wrap for next char?       */
184 #define Screen_DefaultFlags     (Screen_VisibleCursor|Screen_Autowrap)
185
186 /* rxvt_vars.options */
187 #define Opt_console             (1UL<<0)
188 #define Opt_loginShell          (1UL<<1)
189 #define Opt_iconic              (1UL<<2)
190 #define Opt_visualBell          (1UL<<3)
191 #define Opt_mapAlert            (1UL<<4)
192 #define Opt_reverseVideo        (1UL<<5)
193 #define Opt_utmpInhibit         (1UL<<6)
194 #define Opt_scrollBar           (1UL<<7)
195 #define Opt_scrollBar_right     (1UL<<8)
196 #define Opt_scrollBar_floating  (1UL<<9)
197 #define Opt_meta8               (1UL<<10)
198 #define Opt_scrollTtyOutput     (1UL<<11)
199 #define Opt_scrollTtyKeypress   (1UL<<12)
200 #define Opt_transparent         (1UL<<13)
201 #define Opt_transparent_all     (1UL<<14)
202 #define Opt_tripleclickwords    (1UL<<15)
203 #define Opt_scrollWithBuffer    (1UL<<16)
204 #define Opt_jumpScroll          (1UL<<17)
205 #define Opt_mouseWheelScrollPage (1UL<<18)
206 #define Opt_pointerBlank        (1UL<<19)
207 #define Opt_cursorBlink         (1UL<<20)
208 #define Opt_secondaryScreen     (1UL<<21)
209 #define Opt_secondaryScroll     (1UL<<22)
210 #if ENABLE_FRILLS
211 # define Opt_insecure           (1UL<<23) // insecure esc sequences
212 # define Opt_borderLess         (1UL<<24) // mem borderless hints
213 #else
214 # define Opt_insecure           0
215 # define Opt_borderLess         0
216 #endif
217 /* place holder used for parsing command-line options */
218 #define Opt_Reverse             (1UL<<30)
219 #define Opt_Boolean             (1UL<<31)
220
221 #define DEFAULT_OPTIONS         (Opt_scrollBar | Opt_scrollTtyOutput | \
222                                  Opt_jumpScroll | Opt_secondaryScreen)
223
224 /* ------------------------------------------------------------------------- */
225
226 typedef struct {
227   short           state;
228   Window          win;
229   struct rxvt_drawable *drawable;
230 } menuBar_t;
231
232 typedef struct {
233   char            state;        /* scrollbar state                          */
234   char            init;         /* scrollbar has been initialised           */
235   unsigned int    beg;          /* slider sub-window begin height           */
236   unsigned int    end;          /* slider sub-window end height             */
237   unsigned int    top;          /* slider top position                      */
238   unsigned int    bot;          /* slider bottom position                   */
239   unsigned int    style;        /* style: rxvt, xterm, next                 */
240   unsigned int    width;        /* scrollbar width                          */
241   Window          win;
242   int             (rxvt_term::*update)(int, int, int, int);
243
244   void setIdle()   { state =  1 ; }
245   void setMotion() { state = 'm'; }
246   void setUp()     { state = 'U'; }
247   void setDn()     { state = 'D'; }
248 } scrollBar_t;
249
250 struct rxvt_vars {
251   TermWin_t       TermWin;
252   scrollBar_t     scrollBar;
253   menuBar_t       menuBar;
254   unsigned long   options;
255   XSizeHints      szHint;
256   rxvt_display   *display;
257   rxvt_color     *pix_colors;
258   rxvt_color     *pix_colors_focused;
259 #ifdef OFF_FOCUS_FADING
260   rxvt_color     *pix_colors_unfocused;
261 #endif
262   short           numpix_colors;
263   Cursor          TermWin_cursor;       /* cursor for vt window */
264   int             sb_shadow;    /* scrollbar shadow width                    */
265   rxvt_ptytty     pty;
266   int             numlock_state;
267   text_t        **drawn_text;   /* text drawn on screen (characters)         */
268   rend_t        **drawn_rend;   /* text drawn on screen (rendition)          */
269   text_t        **buf_text;
270   rend_t        **buf_rend;
271   char           *tabs;         /* per location: 1 == tab-stop               */
272   screen_t        screen;
273   screen_t        swap;
274   selection_t     selection;
275 };
276
277 void rxvt_init ();
278
279 #endif                          /* _RXVTLIB_H_ */
280