rxvt-unicode/src/rxvtlib.h.in

#ifndef _RXVTLIB_H_             /* include once only */
#define _RXVTLIB_H_

#include <cstdio>
#include <cctype>
#include <cerrno>
@include_stdarg_h@
@include_stdlib_h@
@include_stdint_h@
#include <sys/types.h>
@include_unistd_h@
@include_string_h@
@include_fcntl_h@
@include_util_h@
@include_assert_h@
@include_sys_ioctl_h@
@include_sys_time_h@
@include_time_h@
@include_sys_select_h@
@include_sys_strredir_h@

#include <sys/wait.h>
#include <sys/stat.h>

#if HAVE_CWCHAR
# include <cwchar>
#elif HAVE_WCHAR_H
# include <wchar.h>
#else
// stdlib.h might provide it
#endif

#include "ptytty.h"

extern "C" {
#include <X11/Intrinsic.h>      /* Xlib, Xutil, Xresource, Xfuncproto */
}

/*
 * If we haven't pulled in typedef's like  int16_t  then do them ourself
 * type of (normal and unsigned) basic sizes
 */
@rxvt_int16_typedef@
@rxvt_uint16_typedef@
@rxvt_int32_typedef@
@rxvt_uint32_typedef@

/* whatever normal size corresponds to a integer pointer */
@rxvt_intp_define@
/* whatever normal size corresponds to a unsigned integer pointer */
@rxvt_u_intp_define@

struct rxvt_fontset;
struct rxvt_color;
struct rxvt_vars;               /* defined later on */
struct rxvt_term;
struct rxvt_display;
struct rxvt_im;
struct rxvt_drawable;

typedef struct rxvt_term *rxvt_t;

extern rxvt_t rxvt_current_term;

#define SET_R(r) rxvt_current_term = (r)
#define GET_R rxvt_current_term

#define scrollbar_visible()    scrollBar.state
#define menubar_visible()      menuBar.state

typedef struct {
  int row;
  int col;
} row_col_t;

#if UNICODE_3
typedef uint32_t text_t;
#else
typedef uint16_t text_t; // saves lots of memory
#endif
typedef uint32_t rend_t;
typedef  int32_t tlen_t;  // was int16_t, but this results in smaller code and memory use
typedef  int32_t tlen_t_; // specifically for use in the line_t structure

struct line_t;

/*
 * terminal limits:
 *
 *  width      : 1 <= width
 *  height     : 1 <= height
 *  ncol       : 1 <= ncol       <= MAX(tlen_t)
 *  nrow       : 1 <= nrow       <= MAX(int)
 *  saveLines  : 0 <= saveLines  <= MAX(int)
 *  total_rows : nrow + saveLines
 *  nsaved     : 0 <= nsaved     <= saveLines
 *  term_start : 0 <= term_start < saveLines
 *  view_start : 0 <= view_start < saveLines
 *
 *          | most coordinates are stored relative to term_start,
 *  ROW_BUF | which is the first line of the terminal screen
 *  |························= row_buf[0]
 *  |························= row_buf[1]
 *  |························= row_buf[2] etc.
 *  |
 *  +------------+···········= term_start - nsaved
 *  | scrollback |                                      
 *  | scrollback +---------+·= term_start - view_start
 *  | scrollback | display |
 *  | scrollback | display |
 *  +------------+·display·+·= term_start
 *  |  terminal  | display |
 *  |  terminal  +---------+
 *  |  terminal  |
 *  |  terminal  |
 *  +------------+···········= term_stat + nrow - 1
 *  |
 *  |
 *  END······················= total_rows
 */

