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 = const_cast<rxvt_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)
 *  term_start : 0 <= term_start < saveLines
 *  total_rows : nrow + saveLines
 *
 *  top_row    : -saveLines <= top_row    <= 0
 *  view_start : top_row    <= view_start <= 0
 *
 *          | 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 + top_row
 *  | 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            term_start;    /* term lines start here                    */
  int            view_start;    /* scrollback view starts here              */
  int            top_row;       /* topmost row index of scrollback          */
  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 */
enum {
# define def(name,idx) Opt_ ## name = 1UL << (idx),
# define nodef(name)   Opt_ ## name = 0,
# include "optinc.h"
# undef nodef
# undef def
};

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

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;
  uint32_t        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, followed by temp_buf
  line_t         *drawn_buf;    // text on screen
  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 ();
bool rxvt_tainted ();

#endif                          /* _RXVTLIB_H_ */

Revision:	1.66
Committed:	Mon Jan 16 06:37:52 2006 UTC (18 years, 4 months ago) by root
Branch:	MAIN
Changes since 1.65:	+1 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.3	#ifndef _RXVTLIB_H_ /* include once only */
2	pcg	1.1	#define _RXVTLIB_H_
3
4	pcg	1.16	#include <cstdio>
5			#include <cctype>
6			#include <cerrno>
7	pcg	1.1	@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	root	1.44	#if HAVE_CWCHAR
26			# include <cwchar>
27	root	1.45	#elif HAVE_WCHAR_H
28	root	1.44	# include <wchar.h>
29			#else
30			// stdlib.h might provide it
31			#endif
32	pcg	1.16
33	root	1.32	#include "ptytty.h"
34
35	pcg	1.1	extern "C" {
36	pcg	1.3	#include <X11/Intrinsic.h> /* Xlib, Xutil, Xresource, Xfuncproto */
37	pcg	1.1	}
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	pcg	1.3	struct rxvt_vars; /* defined later on */
56			struct rxvt_term;
57	pcg	1.11	struct rxvt_display;
58			struct rxvt_im;
59	pcg	1.12	struct rxvt_drawable;
60	pcg	1.1
61	pcg	1.3	typedef struct rxvt_term *rxvt_t;
62
63			extern rxvt_t rxvt_current_term;
64
65	root	1.66	#define SET_R(r) rxvt_current_term = const_cast<rxvt_term *>(r)
66	root	1.43	#define GET_R rxvt_current_term
67	pcg	1.1
68	pcg	1.9	#define scrollbar_visible() scrollBar.state
69			#define menubar_visible() menuBar.state
70	pcg	1.1
71			typedef struct {
72	root	1.41	int row;
73			int col;
74	pcg	1.1	} row_col_t;
75
76	pcg	1.16	#if UNICODE_3
77	pcg	1.1	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	root	1.59	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	root	1.49
85	root	1.59	struct line_t;
86	pcg	1.1
87			/*
88	root	1.52	* terminal limits:
89			*
90			* width : 1 <= width
91			* height : 1 <= height
92	root	1.53	* ncol : 1 <= ncol <= MAX(tlen_t)
93			* nrow : 1 <= nrow <= MAX(int)
94			* saveLines : 0 <= saveLines <= MAX(int)
95	root	1.65	* term_start : 0 <= term_start < saveLines
96	root	1.52	* total_rows : nrow + saveLines
97	root	1.65	*
98			* top_row : -saveLines <= top_row <= 0
99			* view_start : top_row <= view_start <= 0
100	root	1.52	*
101			* \| most coordinates are stored relative to term_start,
102			* ROW_BUF \| which is the first line of the terminal screen
103			* \|························= row_buf[0]
104			* \|························= row_buf[1]
105			* \|························= row_buf[2] etc.
106			* \|
107	root	1.65	* +------------+···········= term_start + top_row
108	root	1.52	* \| scrollback \|
109	root	1.65	* \| scrollback +---------+·= term_start + view_start
110	root	1.52	* \| scrollback \| display \|
111			* \| scrollback \| display \|
112			* +------------+·display·+·= term_start
113			* \| terminal \| display \|
114			* \| terminal +---------+
115			* \| terminal \|
116			* \| terminal \|
117			* +------------+···········= term_stat + nrow - 1
118			* \|
119			* \|
120			* END······················= total_rows
121	pcg	1.1	*/
122
123	root	1.49	struct TermWin_t {
124	root	1.41	int width; /* window width [pixels] */
125			int height; /* window height [pixels] */
126			int fwidth; /* font width [pixels] */
127			int fheight; /* font height [pixels] */
128			int fbase; /* font ascent (baseline) [pixels] */
129			int ncol; /* window columns [characters] */
130			int nrow; /* window rows [characters] */
131			int focus; /* window has focus */
132			int mapped; /* window state mapped? */
133			int int_bwidth; /* internal border width */
134			int ext_bwidth; /* external border width */
135			int lineSpace; /* number of extra pixels between rows */
136			int saveLines; /* number of lines that fit in scrollback */
137	root	1.51	int total_rows; /* total number of rows in this terminal */
138	root	1.49	int term_start; /* term lines start here */
139	root	1.41	int view_start; /* scrollback view starts here */
140	root	1.65	int top_row; /* topmost row index of scrollback */
141	pcg	1.3	Window parent[6]; /* parent identifiers - we're parent[0] */
142			Window vt; /* vt100 window */
143			GC gc; /* GC for drawing */
144			Pixmap pixmap;
145	pcg	1.12	rxvt_drawable *drawable;
146	root	1.38	rxvt_fontset *fontset[4];
147	root	1.49	};
148	pcg	1.1
149			/*
150			* screen accounting:
151			* screen_t elements
152	root	1.49	* row: Cursor row position : 0 <= row < nrow
153			* col: Cursor column position : 0 <= col < ncol
154			* tscroll: Scrolling region top row inclusive : 0 <= row < nrow
155			* bscroll: Scrolling region bottom row inclusive : 0 <= row < nrow
156	pcg	1.1	*
157			* selection_t elements
158			* clicks: 1, 2 or 3 clicks - 4 indicates a special condition of 1 where
159			* nothing is selected
160			* beg: row/column of beginning of selection : never past mark
161			* mark: row/column of initial click : never past end
162			* end: row/column of one character past end of selection
163	root	1.51	* * Note: -nsaved <= beg.row <= mark.row <= end.row < nrow
164	pcg	1.1	* * Note: col == -1 ==> we're left of screen
165			*
166			*/
167			typedef struct {
168	root	1.52	row_col_t cur; /* cursor position on the screen */
169			int tscroll; /* top of settable scroll region */
170			int bscroll; /* bottom of settable scroll region */
171	root	1.38	unsigned int charset; /* character set number [0..3] */
172	pcg	1.3	unsigned int flags; /* see below */
173			row_col_t s_cur; /* saved cursor position */
174	root	1.38	unsigned int s_charset; /* saved character set number [0..3] */
175	pcg	1.3	char s_charset_char;
176			rend_t s_rstyle; /* saved rendition style */
177	pcg	1.1	} screen_t;
178
179			enum selection_op_t {
180	pcg	1.3	SELECTION_CLEAR = 0, /* nothing selected */
181			SELECTION_INIT, /* marked a point */
182			SELECTION_BEGIN, /* started a selection */
183			SELECTION_CONT, /* continued selection */
184			SELECTION_DONE /* selection put in CUT_BUFFER0 */
185	pcg	1.1	};
186
187			typedef struct {
188	root	1.41	wchar_t text; / selected text */
189			unsigned int len; /* length of selected text */
190			unsigned int screen; /* screen being used */
191			unsigned int clicks; /* number of clicks */
192			selection_op_t op; /* current operation */
193			bool rect; /* rectangluar selection? */
194			row_col_t beg; /* beginning of selection <= mark */
195			row_col_t mark; /* point of initial click <= end */
196			row_col_t end; /* one character past end point */
197	pcg	1.1	} selection_t;
198
199			/* ------------------------------------------------------------------------- */
200
201			/* screen_t flags */
202	root	1.47	#define Screen_Relative (1<<0) /* relative origin mode flag */
203			#define Screen_VisibleCursor (1<<1) /* cursor visible? */
204			#define Screen_Autowrap (1<<2) /* auto-wrap flag */
205			#define Screen_Insert (1<<3) /* insert mode (vs. overstrike) */
206			#define Screen_WrapNext (1<<4) /* need to wrap for next char? */
207	root	1.48	#define Screen_DefaultFlags (Screen_VisibleCursor \| Screen_Autowrap)
208	pcg	1.1
209	root	1.32	/* rxvt_vars.options */
210	root	1.61	enum {
211			# define def(name,idx) Opt_ ## name = 1UL << (idx),
212			# define nodef(name) Opt_ ## name = 0,
213			# include "optinc.h"
214			# undef nodef
215			# undef def
216			};
217	pcg	1.1
218			/* ------------------------------------------------------------------------- */
219
220			typedef struct {
221	pcg	1.3	short state;
222			Window win;
223	pcg	1.13	struct rxvt_drawable *drawable;
224	pcg	1.1	} menuBar_t;
225
226			typedef struct {
227	pcg	1.3	char state; /* scrollbar state */
228			char init; /* scrollbar has been initialised */
229	root	1.38	unsigned int beg; /* slider sub-window begin height */
230			unsigned int end; /* slider sub-window end height */
231			unsigned int top; /* slider top position */
232			unsigned int bot; /* slider bottom position */
233			unsigned int style; /* style: rxvt, xterm, next */
234			unsigned int width; /* scrollbar width */
235	pcg	1.3	Window win;
236	pcg	1.10	int (rxvt_term::*update)(int, int, int, int);
237	pcg	1.7
238			void setIdle() { state = 1 ; }
239			void setMotion() { state = 'm'; }
240			void setUp() { state = 'U'; }
241			void setDn() { state = 'D'; }
242	pcg	1.1	} scrollBar_t;
243
244	root	1.49	struct rxvt_vars : TermWin_t {
245	pcg	1.3	scrollBar_t scrollBar;
246			menuBar_t menuBar;
247	root	1.62	uint32_t options;
248	pcg	1.3	XSizeHints szHint;
249	pcg	1.11	rxvt_display *display;
250	root	1.32	rxvt_color *pix_colors;
251			rxvt_color *pix_colors_focused;
252	root	1.24	#ifdef OFF_FOCUS_FADING
253	root	1.32	rxvt_color *pix_colors_unfocused;
254	root	1.24	#endif
255	root	1.32	short numpix_colors;
256	pcg	1.3	Cursor TermWin_cursor; /* cursor for vt window */
257			int sb_shadow; /* scrollbar shadow width */
258	root	1.32	rxvt_ptytty pty;
259	pcg	1.3	int numlock_state;
260	root	1.64	line_t *row_buf; // all lines, scrollback + terminal, circular, followed by temp_buf
261	root	1.52	line_t *drawn_buf; // text on screen
262			line_t *swap_buf; // lines for swap buffer
263	pcg	1.3	char tabs; / per location: 1 == tab-stop */
264			screen_t screen;
265			screen_t swap;
266			selection_t selection;
267			};
268	pcg	1.1
269	root	1.32	void rxvt_init ();
270	root	1.63	bool rxvt_tainted ();
271	pcg	1.1
272	pcg	1.3	#endif /* _RXVTLIB_H_ */
273	pcg	1.1