2 * Internals of the Terminal structure, for those other modules
3 * which need to look inside it. It would be nice if this could be
4 * folded back into terminal.c in future, with an abstraction layer
5 * to handle everything that other modules need to know about it;
6 * but for the moment, this will do.
9 #ifndef PUTTY_TERMINAL_H
10 #define PUTTY_TERMINAL_H
15 struct beeptime *next;
23 #ifdef OPTIMISE_SCROLL
25 struct scrollregion *next;
26 int topline; /* Top line of scroll region. */
27 int botline; /* Bottom line of scroll region. */
28 int lines; /* Number of lines to scroll by - +ve is forwards. */
30 #endif /* OPTIMISE_SCROLL */
34 int compatibility_level;
36 tree234 *scrollback; /* lines scrolled off top of screen */
37 tree234 *screen; /* lines on primary screen */
38 tree234 *alt_screen; /* lines on alternate screen */
39 int disptop; /* distance scrolled back (0 or -ve) */
40 int tempsblines; /* number of lines in temporary
43 unsigned long *cpos; /* cursor position (convenience) */
45 unsigned long *disptext; /* buffer of text on real screen */
46 unsigned long *dispcurs; /* location of cursor on real screen */
47 unsigned long curstype; /* type of cursor on real screen */
49 #define VBELL_TIMEOUT (TICKSPERSEC/10) /* visual bell lasts 1/10 sec */
51 struct beeptime *beephead, *beeptail;
56 #define TTYPE unsigned long
57 #define TSIZE (sizeof(TTYPE))
58 #define fix_cpos do { \
59 term->cpos = lineptr(term->curs.y) + term->curs.x; \
62 #ifdef OPTIMISE_SCROLL
63 struct scrollregion *scrollhead, *scrolltail;
64 #endif /* OPTIMISE_SCROLL */
66 unsigned long curr_attr, save_attr;
67 unsigned long erase_char;
69 bufchain inbuf; /* terminal input buffer */
70 pos curs; /* cursor */
71 pos savecurs; /* saved cursor position */
72 int marg_t, marg_b; /* scroll margins */
73 int dec_om; /* DEC origin mode flag */
74 int wrap, wrapnext; /* wrap flags */
75 int insert; /* insert-mode flag */
76 int cset; /* 0 or 1: which char set */
77 int save_cset, save_csattr; /* saved with cursor position */
78 int save_utf, save_wnext; /* saved with cursor position */
79 int rvideo; /* global reverse video flag */
80 unsigned long rvbell_startpoint; /* for ESC[?5hESC[?5l vbell */
81 int cursor_on; /* cursor enabled flag */
82 int reset_132; /* Flag ESC c resets to 80 cols */
83 int use_bce; /* Use Background coloured erase */
84 int blinker; /* When blinking is the cursor on ? */
85 int tblinker; /* When the blinking text is on */
86 int blink_is_real; /* Actually blink blinking text */
87 int term_echoing; /* Does terminal want local echo? */
88 int term_editing; /* Does terminal want local edit? */
89 int sco_acs, save_sco_acs; /* CSI 10,11,12m -> OEM charset */
90 int vt52_bold; /* Force bold on non-bold colours */
91 int utf; /* Are we in toggleable UTF-8 mode? */
92 int utf_state; /* Is there a pending UTF-8 character */
93 int utf_char; /* and what is it so far. */
94 int utf_size; /* The size of the UTF character. */
95 int printing, only_printing; /* Are we doing ANSI printing? */
96 int print_state; /* state of print-end-sequence scan */
97 bufchain printer_buf; /* buffered data for printer */
98 printer_job *print_job;
100 int rows, cols, savelines;
103 unsigned long vbell_startpoint;
104 int app_cursor_keys, app_keypad_keys, vt52_mode;
105 int repeat_off, cr_lf_return;
109 long last_blink; /* used for real blinking control */
112 int xterm_mouse; /* send mouse messages to app */
113 int mouse_is_down; /* used while tracking mouse buttons */
115 unsigned long cset_attr[2];
118 * Saved settings on the alternate screen.
120 int alt_x, alt_y, alt_om, alt_wrap, alt_wnext, alt_ins;
121 int alt_cset, alt_sco_acs, alt_utf;
124 int alt_sblines; /* # of lines on alternate screen that should be used for scrollback. */
126 #define ARGS_MAX 32 /* max # of esc sequence arguments */
127 #define ARG_DEFAULT 0 /* if an arg isn't specified */
128 #define def(a,d) ( (a) == ARG_DEFAULT ? (d) : (a) )
129 int esc_args[ARGS_MAX];
132 #define ANSI(x,y) ((x)+((y)<<8))
133 #define ANSI_QUE(x) ANSI(x,TRUE)
135 #define OSC_STR_MAX 2048
137 char osc_string[OSC_STR_MAX + 1];
140 char id_string[1024];
154 OSC_STRING, OSC_MAYBE_ST,
163 NO_SELECTION, ABOUT_TO, DRAGGING, SELECTED
166 LEXICOGRAPHIC, RECTANGULAR
169 SM_CHAR, SM_WORD, SM_LINE
171 pos selstart, selend, selanchor;
175 /* Mask of attributes to pay attention to when painting. */
176 unsigned long attr_mask;
178 wchar_t *paste_buffer;
179 int paste_len, paste_pos, paste_hold;
182 void (*resize_fn)(void *, int, int);
191 struct unicode_data *ucsdata;
194 * We maintain a full _copy_ of a Config structure here, not
195 * merely a pointer to it. That way, when we're passed a new
196 * one for reconfiguration, we can check the differences and
197 * adjust the _current_ setting of (e.g.) auto wrap mode rather
198 * than only the default.
203 * from_backend calls term_out, but it can also be called from
204 * the ldisc if the ldisc is called _within_ term_out. So we
205 * have to guard against re-entrancy - if from_backend is
206 * called recursively like this, it will simply add data to the
207 * end of the buffer term_out is in the process of working
213 #define in_utf(term) ((term)->utf || (term)->ucsdata->line_codepage==CP_UTF8)