struct TermWin_t {
  int            width;         /* window width                    [pixels] */
  int            height;        /* window height                   [pixels] */
  int            fwidth;        /* font width                      [pixels] */
  int            fheight;       /* font height                     [pixels] */
  int            fbase;         /* font ascent (baseline)          [pixels] */
  int            ncol;          /* window columns              [characters] */
  int            nrow;          /* window rows                 [characters] */
  int            focus;         /* window has focus                         */
  int            mapped;        /* window state mapped?                     */
  int            int_bwidth;    /* internal border width                    */
  int            ext_bwidth;    /* external border width                    */
  int            lineSpace;     /* number of extra pixels between rows      */
  int            saveLines;     /* number of lines that fit in scrollback   */
  int            total_rows;    /* total number of rows in this terminal    */
  int            nsaved;        /* number of rows saved to scrollback       */
  int            term_start;    /* term lines start here                    */
  int            view_start;    /* scrollback view starts here              */
  Window         parent[6];     /* parent identifiers - we're parent[0]     */
  Window         vt;            /* vt100 window                             */
  GC             gc;            /* GC for drawing                           */
  Pixmap         pixmap;
  rxvt_drawable *drawable;
  rxvt_fontset  *fontset[4];
};

/*
 * screen accounting:
 * screen_t elements
 *   row:       Cursor row position                   : 0 <= row < nrow
 *   col:       Cursor column position                : 0 <= col < ncol
 *   tscroll:   Scrolling region top row inclusive    : 0 <= row < nrow
 *   bscroll:   Scrolling region bottom row inclusive : 0 <= row < nrow
 *
 * selection_t elements
 *   clicks:    1, 2 or 3 clicks - 4 indicates a special condition of 1 where
 *              nothing is selected
 *   beg:       row/column of beginning of selection  : never past mark
 *   mark:      row/column of initial click           : never past end
 *   end:       row/column of one character past end of selection
 * * Note: -nsaved <= beg.row <= mark.row <= end.row < nrow
 * * Note: col == -1 ==> we're left of screen
 *
 */
typedef struct {
  row_col_t       cur;          /* cursor position on the screen             */
  int             tscroll;      /* top of settable scroll region             */
  int             bscroll;      /* bottom of settable scroll region          */
  unsigned int    charset;      /* character set number [0..3]               */
  unsigned int    flags;        /* see below                                 */
  row_col_t       s_cur;        /* saved cursor position                     */
  unsigned int    s_charset;    /* saved character set number [0..3]         */
  char            s_charset_char;
  rend_t          s_rstyle;     /* saved rendition style                     */
} screen_t;

enum selection_op_t {
  SELECTION_CLEAR = 0,  /* nothing selected                          */
  SELECTION_INIT,       /* marked a point                            */
  SELECTION_BEGIN,      /* started a selection                       */
  SELECTION_CONT,       /* continued selection                       */
  SELECTION_DONE        /* selection put in CUT_BUFFER0              */
};

typedef struct {
  wchar_t          *text;       /* selected text                             */
  unsigned int      len;        /* length of selected text                   */
  unsigned int      screen;     /* screen being used                         */
  unsigned int      clicks;     /* number of clicks                          */
  selection_op_t    op;         /* current operation                         */
  bool              rect;       /* rectangluar selection?                    */
  row_col_t         beg;        /* beginning of selection   <= mark          */
  row_col_t         mark;       /* point of initial click   <= end           */
  row_col_t         end;        /* one character past end point              */
} selection_t;

/* ------------------------------------------------------------------------- */

/* screen_t flags */
#define Screen_Relative          (1<<0)  /* relative origin mode flag         */
#define Screen_VisibleCursor     (1<<1)  /* cursor visible?                   */
#define Screen_Autowrap          (1<<2)  /* auto-wrap flag                    */
#define Screen_Insert            (1<<3)  /* insert mode (vs. overstrike)      */
#define Screen_WrapNext          (1<<4)  /* need to wrap for next char?       */
#define Screen_DefaultFlags      (Screen_VisibleCursor | Screen_Autowrap)

