ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/rxvtlib.h.in
Revision: 1.2
Committed: Mon Nov 24 17:31:27 2003 UTC (20 years, 6 months ago) by pcg
Branch: MAIN
Changes since 1.1: +0 -0 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.1 /*
2     * $Id: rxvtlib.h.in,v 1.10 2003/11/23 19:32:50 root Exp $
3     */
4    
5     #ifndef _RXVTLIB_H_ /* include once only */
6     #define _RXVTLIB_H_
7    
8     /*
9     * section 1 generated by GNU autoconf for @build@
10     * this section may be changed as appropriate _before_ building
11     */
12     /*****************************************************************************
13     * SECTION 1 *
14     *****************************************************************************/
15    
16     /*
17     * The following line MUST not be changed without also changing
18     * config.h in the main directory before building
19     */
20     // none anymore
21    
22     /*****************************************************************************
23     * INCLUDES *
24     *****************************************************************************/
25    
26     #include <stdio.h>
27     #include <ctype.h>
28     #include <errno.h>
29     @include_stdarg_h@
30     @include_stdlib_h@
31     @include_stdint_h@
32     #include <sys/types.h>
33     @include_unistd_h@
34     @include_string_h@
35     @include_fcntl_h@
36     @include_util_h@
37     @include_assert_h@
38     @include_sys_ioctl_h@
39     @include_sys_time_h@
40     @include_time_h@
41     @include_sys_select_h@
42     @include_sys_strredir_h@
43    
44     #include <sys/wait.h>
45     #include <sys/stat.h>
46    
47     extern "C" {
48     #include <X11/Intrinsic.h> /* Xlib, Xutil, Xresource, Xfuncproto */
49     }
50    
51     /*
52     * If we haven't pulled in typedef's like int16_t then do them ourself
53     * type of (normal and unsigned) basic sizes
54     */
55     @rxvt_int16_typedef@
56     @rxvt_uint16_typedef@
57     @rxvt_int32_typedef@
58     @rxvt_uint32_typedef@
59    
60     /* whatever normal size corresponds to a integer pointer */
61     @rxvt_intp_define@
62     /* whatever normal size corresponds to a unsigned integer pointer */
63     @rxvt_u_intp_define@
64    
65     /*****************************************************************************
66     * SECTION 2 *
67     * DO NOT TOUCH ANYTHING BELOW HERE *
68     *****************************************************************************/
69    
70     struct rxvt_fontset;
71     struct rxvt_color;
72     struct rxvt_vars; /* defined later on */
73     struct rxvt_hidden; /* not defined here */
74    
75     extern struct rxvt_vars *rxvt_current_term;
76    
77     #if EXPLICIT_CONTEXT
78    
79     # define pR struct rxvt_vars *rxvt_term
80     # define aR rxvt_term
81     # define pR_ pR,
82     # define aR_ aR,
83    
84     # define R rxvt_term
85    
86     # define SET_R(r) rxvt_current_term = (r)
87     # define GET_R rxvt_current_term
88    
89     #else
90    
91     # define pR
92     # define pR_
93     # define aR
94     # define aR_
95    
96     # define R rxvt_current_term
97    
98     # define SET_R(r) rxvt_current_term = (r)
99     # define GET_R R
100    
101     #endif
102    
103     #define dR rxvt_t *rxvt_term = GET_R
104    
105     #define scrollbar_visible(rxvtvars) ((rxvtvars)->scrollBar.state)
106     #define menubar_visible(rxvtvars) ((rxvtvars)->menuBar.state)
107    
108     typedef struct {
109     int32_t row;
110     int32_t col;
111     } row_col_t;
112    
113     #if UNICODE3
114     typedef uint32_t text_t;
115     #else
116     typedef uint16_t text_t; // saves lots of memory
117     #endif
118     typedef uint32_t rend_t;
119    
120     /*
121     * TermWin elements limits
122     * width : 1 <= width
123     * height : 1 <= height
124     * ncol : 1 <= ncol <= MAX(int16_t)
125     * nrow : 1 <= nrow <= MAX(int16_t)
126     * saveLines : 0 <= saveLines <= MAX(int16_t)
127     * nscrolled : 0 <= nscrolled <= saveLines
128     * view_start: 0 <= view_start <= nscrolled
129     */
130    
131     typedef struct {
132     uint16_t width; /* window width [pixels] */
133     uint16_t height; /* window height [pixels] */
134     uint16_t fwidth; /* font width [pixels] */
135     uint16_t fheight; /* font height [pixels] */
136     uint16_t fbase; /* font ascent (baseline) [pixels] */
137     uint16_t propfont; /* font proportional flags */
138     uint16_t ncol; /* window columns [characters] */
139     uint16_t nrow; /* window rows [characters] */
140     uint16_t focus; /* window has focus */
141     uint16_t mapped; /* window state mapped? */
142     uint16_t int_bwidth; /* internal border width */
143     uint16_t ext_bwidth; /* external border width */
144     uint16_t lineSpace; /* number of extra pixels between rows */
145     uint16_t saveLines; /* number of lines that fit in scrollback */
146     uint16_t nscrolled; /* number of line actually scrolled */
147     uint16_t view_start; /* scrollback view starts here */
148     Window parent[6]; /* parent identifiers - we're parent[0] */
149     Window vt; /* vt100 window */
150     GC gc; /* GC for drawing */
151     Pixmap pixmap;
152     rxvt_fontset *fontset;
153     } TermWin_t;
154    
155     /*
156     * screen accounting:
157     * screen_t elements
158     * text: Contains all text information including the scrollback buffer.
159     * Each line is length TermWin.ncol
160     * tlen: The length of the line or -1 for wrapped lines.
161     * rend: Contains rendition information: font, bold, colour, etc.
162     * * Note: Each line for both text and rend are only allocated on demand, and
163     * text[x] is allocated <=> rend[x] is allocated for all x.
164     * row: Cursor row position : 0 <= row < TermWin.nrow
165     * col: Cursor column position : 0 <= col < TermWin.ncol
166     * tscroll: Scrolling region top row inclusive : 0 <= row < TermWin.nrow
167     * bscroll: Scrolling region bottom row inclusive : 0 <= row < TermWin.nrow
168     *
169     * selection_t elements
170     * clicks: 1, 2 or 3 clicks - 4 indicates a special condition of 1 where
171     * nothing is selected
172     * beg: row/column of beginning of selection : never past mark
173     * mark: row/column of initial click : never past end
174     * end: row/column of one character past end of selection
175     * * Note: -TermWin.nscrolled <= beg.row <= mark.row <= end.row < TermWin.nrow
176     * * Note: col == -1 ==> we're left of screen
177     *
178     * Layout of text/rend information in the screen_t text/rend structures:
179     * Rows [0] ... [TermWin.saveLines - 1]
180     * scrollback region : we're only here if TermWin.view_start != 0
181     * Rows [TermWin.saveLines] ... [TermWin.saveLines + TermWin.nrow - 1]
182     * normal `unscrolled' screen region
183     */
184     typedef struct {
185     text_t **text; /* _all_ the text */
186     int16_t *tlen; /* length of each text line */
187     rend_t **rend; /* rendition, uses RS_ flags */
188     row_col_t cur; /* cursor position on the screen */
189     uint16_t tscroll; /* top of settable scroll region */
190     uint16_t bscroll; /* bottom of settable scroll region */
191     uint16_t charset; /* character set number [0..3] */
192     unsigned int flags; /* see below */
193     row_col_t s_cur; /* saved cursor position */
194     uint16_t s_charset; /* saved character set number [0..3] */
195     char s_charset_char;
196     rend_t s_rstyle; /* saved rendition style */
197     } screen_t;
198    
199     enum selection_op_t {
200     SELECTION_CLEAR = 0, /* nothing selected */
201     SELECTION_INIT, /* marked a point */
202     SELECTION_BEGIN, /* started a selection */
203     SELECTION_CONT, /* continued selection */
204     SELECTION_DONE /* selection put in CUT_BUFFER0 */
205     };
206    
207     typedef struct {
208     unsigned char *text; /* selected text */
209     uint32_t len; /* length of selected text */
210     short screen; /* screen being used */
211     short clicks; /* number of clicks */
212     selection_op_t op; /* current operation */
213     row_col_t beg; /* beginning of selection <= mark */
214     row_col_t mark; /* point of initial click <= end */
215     row_col_t end; /* one character past end point */
216     } selection_t;
217    
218     typedef enum {
219     OLD_SELECT, OLD_WORD_SELECT, NEW_SELECT
220     } sstyle_t;
221    
222     /* ------------------------------------------------------------------------- */
223    
224     /* screen_t flags */
225     #define Screen_Relative (1<<0) /* relative origin mode flag */
226     #define Screen_VisibleCursor (1<<1) /* cursor visible? */
227     #define Screen_Autowrap (1<<2) /* auto-wrap flag */
228     #define Screen_Insert (1<<3) /* insert mode (vs. overstrike) */
229     #define Screen_WrapNext (1<<4) /* need to wrap for next char? */
230     #define Screen_DefaultFlags (Screen_VisibleCursor|Screen_Autowrap)
231    
232     /* rxvt_vars.Options */
233     #define Opt_console (1LU<<0)
234     #define Opt_loginShell (1LU<<1)
235     #define Opt_iconic (1LU<<2)
236     #define Opt_visualBell (1LU<<3)
237     #define Opt_mapAlert (1LU<<4)
238     #define Opt_reverseVideo (1LU<<5)
239     #define Opt_utmpInhibit (1LU<<6)
240     #define Opt_scrollBar (1LU<<7)
241     #define Opt_scrollBar_right (1LU<<8)
242     #define Opt_scrollBar_floating (1LU<<9)
243     #define Opt_meta8 (1LU<<10)
244     #define Opt_scrollTtyOutput (1LU<<11)
245     #define Opt_scrollTtyKeypress (1LU<<12)
246     #define Opt_transparent (1LU<<13)
247     #define Opt_transparent_all (1LU<<14)
248     #define Opt_mc_hack (1LU<<15)
249     #define Opt_tripleclickwords (1LU<<16)
250     #define Opt_scrollWithBuffer (1LU<<17)
251     #define Opt_jumpScroll (1LU<<18)
252     #define Opt_mouseWheelScrollPage (1LU<<19)
253     #define Opt_pointerBlank (1LU<<20)
254     #define Opt_cursorBlink (1LU<<21)
255     /* place holder used for parsing command-line options */
256     #define Opt_Reverse (1LU<<30)
257     #define Opt_Boolean (1LU<<31)
258    
259     #define DEFAULT_OPTIONS (Opt_scrollBar | Opt_scrollTtyOutput \
260     | Opt_jumpScroll)
261    
262     #define PROPFONT_NORMAL (1<<0)
263     #define PROPFONT_BOLD (1<<1)
264    
265     /* ------------------------------------------------------------------------- */
266    
267     typedef enum {
268     EUCJ, SJIS, /* Japanese KANJI methods */
269     BIG5, CNS, /* Chinese BIG5 methods: CNS not implemented */
270     GB, /* Chinese GB method */
271     KR, /* Korean method */
272     NOENC /* no encoding */
273     } ENC_METHOD;
274    
275     typedef struct {
276     short method;
277     void (*func)(unsigned char *, int);
278     char *name;
279     } KNOWN_ENCODINGS;
280    
281     typedef struct {
282     short state;
283     Window win;
284     } menuBar_t;
285    
286     typedef struct {
287     char state; /* scrollbar state */
288     char init; /* scrollbar has been initialised */
289     short beg; /* slider sub-window begin height */
290     short end; /* slider sub-window end height */
291     short top; /* slider top position */
292     short bot; /* slider bottom position */
293     short style; /* style: rxvt, xterm, next */
294     short width; /* scrollbar width */
295     Window win;
296     int (*update)(pR_ int, int, int, int);
297     } scrollBar_t;
298    
299     typedef struct rxvt_vars {
300     /*
301     * These ``hidden'' items are not for public consumption and
302     * must not be accessed externally
303     */
304     struct rxvt_hidden *h;
305    
306     /*
307     * Exposed items
308     * Changes to structure here require library version number change
309     */
310     TermWin_t TermWin;
311     scrollBar_t scrollBar;
312     menuBar_t menuBar;
313     Display *Xdisplay;
314     unsigned long Options;
315     XSizeHints szHint;
316     Colormap Xcmap;
317     rxvt_color *PixColors;
318     short numPixColors;
319     Cursor TermWin_cursor; /* cursor for vt window */
320     int Xdepth;
321     int sb_shadow; /* scrollbar shadow width */
322     int Xfd; /* file descriptor of X server connection */
323     int cmd_fd; /* pty file descriptor; connected to command */
324     int tty_fd; /* tty file descriptor; connected to child */
325     int num_fds; /* number of file descriptors being used */
326     int numlock_state;
327     text_t **drawn_text; /* text drawn on screen (characters) */
328     rend_t **drawn_rend; /* text drawn on screen (rendition) */
329     text_t **buf_text;
330     rend_t **buf_rend;
331     char *tabs; /* per location: 1 == tab-stop */
332     screen_t screen;
333     screen_t swap;
334     selection_t selection;
335     sstyle_t selection_style;
336     ENC_METHOD encoding_method;
337     } rxvt_t;
338    
339     /*****************************************************************************
340     * PROTOTYPES *
341     *****************************************************************************/
342     void rxvt_main_loop(pR);
343     rxvt_t *rxvt_init(int, const char *const *);
344    
345     #endif /* _RXVTLIB_H_ */