Improve socket error handling so that a socket error isn't an
[u/mdw/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
8df7a775 4#include "network.h"
5
374330e2 6#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
de3df031 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"
374330e2 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#define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */
24#define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */
25#define ATTR_INVALID 0x20000000UL
26#define ATTR_WRAPPED 0x10000000UL
4e30ff69 27#define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */
374330e2 28
c9def1b8 29#define LATTR_NORM 0x00000000UL
30#define LATTR_WIDE 0x01000000UL
31#define LATTR_TOP 0x02000000UL
32#define LATTR_BOT 0x03000000UL
33#define LATTR_MODE 0x03000000UL
34
374330e2 35#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
36#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
37#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
38
39#define ATTR_BOLD 0x00000100UL
40#define ATTR_UNDER 0x00000200UL
41#define ATTR_REVERSE 0x00000400UL
e14a5a13 42#define ATTR_BLINK 0x00000800UL
374330e2 43#define ATTR_FGMASK 0x0000F000UL
44#define ATTR_BGMASK 0x000F0000UL
45#define ATTR_FGSHIFT 12
46#define ATTR_BGSHIFT 16
47
48#define ATTR_DEFAULT 0x00098000UL
49#define ATTR_DEFFG 0x00008000UL
50#define ATTR_DEFBG 0x00090000UL
51#define ATTR_CUR_XOR 0x000BA000UL
52#define ERASE_CHAR (ATTR_DEFAULT | ' ')
53#define ATTR_MASK 0xFFFFFF00UL
54#define CHAR_MASK 0x000000FFUL
55
56typedef HDC Context;
57#define SEL_NL { 13, 10 }
58
59GLOBAL int rows, cols, savelines;
60
61GLOBAL int font_width, font_height;
62
63#define INBUF_SIZE 2048
374330e2 64GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 65GLOBAL int inbuf_head;
374330e2 66
67#define OUTBUF_SIZE 2048
68#define OUTBUF_MASK (OUTBUF_SIZE-1)
69GLOBAL unsigned char outbuf[OUTBUF_SIZE];
70GLOBAL int outbuf_head, outbuf_reap;
71
72GLOBAL int has_focus;
73
c9def1b8 74GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
75GLOBAL int repeat_off, cr_lf_return;
374330e2 76
cabfd08c 77GLOBAL int seen_key_event;
78GLOBAL int seen_disp_event;
79
d85548fe 80GLOBAL int session_closed;
81
e1c8e0ed 82#define LGTYP_NONE 0 /* logmode: no logging */
83#define LGTYP_ASCII 1 /* logmode: pure ascii */
84#define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
5fd04f07 85GLOBAL char *logfile;
86
e14a5a13 87/*
475eebf9 88 * Window handles for the dialog boxes that can be running during a
89 * PuTTY session.
90 */
91GLOBAL HWND logbox;
92
93/*
e14a5a13 94 * I've just looked in the windows standard headr files for WM_USER, there
95 * are hundreds of flags defined using the form WM_USER+123 so I've
96 * renumbered this NETEVENT value and the two in window.c
97 */
98#define WM_XUSER (WM_USER + 0x2000)
99#define WM_NETEVENT (WM_XUSER + 5)
374330e2 100
101typedef enum {
102 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
ec55b220 103 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
374330e2 104} Telnet_Special;
105
106typedef enum {
107 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
108} Mouse_Button;
109
110typedef enum {
111 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
112} Mouse_Action;
113
114typedef enum {
115 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
116} VT_Mode;
117
118typedef struct {
8df7a775 119 char *(*init) (char *host, int port, char **realhost);
374330e2 120 void (*send) (char *buf, int len);
121 void (*size) (void);
122 void (*special) (Telnet_Special code);
8df7a775 123 Socket (*socket) (void);
8ccc75b0 124 int (*sendok) (void);
97db3be4 125 int default_port;
374330e2 126} Backend;
127
128GLOBAL Backend *back;
129
297d398b 130extern struct backend_list {
89ee5268 131 int protocol;
132 char *name;
133 Backend *backend;
134} backends[];
135
374330e2 136typedef struct {
5bc238bb 137 void (*send) (char *buf, int len);
138} Ldisc;
139
140GLOBAL Ldisc *ldisc;
141
142typedef struct {
374330e2 143 /* Basic options */
144 char host[512];
145 int port;
c91409da 146 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 147 int close_on_exit;
9ef49106 148 int warn_on_close;
edce8e45 149 int ping_interval; /* in seconds */
fef97f43 150 /* SSH options */
6abbf9e3 151 char remote_cmd[512];
fef97f43 152 int nopty;
4ba9b64b 153 int compression;
979310f1 154 int agentfwd;
9697bfd2 155 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 156 char keyfile[FILENAME_MAX];
adf799dd 157 int sshprot; /* use v1 or v2 when both available */
7591b9ff 158 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 159 int try_tis_auth;
374330e2 160 /* Telnet options */
161 char termtype[32];
162 char termspeed[32];
37508af4 163 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 164 char username[32];
c91409da 165 char localusername[32];
374330e2 166 int rfc_environ;
167 /* Keyboard options */
168 int bksp_is_delete;
169 int rxvt_homeend;
c9def1b8 170 int funky_type;
b00f8b34 171 int no_applic_c; /* totally disable app cursor keys */
172 int no_applic_k; /* totally disable app keypad */
374330e2 173 int app_cursor;
174 int app_keypad;
c5e9c988 175 int nethack_keypad;
176 int alt_f4; /* is it special? */
177 int alt_space; /* is it special? */
a094ae43 178 int alt_only; /* is it special? */
5bc238bb 179 int ldisc_term;
e95edc00 180 int alwaysontop;
c9def1b8 181 int scroll_on_key;
a094ae43 182 int scroll_on_disp;
183 int compose_key;
9ca5da42 184 char wintitle[256]; /* initial window title */
374330e2 185 /* Terminal options */
186 int savelines;
187 int dec_om;
188 int wrap_mode;
fef97f43 189 int lfhascr;
4e30ff69 190 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 191 int blink_cur;
192 int beep;
193 int scrollbar;
194 int locksize;
195 int bce;
196 int blinktext;
374330e2 197 int win_name_always;
198 int width, height;
199 char font[64];
200 int fontisbold;
201 int fontheight;
14963b8f 202 int fontcharset;
e1c8e0ed 203 char logfilename[FILENAME_MAX];
204 int logtype;
554c540d 205 int hide_mouseptr;
374330e2 206 /* Colour options */
207 int try_palette;
208 int bold_colour;
209 unsigned char colours[22][3];
210 /* Selection options */
211 int mouse_is_xterm;
212 short wordness[256];
c9def1b8 213 /* translations */
214 VT_Mode vtmode;
14963b8f 215 int xlat_enablekoiwin;
d3d16feb 216 int xlat_88592w1250;
b0faa571 217 int xlat_88592cp852;
14963b8f 218 int xlat_capslockcyr;
9c964e85 219 /* X11 forwarding */
220 int x11_forward;
221 char x11_display[128];
374330e2 222} Config;
223
e277c42d 224/*
225 * You can compile with -DSSH_DEFAULT to have ssh by default.
226 */
227#ifndef SSH_DEFAULT
228#define DEFAULT_PROTOCOL PROT_TELNET
229#define DEFAULT_PORT 23
230#else
231#define DEFAULT_PROTOCOL PROT_SSH
232#define DEFAULT_PORT 22
233#endif
234
4017be6d 235/*
236 * Some global flags denoting the type of application.
67779be7 237 *
238 * FLAG_VERBOSE is set when the user requests verbose details.
239 *
240 * FLAG_STDERR is set in command-line applications (which have a
241 * functioning stderr that it makes sense to write to) and not in
242 * GUI applications (which don't).
243 *
244 * FLAG_INTERACTIVE is set when a full interactive shell session is
245 * being run, _either_ because no remote command has been provided
246 * _or_ because the application is GUI and can't run non-
247 * interactively.
4017be6d 248 */
67779be7 249#define FLAG_VERBOSE 0x0001
250#define FLAG_STDERR 0x0002
251#define FLAG_INTERACTIVE 0x0004
4017be6d 252GLOBAL int flags;
253
374330e2 254GLOBAL Config cfg;
e277c42d 255GLOBAL int default_protocol;
256GLOBAL int default_port;
374330e2 257
4e23b276 258struct RSAKey; /* be a little careful of scope */
259
374330e2 260/*
261 * Exports from window.c.
262 */
e14a5a13 263void request_resize (int, int, int);
c9def1b8 264void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 265void set_title (char *);
266void set_icon (char *);
267void set_sbar (int, int, int);
f67b4e85 268Context get_ctx(void);
374330e2 269void free_ctx (Context);
270void palette_set (int, int, int, int);
271void palette_reset (void);
f0df44da 272void write_clip (void *, int, int);
374330e2 273void get_clip (void **, int *);
274void optimised_move (int, int, int);
8d5de777 275void connection_fatal(char *, ...);
374330e2 276void fatalbox (char *, ...);
c9def1b8 277void beep (int);
6f34e365 278void begin_session(void);
ec8679e9 279void sys_cursor(int x, int y);
374330e2 280#define OPTIMISE_IS_SCROLL 1
281
282/*
283 * Exports from noise.c.
284 */
7d6ee6ff 285void noise_get_heavy(void (*func)(void *, int));
286void noise_get_light(void (*func)(void *, int));
287void noise_regular(void);
374330e2 288void noise_ultralight(DWORD data);
289void random_save_seed(void);
de3df031 290void random_destroy_seed(void);
374330e2 291
292/*
293 * Exports from windlg.c.
294 */
8c3cd914 295void defuse_showwindow(void);
374330e2 296int do_config (void);
297int do_reconfig (HWND);
a9422f39 298void do_defaults (char *, Config *);
c5e9c988 299void logevent (char *);
300void showeventlog (HWND);
374330e2 301void showabout (HWND);
d4857987 302void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 303 char *keystr, char *fingerprint);
e1c8e0ed 304int askappend(char *filename);
de3df031 305void registry_cleanup(void);
3da0b1d2 306void force_normal(HWND hwnd);
0a4aa984 307
7393a137 308GLOBAL int nsessions;
309GLOBAL char **sessions;
374330e2 310
311/*
a9422f39 312 * Exports from settings.c.
313 */
314void save_settings (char *section, int do_host, Config *cfg);
315void load_settings (char *section, int do_host, Config *cfg);
316void get_sesslist(int allocate);
317
318/*
374330e2 319 * Exports from terminal.c.
320 */
321
322void term_init (void);
323void term_size (int, int, int);
324void term_out (void);
325void term_paint (Context, int, int, int, int);
326void term_scroll (int, int);
327void term_pwron (void);
328void term_clrsb (void);
329void term_mouse (Mouse_Button, Mouse_Action, int, int);
330void term_deselect (void);
331void term_update (void);
332void term_invalidate(void);
e14a5a13 333void term_blink(int set_cursor);
c9def1b8 334void term_paste(void);
335void term_nopaste(void);
fe50e814 336void from_backend(int is_stderr, char *data, int len);
e1c8e0ed 337void logfopen (void);
338void logfclose (void);
bc1235d4 339void term_copyall(void);
374330e2 340
341/*
5e1a8e27 342 * Exports from raw.c.
343 */
344
3d9a14c9 345extern Backend raw_backend;
5e1a8e27 346
347/*
c91409da 348 * Exports from rlogin.c.
349 */
350
351extern Backend rlogin_backend;
352
353/*
374330e2 354 * Exports from telnet.c.
355 */
356
c14776e8 357extern Backend telnet_backend;
374330e2 358
359/*
360 * Exports from ssh.c.
361 */
362
67779be7 363extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
c14776e8 364extern Backend ssh_backend;
374330e2 365
366/*
5bc238bb 367 * Exports from ldisc.c.
368 */
369
370extern Ldisc ldisc_term, ldisc_simple;
371
372/*
374330e2 373 * Exports from sshrand.c.
374 */
375
376void random_add_noise(void *noise, int length);
377void random_init(void);
378int random_byte(void);
379void random_get_savedata(void **data, int *len);
380
381/*
382 * Exports from misc.c.
383 */
384
dcbde236 385#include "puttymem.h"
374330e2 386
387/*
067a15ea 388 * Exports from version.c.
389 */
390extern char ver[];
391
392/*
b73fd1b1 393 * Exports from sizetip.c.
394 */
395void UpdateSizeTip(HWND src, int cx, int cy);
396void EnableSizeTip(int bEnable);
397
398/*
14963b8f 399 * Exports from xlat.c.
400 */
401unsigned char xlat_kbd2tty(unsigned char c);
402unsigned char xlat_tty2scr(unsigned char c);
403unsigned char xlat_latkbd2win(unsigned char c);
404
405/*
8f203108 406 * Exports from mscrypto.c
407 */
408#ifdef MSCRYPTOAPI
409int crypto_startup();
410void crypto_wrapup();
411#endif
412
413/*
5c58ad2d 414 * Exports from pageantc.c
415 */
416void agent_query(void *in, int inlen, void **out, int *outlen);
417int agent_exists(void);
418
374330e2 419#ifdef DEBUG
c82bda52 420void dprintf(char *fmt, ...);
374330e2 421#define debug(x) (dprintf x)
374330e2 422#else
423#define debug(x)
424#endif
425
426#endif