/* rxvt_vars.options */
#define Opt_console              (1UL<<0)
#define Opt_loginShell           (1UL<<1)
#define Opt_iconic               (1UL<<2)
#define Opt_visualBell           (1UL<<3)
#define Opt_mapAlert             (1UL<<4)
#define Opt_reverseVideo         (1UL<<5)
#define Opt_utmpInhibit          (1UL<<6)
#define Opt_scrollBar            (1UL<<7)
#define Opt_scrollBar_right      (1UL<<8)
#define Opt_scrollBar_floating   (1UL<<9)
#define Opt_meta8                (1UL<<10)
#define Opt_scrollTtyOutput      (1UL<<11)
#define Opt_scrollTtyKeypress    (1UL<<12)
#define Opt_transparent          (1UL<<13)
#define Opt_tripleclickwords     (1UL<<14)
#define Opt_scrollWithBuffer     (1UL<<15)
#define Opt_jumpScroll           (1UL<<16)
#define Opt_mouseWheelScrollPage (1UL<<17)
#define Opt_pointerBlank         (1UL<<18)
#define Opt_cursorBlink          (1UL<<19)
#define Opt_secondaryScreen      (1UL<<20)
#define Opt_secondaryScroll      (1UL<<21)
#define Opt_pastableTabs         (1UL<<22)
#define Opt_cursorUnderline      (1UL<<23)
#if ENABLE_FRILLS
# define Opt_insecure            (1UL<<24) // insecure esc sequences
# define Opt_borderLess          (1UL<<25) // mwm borderless hints
# define Opt_hold                (1UL<<26) // hold window open after exit
# define Opt_skipBuiltinGlyphs   (1UL<<27) // do not use internal glyphs
#else
# define Opt_insecure            0
# define Opt_borderLess          0
# define Opt_hold                0
# define Opt_skipBuiltinGlyphs   0
#endif
#if ENABLE_STYLES
# define Opt_intensityStyles     (1UL<<28) // font styles imply intensity
#else
# define Opt_intensityStyles     0
#endif

#define SET_OPTION(opt)          (options |= (opt))
#define CLR_OPTION(opt)          (options &= ~(opt))
#define OPTION(opt)              (options & (opt))
#define OPTION_R(opt)            (r->options & (opt))
#define DEFAULT_OPTIONS          (Opt_scrollBar | Opt_scrollTtyOutput \
                                  | Opt_jumpScroll | Opt_secondaryScreen \
                                  | Opt_pastableTabs | Opt_intensityStyles)

/* ------------------------------------------------------------------------- */

typedef struct {
  short           state;
  Window          win;
  struct rxvt_drawable *drawable;
} menuBar_t;

typedef struct {
  char            state;        /* scrollbar state                          */
  char            init;         /* scrollbar has been initialised           */
  unsigned int    beg;          /* slider sub-window begin height           */
  unsigned int    end;          /* slider sub-window end height             */
  unsigned int    top;          /* slider top position                      */
  unsigned int    bot;          /* slider bottom position                   */
  unsigned int    style;        /* style: rxvt, xterm, next                 */
  unsigned int    width;        /* scrollbar width                          */
  Window          win;
  int             (rxvt_term::*update)(int, int, int, int);

  void setIdle()   { state =  1 ; }
  void setMotion() { state = 'm'; }
  void setUp()     { state = 'U'; }
  void setDn()     { state = 'D'; }
} scrollBar_t;

struct rxvt_vars : TermWin_t {
  scrollBar_t     scrollBar;
  menuBar_t       menuBar;
  unsigned long   options;
  XSizeHints      szHint;
  rxvt_display   *display;
  rxvt_color     *pix_colors;
  rxvt_color     *pix_colors_focused;
#ifdef OFF_FOCUS_FADING
  rxvt_color     *pix_colors_unfocused;
#endif
  short           numpix_colors;
  Cursor          TermWin_cursor;       /* cursor for vt window */
  int             sb_shadow;    /* scrollbar shadow width                    */
  rxvt_ptytty     pty;
  int             numlock_state;
  line_t         *row_buf;      // all lines, scrollback + terminal, circular
  line_t         *drawn_buf;    // text on screen
  line_t         *temp_buf;     // temporary buffer
  line_t         *swap_buf;     // lines for swap buffer
  char           *tabs;         /* per location: 1 == tab-stop               */
  screen_t        screen;
  screen_t        swap;
  selection_t     selection;
};

void rxvt_init ();

