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 */
32 typedef struct termchar termchar
;
33 typedef struct termline termline
;
37 * Any code in terminal.c which definitely needs to be changed
38 * when extra fields are added here is labelled with a comment
39 * saying FULL-TERMCHAR.
45 * The cc_next field is used to link multiple termchars
46 * together into a list, so as to fit more than one character
47 * into a character cell (Unicode combining characters).
49 * cc_next is a relative offset into the current array of
50 * termchars. I.e. to advance to the next character in a list,
51 * one does `tc += tc->next'.
53 * Zero means end of list.
60 int cols
; /* number of real columns on the line */
61 int size
; /* number of allocated termchars
62 * (cc-lists may make this > cols) */
63 int temporary
; /* TRUE if decompressed from scrollback */
64 int cc_free
; /* offset to first cc in free list */
65 struct termchar
*chars
;
70 int compatibility_level
;
72 tree234
*scrollback
; /* lines scrolled off top of screen */
73 tree234
*screen
; /* lines on primary screen */
74 tree234
*alt_screen
; /* lines on alternate screen */
75 int disptop
; /* distance scrolled back (0 or -ve) */
76 int tempsblines
; /* number of lines in temporary
79 termline
**disptext
; /* buffer of text on real screen */
80 int dispcursx
, dispcursy
; /* location of cursor on real screen */
81 int curstype
; /* type of cursor on real screen */
83 #define VBELL_TIMEOUT (TICKSPERSEC/10) /* visual bell lasts 1/10 sec */
85 struct beeptime
*beephead
, *beeptail
;
90 #define TTYPE termchar
91 #define TSIZE (sizeof(TTYPE))
93 #ifdef OPTIMISE_SCROLL
94 struct scrollregion
*scrollhead
, *scrolltail
;
95 #endif /* OPTIMISE_SCROLL */
97 int default_attr
, curr_attr
, save_attr
;
98 termchar basic_erase_char
, erase_char
;
100 bufchain inbuf
; /* terminal input buffer */
101 pos curs
; /* cursor */
102 pos savecurs
; /* saved cursor position */
103 int marg_t
, marg_b
; /* scroll margins */
104 int dec_om
; /* DEC origin mode flag */
105 int wrap
, wrapnext
; /* wrap flags */
106 int insert
; /* insert-mode flag */
107 int cset
; /* 0 or 1: which char set */
108 int save_cset
, save_csattr
; /* saved with cursor position */
109 int save_utf
, save_wnext
; /* saved with cursor position */
110 int rvideo
; /* global reverse video flag */
111 unsigned long rvbell_startpoint
; /* for ESC[?5hESC[?5l vbell */
112 int cursor_on
; /* cursor enabled flag */
113 int reset_132
; /* Flag ESC c resets to 80 cols */
114 int use_bce
; /* Use Background coloured erase */
115 int blinker
; /* When blinking is the cursor on ? */
116 int tblinker
; /* When the blinking text is on */
117 int blink_is_real
; /* Actually blink blinking text */
118 int term_echoing
; /* Does terminal want local echo? */
119 int term_editing
; /* Does terminal want local edit? */
120 int sco_acs
, save_sco_acs
; /* CSI 10,11,12m -> OEM charset */
121 int vt52_bold
; /* Force bold on non-bold colours */
122 int utf
; /* Are we in toggleable UTF-8 mode? */
123 int utf_state
; /* Is there a pending UTF-8 character */
124 int utf_char
; /* and what is it so far. */
125 int utf_size
; /* The size of the UTF character. */
126 int printing
, only_printing
; /* Are we doing ANSI printing? */
127 int print_state
; /* state of print-end-sequence scan */
128 bufchain printer_buf
; /* buffered data for printer */
129 printer_job
*print_job
;
131 int rows
, cols
, savelines
;
134 unsigned long vbell_startpoint
;
135 int app_cursor_keys
, app_keypad_keys
, vt52_mode
;
136 int repeat_off
, cr_lf_return
;
140 long last_blink
; /* used for real blinking control */
143 int xterm_mouse
; /* send mouse messages to app */
144 int mouse_is_down
; /* used while tracking mouse buttons */
149 * Saved settings on the alternate screen.
151 int alt_x
, alt_y
, alt_om
, alt_wrap
, alt_wnext
, alt_ins
;
152 int alt_cset
, alt_sco_acs
, alt_utf
;
155 int alt_sblines
; /* # of lines on alternate screen that should be used for scrollback. */
157 #define ARGS_MAX 32 /* max # of esc sequence arguments */
158 #define ARG_DEFAULT 0 /* if an arg isn't specified */
159 #define def(a,d) ( (a) == ARG_DEFAULT ? (d) : (a) )
160 int esc_args
[ARGS_MAX
];
163 #define ANSI(x,y) ((x)+((y)<<8))
164 #define ANSI_QUE(x) ANSI(x,TRUE)
166 #define OSC_STR_MAX 2048
168 char osc_string
[OSC_STR_MAX
+ 1];
171 char id_string
[1024];
185 OSC_STRING
, OSC_MAYBE_ST
,
194 NO_SELECTION
, ABOUT_TO
, DRAGGING
, SELECTED
197 LEXICOGRAPHIC
, RECTANGULAR
200 SM_CHAR
, SM_WORD
, SM_LINE
202 pos selstart
, selend
, selanchor
;
206 /* Mask of attributes to pay attention to when painting. */
209 wchar_t *paste_buffer
;
210 int paste_len
, paste_pos
, paste_hold
;
213 void (*resize_fn
)(void *, int, int);
222 struct unicode_data
*ucsdata
;
225 * We maintain a full _copy_ of a Config structure here, not
226 * merely a pointer to it. That way, when we're passed a new
227 * one for reconfiguration, we can check the differences and
228 * adjust the _current_ setting of (e.g.) auto wrap mode rather
229 * than only the default.
234 * from_backend calls term_out, but it can also be called from
235 * the ldisc if the ldisc is called _within_ term_out. So we
236 * have to guard against re-entrancy - if from_backend is
237 * called recursively like this, it will simply add data to the
238 * end of the buffer term_out is in the process of working
244 * These are buffers used by the bidi and Arabic shaping code.
248 bidi_char
*wcFrom
, *wcTo
;
250 termchar
**pre_bidi_cache
, **post_bidi_cache
;
254 #define in_utf(term) ((term)->utf || (term)->ucsdata->line_codepage==CP_UTF8)