Extensive changes that _should_ fix the socket buffering problems,
[u/mdw/putty] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include "network.h"
5
6 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
7 #define PUTTY_REG_PARENT "Software\\SimonTatham"
8 #define PUTTY_REG_PARENT_CHILD "PuTTY"
9 #define PUTTY_REG_GPARENT "Software"
10 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
11
12 /*
13 * Global variables. Most modules declare these `extern', but
14 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
15 * module, and so will get them properly defined.
16 */
17 #ifdef PUTTY_DO_GLOBALS
18 #define GLOBAL
19 #else
20 #define GLOBAL extern
21 #endif
22
23 /* Three attribute types:
24 * The ATTRs (normal attributes) are stored with the characters in the main
25 * display arrays
26 *
27 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
28 * with characters but not with normal attributes.
29 *
30 * The LATTRs (line attributes) conflict with no others and only have one
31 * value per line. But on area clears the LATTR cells are set to the erase_char
32 * (or DEFAULT_ATTR + 'E')
33 *
34 * ATTR_INVALID is an illegal colour combination.
35 */
36
37 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
38 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
39 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
40
41 #define LATTR_NORM 0x00000000UL
42 #define LATTR_WIDE 0x01000000UL
43 #define LATTR_TOP 0x02000000UL
44 #define LATTR_BOT 0x03000000UL
45 #define LATTR_MODE 0x03000000UL
46 #define LATTR_WRAPPED 0x10000000UL
47
48 #define ATTR_INVALID 0x00FF0000UL
49
50 /* Like Linux use the F000 page for direct to font. */
51 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
52 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
53
54 /* These are internal use overlapping with the UTF-16 surrogates */
55 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
56 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
57 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
58 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
59 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
60
61 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
62 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
63
64 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
65 #define UCSWIDE 0x303F
66
67 #define ATTR_WIDE 0x10000000UL
68 #define ATTR_BOLD 0x01000000UL
69 #define ATTR_UNDER 0x02000000UL
70 #define ATTR_REVERSE 0x04000000UL
71 #define ATTR_BLINK 0x08000000UL
72 #define ATTR_FGMASK 0x000F0000UL
73 #define ATTR_BGMASK 0x00F00000UL
74 #define ATTR_COLOURS 0x00FF0000UL
75 #define ATTR_FGSHIFT 16
76 #define ATTR_BGSHIFT 20
77
78 #define ATTR_DEFAULT 0x00980000UL
79 #define ATTR_DEFFG 0x00080000UL
80 #define ATTR_DEFBG 0x00900000UL
81 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
82 #define ATTR_MASK 0xFFFFFF00UL
83 #define CHAR_MASK 0x000000FFUL
84
85 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
86 #define ATTR_CUR_XOR 0x00BA0000UL
87
88 typedef HDC Context;
89 #define SEL_NL { 13, 10 }
90
91 GLOBAL int rows, cols, savelines;
92
93 GLOBAL int font_width, font_height;
94
95 #define INBUF_SIZE 2048
96 GLOBAL unsigned char inbuf[INBUF_SIZE];
97 GLOBAL int inbuf_head;
98
99 #define OUTBUF_SIZE 2048
100 #define OUTBUF_MASK (OUTBUF_SIZE-1)
101 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
102 GLOBAL int outbuf_head, outbuf_reap;
103
104 GLOBAL int has_focus;
105
106 GLOBAL int in_vbell;
107 GLOBAL long vbell_timeout;
108
109 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
110 GLOBAL int repeat_off, cr_lf_return;
111
112 GLOBAL int seen_key_event;
113 GLOBAL int seen_disp_event;
114
115 GLOBAL int session_closed;
116
117 GLOBAL int big_cursor;
118
119 GLOBAL int utf;
120 GLOBAL int dbcs_screenfont;
121 GLOBAL int font_codepage;
122 GLOBAL int kbd_codepage;
123 GLOBAL int line_codepage;
124 GLOBAL WCHAR unitab_scoacs[256];
125 GLOBAL WCHAR unitab_line[256];
126 GLOBAL WCHAR unitab_font[256];
127 GLOBAL WCHAR unitab_xterm[256];
128 GLOBAL WCHAR unitab_oemcp[256];
129 GLOBAL unsigned char unitab_ctrl[256];
130 #define in_utf (utf || line_codepage==CP_UTF8)
131
132 #define LGXF_OVR 1 /* existing logfile overwrite */
133 #define LGXF_APN 0 /* existing logfile append */
134 #define LGXF_ASK -1 /* existing logfile ask */
135 #define LGTYP_NONE 0 /* logmode: no logging */
136 #define LGTYP_ASCII 1 /* logmode: pure ascii */
137 #define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
138 GLOBAL char *logfile;
139
140 /*
141 * Window handles for the dialog boxes that can be running during a
142 * PuTTY session.
143 */
144 GLOBAL HWND logbox;
145
146 /*
147 * I've just looked in the windows standard headr files for WM_USER, there
148 * are hundreds of flags defined using the form WM_USER+123 so I've
149 * renumbered this NETEVENT value and the two in window.c
150 */
151 #define WM_XUSER (WM_USER + 0x2000)
152 #define WM_NETEVENT (WM_XUSER + 5)
153
154 typedef enum {
155 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
156 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
157 TS_EOL
158 } Telnet_Special;
159
160 typedef enum {
161 MBT_NOTHING,
162 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
163 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
164 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
165 } Mouse_Button;
166
167 typedef enum {
168 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
169 } Mouse_Action;
170
171 typedef enum {
172 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
173 } VT_Mode;
174
175 enum {
176 /*
177 * Line discipline option states: off, on, up to the backend.
178 */
179 LD_YES, LD_NO, LD_BACKEND
180 };
181
182 enum {
183 /*
184 * Line discipline options which the backend might try to control.
185 */
186 LD_EDIT, /* local line editing */
187 LD_ECHO /* local echo */
188 };
189
190 enum {
191 /*
192 * Close On Exit behaviours. (cfg.close_on_exit)
193 */
194 COE_NEVER, /* Never close the window */
195 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
196 COE_ALWAYS /* Always close the window */
197 };
198
199 typedef struct {
200 char *(*init) (char *host, int port, char **realhost);
201 /* back->send() returns the current amount of buffered data. */
202 int (*send) (char *buf, int len);
203 /* back->sendbuffer() does the same thing but without attempting a send */
204 int (*sendbuffer) (void);
205 void (*size) (void);
206 void (*special) (Telnet_Special code);
207 Socket(*socket) (void);
208 int (*sendok) (void);
209 int (*ldisc) (int);
210 /*
211 * back->unthrottle() tells the back end that the front end
212 * buffer is clearing.
213 */
214 void (*unthrottle) (int);
215 int default_port;
216 } Backend;
217
218 GLOBAL Backend *back;
219
220 extern struct backend_list {
221 int protocol;
222 char *name;
223 Backend *backend;
224 } backends[];
225
226 typedef struct {
227 /* Basic options */
228 char host[512];
229 int port;
230 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
231 int close_on_exit;
232 int warn_on_close;
233 int ping_interval; /* in seconds */
234 /* SSH options */
235 char remote_cmd[512];
236 char *remote_cmd_ptr; /* might point to a larger command
237 * but never for loading/saving */
238 int nopty;
239 int compression;
240 int agentfwd;
241 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
242 char keyfile[FILENAME_MAX];
243 int sshprot; /* use v1 or v2 when both available */
244 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
245 int try_tis_auth;
246 int ssh_subsys; /* run a subsystem rather than a command */
247 /* Telnet options */
248 char termtype[32];
249 char termspeed[32];
250 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
251 char username[32];
252 char localusername[32];
253 int rfc_environ;
254 int passive_telnet;
255 /* Keyboard options */
256 int bksp_is_delete;
257 int rxvt_homeend;
258 int funky_type;
259 int no_applic_c; /* totally disable app cursor keys */
260 int no_applic_k; /* totally disable app keypad */
261 int app_cursor;
262 int app_keypad;
263 int nethack_keypad;
264 int telnet_keyboard;
265 int alt_f4; /* is it special? */
266 int alt_space; /* is it special? */
267 int alt_only; /* is it special? */
268 int localecho;
269 int localedit;
270 int alwaysontop;
271 int scroll_on_key;
272 int scroll_on_disp;
273 int compose_key;
274 int ctrlaltkeys;
275 char wintitle[256]; /* initial window title */
276 /* Terminal options */
277 int savelines;
278 int dec_om;
279 int wrap_mode;
280 int lfhascr;
281 int cursor_type; /* 0=block 1=underline 2=vertical */
282 int blink_cur;
283 enum {
284 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
285 } beep;
286 enum {
287 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
288 } beep_ind;
289 int bellovl; /* bell overload protection active? */
290 int bellovl_n; /* number of bells to cause overload */
291 int bellovl_t; /* time interval for overload (seconds) */
292 int bellovl_s; /* period of silence to re-enable bell (s) */
293 char bell_wavefile[FILENAME_MAX];
294 int scrollbar;
295 int locksize;
296 int bce;
297 int blinktext;
298 int win_name_always;
299 int width, height;
300 char font[64];
301 int fontisbold;
302 int fontheight;
303 int fontcharset;
304 char logfilename[FILENAME_MAX];
305 int logtype;
306 int logxfovr;
307 int hide_mouseptr;
308 int sunken_edge;
309 char answerback[256];
310 /* Colour options */
311 int try_palette;
312 int bold_colour;
313 unsigned char colours[22][3];
314 /* Selection options */
315 int mouse_is_xterm;
316 int rawcnp;
317 short wordness[256];
318 /* translations */
319 VT_Mode vtmode;
320 char line_codepage[32];
321 /* X11 forwarding */
322 int x11_forward;
323 char x11_display[128];
324 /* port forwarding */
325 int lport_acceptall; /* accepts connection from hosts other than localhost */
326 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
327 } Config;
328
329 /*
330 * You can compile with -DSSH_DEFAULT to have ssh by default.
331 */
332 #ifndef SSH_DEFAULT
333 #define DEFAULT_PROTOCOL PROT_TELNET
334 #define DEFAULT_PORT 23
335 #else
336 #define DEFAULT_PROTOCOL PROT_SSH
337 #define DEFAULT_PORT 22
338 #endif
339
340 /*
341 * Some global flags denoting the type of application.
342 *
343 * FLAG_VERBOSE is set when the user requests verbose details.
344 *
345 * FLAG_STDERR is set in command-line applications (which have a
346 * functioning stderr that it makes sense to write to) and not in
347 * GUI applications (which don't).
348 *
349 * FLAG_INTERACTIVE is set when a full interactive shell session is
350 * being run, _either_ because no remote command has been provided
351 * _or_ because the application is GUI and can't run non-
352 * interactively.
353 */
354 #define FLAG_VERBOSE 0x0001
355 #define FLAG_STDERR 0x0002
356 #define FLAG_INTERACTIVE 0x0004
357 GLOBAL int flags;
358
359 GLOBAL Config cfg;
360 GLOBAL int default_protocol;
361 GLOBAL int default_port;
362
363 struct RSAKey; /* be a little careful of scope */
364
365 /*
366 * Exports from window.c.
367 */
368 void request_resize(int, int, int);
369 void do_text(Context, int, int, char *, int, unsigned long, int);
370 void do_cursor(Context, int, int, char *, int, unsigned long, int);
371 void set_title(char *);
372 void set_icon(char *);
373 void set_sbar(int, int, int);
374 Context get_ctx(void);
375 void free_ctx(Context);
376 void palette_set(int, int, int, int);
377 void palette_reset(void);
378 void write_aclip(char *, int, int);
379 void write_clip(wchar_t *, int, int);
380 void get_clip(wchar_t **, int *);
381 void optimised_move(int, int, int);
382 void set_raw_mouse_mode(int);
383 Mouse_Button translate_button(Mouse_Button b);
384 void connection_fatal(char *, ...);
385 void fatalbox(char *, ...);
386 void beep(int);
387 void begin_session(void);
388 void sys_cursor(int x, int y);
389 #define OPTIMISE_IS_SCROLL 1
390
391 /*
392 * Exports from noise.c.
393 */
394 void noise_get_heavy(void (*func) (void *, int));
395 void noise_get_light(void (*func) (void *, int));
396 void noise_regular(void);
397 void noise_ultralight(DWORD data);
398 void random_save_seed(void);
399 void random_destroy_seed(void);
400
401 /*
402 * Exports from windlg.c.
403 */
404 void defuse_showwindow(void);
405 int do_config(void);
406 int do_reconfig(HWND);
407 void do_defaults(char *, Config *);
408 void logevent(char *);
409 void showeventlog(HWND);
410 void showabout(HWND);
411 void verify_ssh_host_key(char *host, int port, char *keytype,
412 char *keystr, char *fingerprint);
413 int askappend(char *filename);
414 void registry_cleanup(void);
415 void force_normal(HWND hwnd);
416
417 GLOBAL int nsessions;
418 GLOBAL char **sessions;
419
420 /*
421 * Exports from settings.c.
422 */
423 void save_settings(char *section, int do_host, Config * cfg);
424 void load_settings(char *section, int do_host, Config * cfg);
425 void get_sesslist(int allocate);
426
427 /*
428 * Exports from terminal.c.
429 */
430
431 void term_init(void);
432 void term_size(int, int, int);
433 void term_out(void);
434 void term_paint(Context, int, int, int, int);
435 void term_scroll(int, int);
436 void term_pwron(void);
437 void term_clrsb(void);
438 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int);
439 void term_deselect(void);
440 void term_update(void);
441 void term_invalidate(void);
442 void term_blink(int set_cursor);
443 void term_do_paste(void);
444 void term_paste(void);
445 void term_nopaste(void);
446 int term_ldisc(int option);
447 int from_backend(int is_stderr, char *data, int len);
448 void logfopen(void);
449 void logfclose(void);
450 void term_copyall(void);
451
452 /*
453 * Exports from raw.c.
454 */
455
456 extern Backend raw_backend;
457
458 /*
459 * Exports from rlogin.c.
460 */
461
462 extern Backend rlogin_backend;
463
464 /*
465 * Exports from telnet.c.
466 */
467
468 extern Backend telnet_backend;
469
470 /*
471 * Exports from ssh.c.
472 */
473
474 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
475 int is_pw);
476 extern Backend ssh_backend;
477
478 /*
479 * Exports from ldisc.c.
480 */
481
482 extern void ldisc_send(char *buf, int len);
483
484 /*
485 * Exports from sshrand.c.
486 */
487
488 void random_add_noise(void *noise, int length);
489 void random_init(void);
490 int random_byte(void);
491 void random_get_savedata(void **data, int *len);
492
493 /*
494 * Exports from misc.c.
495 */
496
497 #include "misc.h"
498
499 /*
500 * Exports from version.c.
501 */
502 extern char ver[];
503
504 /*
505 * Exports from sizetip.c.
506 */
507 void UpdateSizeTip(HWND src, int cx, int cy);
508 void EnableSizeTip(int bEnable);
509
510 /*
511 * Exports from unicode.c.
512 */
513 #ifndef CP_UTF8
514 #define CP_UTF8 65001
515 #endif
516 void init_ucs_tables(void);
517 void lpage_send(int codepage, char *buf, int len);
518 void luni_send(wchar_t * widebuf, int len);
519 int check_compose(int first, int second);
520 int decode_codepage(char *cp_name);
521 char *cp_enumerate (int index);
522 char *cp_name(int codepage);
523
524 /*
525 * Exports from mscrypto.c
526 */
527 #ifdef MSCRYPTOAPI
528 int crypto_startup();
529 void crypto_wrapup();
530 #endif
531
532 /*
533 * Exports from pageantc.c
534 */
535 void agent_query(void *in, int inlen, void **out, int *outlen);
536 int agent_exists(void);
537
538
539 #endif