#endif                          /* _RXVTLIB_H_ */

Revision:	1.59
Committed:	Thu Jan 5 21:21:49 2006 UTC (18 years, 4 months ago) by root
Branch:	MAIN
Changes since 1.58:	+3 -25 lines
Log Message:	* empty log message *
#	Content
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	#if HAVE_CWCHAR
26	# include <cwchar>
27	#elif HAVE_WCHAR_H
28	# include <wchar.h>
29	#else
30	// stdlib.h might provide it
31	#endif
32
33	#include "ptytty.h"
34
35	extern "C" {
36	#include <X11/Intrinsic.h> /* Xlib, Xutil, Xresource, Xfuncproto */
37	}
38
39	/*
40	* If we haven't pulled in typedef's like int16_t then do them ourself
41	* type of (normal and unsigned) basic sizes
42	*/
43	@rxvt_int16_typedef@
44	@rxvt_uint16_typedef@
45	@rxvt_int32_typedef@
46	@rxvt_uint32_typedef@
47
48	/* whatever normal size corresponds to a integer pointer */
49	@rxvt_intp_define@
50	/* whatever normal size corresponds to a unsigned integer pointer */
51	@rxvt_u_intp_define@
52
53	struct rxvt_fontset;
54	struct rxvt_color;
55	struct rxvt_vars; /* defined later on */
56	struct rxvt_term;
57	struct rxvt_display;
58	struct rxvt_im;
59	struct rxvt_drawable;
60
61	typedef struct rxvt_term *rxvt_t;
62
63	extern rxvt_t rxvt_current_term;
64
65	#define SET_R(r) rxvt_current_term = (r)
66	#define GET_R rxvt_current_term
67
68	#define scrollbar_visible() scrollBar.state
69	#define menubar_visible() menuBar.state
70
71	typedef struct {
72	int row;
73	int col;
74	} row_col_t;
75
76	#if UNICODE_3
77	typedef uint32_t text_t;
78	#else
79	typedef uint16_t text_t; // saves lots of memory
80	#endif
81	typedef uint32_t rend_t;
82	typedef int32_t tlen_t; // was int16_t, but this results in smaller code and memory use
83	typedef int32_t tlen_t_; // specifically for use in the line_t structure
84
85	struct line_t;
86
87	/*
88	* terminal limits:
89	*
90	* width : 1 <= width
91	* height : 1 <= height
92	* ncol : 1 <= ncol <= MAX(tlen_t)
93	* nrow : 1 <= nrow <= MAX(int)
94	* saveLines : 0 <= saveLines <= MAX(int)
95	* total_rows : nrow + saveLines
96	* nsaved : 0 <= nsaved <= saveLines
97	* term_start : 0 <= term_start < saveLines
98	* view_start : 0 <= view_start < saveLines
99	*
100	* \| most coordinates are stored relative to term_start,
101	* ROW_BUF \| which is the first line of the terminal screen
102	* \|························= row_buf[0]
103	* \|························= row_buf[1]
104	* \|························= row_buf[2] etc.
105	* \|
106	* +------------+···········= term_start - nsaved
107	* \| scrollback \|
108	* \| scrollback +---------+·= term_start - view_start
109	* \| scrollback \| display \|
110	* \| scrollback \| display \|
111	* +------------+·display·+·= term_start
112	* \| terminal \| display \|
113	* \| terminal +---------+
114	* \| terminal \|
115	* \| terminal \|
116	* +------------+···········= term_stat + nrow - 1
117	* \|
118	* \|
119	* END······················= total_rows
120	*/
121
122	struct TermWin_t {
123	int width; /* window width [pixels] */
124	int height; /* window height [pixels] */
125	int fwidth; /* font width [pixels] */
126	int fheight; /* font height [pixels] */
127	int fbase; /* font ascent (baseline) [pixels] */
128	int ncol; /* window columns [characters] */
129	int nrow; /* window rows [characters] */
130	int focus; /* window has focus */
131	int mapped; /* window state mapped? */
132	int int_bwidth; /* internal border width */
133	int ext_bwidth; /* external border width */
134	int lineSpace; /* number of extra pixels between rows */
135	int saveLines; /* number of lines that fit in scrollback */
136	int total_rows; /* total number of rows in this terminal */
137	int nsaved; /* number of rows saved to scrollback */
138	int term_start; /* term lines start here */
139	int view_start; /* scrollback view starts here */
140	Window parent[6]; /* parent identifiers - we're parent[0] */
141	Window vt; /* vt100 window */
142	GC gc; /* GC for drawing */
143	Pixmap pixmap;
144	rxvt_drawable *drawable;
145	rxvt_fontset *fontset[4];
146	};
147
148	/*
149	* screen accounting:
150	* screen_t elements
151	* row: Cursor row position : 0 <= row < nrow
152	* col: Cursor column position : 0 <= col < ncol
153	* tscroll: Scrolling region top row inclusive : 0 <= row < nrow
154	* bscroll: Scrolling region bottom row inclusive : 0 <= row < nrow
155	*
156	* selection_t elements
157	* clicks: 1, 2 or 3 clicks - 4 indicates a special condition of 1 where
158	* nothing is selected
159	* beg: row/column of beginning of selection : never past mark
160	* mark: row/column of initial click : never past end
161	* end: row/column of one character past end of selection
162	* * Note: -nsaved <= beg.row <= mark.row <= end.row < nrow
163	* * Note: col == -1 ==> we're left of screen
164	*
165	*/
166	typedef struct {
167	row_col_t cur; /* cursor position on the screen */
168	int tscroll; /* top of settable scroll region */
169	int bscroll; /* bottom of settable scroll region */
170	unsigned int charset; /* character set number [0..3] */
171	unsigned int flags; /* see below */
172	row_col_t s_cur; /* saved cursor position */
173	unsigned int s_charset; /* saved character set number [0..3] */
174	char s_charset_char;
175	rend_t s_rstyle; /* saved rendition style */
176	} screen_t;
177
178	enum selection_op_t {
179	SELECTION_CLEAR = 0, /* nothing selected */
180	SELECTION_INIT, /* marked a point */
181	SELECTION_BEGIN, /* started a selection */
182	SELECTION_CONT, /* continued selection */
183	SELECTION_DONE /* selection put in CUT_BUFFER0 */
184	};
185
186	typedef struct {
187	wchar_t text; / selected text */
188	unsigned int len; /* length of selected text */
189	unsigned int screen; /* screen being used */
190	unsigned int clicks; /* number of clicks */
191	selection_op_t op; /* current operation */
192	bool rect; /* rectangluar selection? */
193	row_col_t beg; /* beginning of selection <= mark */
194	row_col_t mark; /* point of initial click <= end */
195	row_col_t end; /* one character past end point */
196	} selection_t;
197
198	/* ------------------------------------------------------------------------- */
199
200	/* screen_t flags */
201	#define Screen_Relative (1<<0) /* relative origin mode flag */
202	#define Screen_VisibleCursor (1<<1) /* cursor visible? */
203	#define Screen_Autowrap (1<<2) /* auto-wrap flag */
204	#define Screen_Insert (1<<3) /* insert mode (vs. overstrike) */
205	#define Screen_WrapNext (1<<4) /* need to wrap for next char? */
206	#define Screen_DefaultFlags (Screen_VisibleCursor \| Screen_Autowrap)
207
208	/* rxvt_vars.options */
209	#define Opt_console (1UL<<0)
210	#define Opt_loginShell (1UL<<1)
211	#define Opt_iconic (1UL<<2)
212	#define Opt_visualBell (1UL<<3)
213	#define Opt_mapAlert (1UL<<4)
214	#define Opt_reverseVideo (1UL<<5)
215	#define Opt_utmpInhibit (1UL<<6)
216	#define Opt_scrollBar (1UL<<7)
217	#define Opt_scrollBar_right (1UL<<8)
218	#define Opt_scrollBar_floating (1UL<<9)
219	#define Opt_meta8 (1UL<<10)
220	#define Opt_scrollTtyOutput (1UL<<11)
221	#define Opt_scrollTtyKeypress (1UL<<12)
222	#define Opt_transparent (1UL<<13)
223	#define Opt_tripleclickwords (1UL<<14)
224	#define Opt_scrollWithBuffer (1UL<<15)
225	#define Opt_jumpScroll (1UL<<16)
226	#define Opt_mouseWheelScrollPage (1UL<<17)
227	#define Opt_pointerBlank (1UL<<18)
228	#define Opt_cursorBlink (1UL<<19)
229	#define Opt_secondaryScreen (1UL<<20)
230	#define Opt_secondaryScroll (1UL<<21)
231	#define Opt_pastableTabs (1UL<<22)
232	#define Opt_cursorUnderline (1UL<<23)
233	#if ENABLE_FRILLS
234	# define Opt_insecure (1UL<<24) // insecure esc sequences
235	# define Opt_borderLess (1UL<<25) // mwm borderless hints
236	# define Opt_hold (1UL<<26) // hold window open after exit
237	# define Opt_skipBuiltinGlyphs (1UL<<27) // do not use internal glyphs
238	#else
239	# define Opt_insecure 0
240	# define Opt_borderLess 0
241	# define Opt_hold 0
242	# define Opt_skipBuiltinGlyphs 0
243	#endif
244	#if ENABLE_STYLES
245	# define Opt_intensityStyles (1UL<<28) // font styles imply intensity
246	#else
247	# define Opt_intensityStyles 0
248	#endif
249
250	#define SET_OPTION(opt) (options \|= (opt))
251	#define CLR_OPTION(opt) (options &= ~(opt))
252	#define OPTION(opt) (options & (opt))
253	#define OPTION_R(opt) (r->options & (opt))
254	#define DEFAULT_OPTIONS (Opt_scrollBar \| Opt_scrollTtyOutput \
255	\| Opt_jumpScroll \| Opt_secondaryScreen \
256	\| Opt_pastableTabs \| Opt_intensityStyles)
257
258	/* ------------------------------------------------------------------------- */
259
260	typedef struct {
261	short state;
262	Window win;
263	struct rxvt_drawable *drawable;
264	} menuBar_t;
265
266	typedef struct {
267	char state; /* scrollbar state */
268	char init; /* scrollbar has been initialised */
269	unsigned int beg; /* slider sub-window begin height */
270	unsigned int end; /* slider sub-window end height */
271	unsigned int top; /* slider top position */
272	unsigned int bot; /* slider bottom position */
273	unsigned int style; /* style: rxvt, xterm, next */
274	unsigned int width; /* scrollbar width */
275	Window win;
276	int (rxvt_term::*update)(int, int, int, int);
277
278	void setIdle() { state = 1 ; }
279	void setMotion() { state = 'm'; }
280	void setUp() { state = 'U'; }
281	void setDn() { state = 'D'; }
282	} scrollBar_t;
283
284	struct rxvt_vars : TermWin_t {
285	scrollBar_t scrollBar;
286	menuBar_t menuBar;
287	unsigned long options;
288	XSizeHints szHint;
289	rxvt_display *display;
290	rxvt_color *pix_colors;
291	rxvt_color *pix_colors_focused;
292	#ifdef OFF_FOCUS_FADING
293	rxvt_color *pix_colors_unfocused;
294	#endif
295	short numpix_colors;
296	Cursor TermWin_cursor; /* cursor for vt window */
297	int sb_shadow; /* scrollbar shadow width */
298	rxvt_ptytty pty;
299	int numlock_state;
300	line_t *row_buf; // all lines, scrollback + terminal, circular
301	line_t *drawn_buf; // text on screen
302	line_t *temp_buf; // temporary buffer
303	line_t *swap_buf; // lines for swap buffer
304	char tabs; / per location: 1 == tab-stop */
305	screen_t screen;
306	screen_t swap;
307	selection_t selection;
308	};
309
310	void rxvt_init ();
311
312	#endif /* _RXVTLIB_H_ */
313