Keepalives are now in seconds not minutes
[sgt/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/*
88 * I've just looked in the windows standard headr files for WM_USER, there
89 * are hundreds of flags defined using the form WM_USER+123 so I've
90 * renumbered this NETEVENT value and the two in window.c
91 */
92#define WM_XUSER (WM_USER + 0x2000)
93#define WM_NETEVENT (WM_XUSER + 5)
374330e2 94
95typedef enum {
96 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
ec55b220 97 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
374330e2 98} Telnet_Special;
99
100typedef enum {
101 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
102} Mouse_Button;
103
104typedef enum {
105 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
106} Mouse_Action;
107
108typedef enum {
109 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
110} VT_Mode;
111
112typedef struct {
8df7a775 113 char *(*init) (char *host, int port, char **realhost);
374330e2 114 void (*send) (char *buf, int len);
115 void (*size) (void);
116 void (*special) (Telnet_Special code);
8df7a775 117 Socket (*socket) (void);
8ccc75b0 118 int (*sendok) (void);
97db3be4 119 int default_port;
374330e2 120} Backend;
121
122GLOBAL Backend *back;
123
297d398b 124extern struct backend_list {
89ee5268 125 int protocol;
126 char *name;
127 Backend *backend;
128} backends[];
129
374330e2 130typedef struct {
5bc238bb 131 void (*send) (char *buf, int len);
132} Ldisc;
133
134GLOBAL Ldisc *ldisc;
135
136typedef struct {
374330e2 137 /* Basic options */
138 char host[512];
139 int port;
5e1a8e27 140 enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2 141 int close_on_exit;
9ef49106 142 int warn_on_close;
edce8e45 143 int ping_interval; /* in seconds */
fef97f43 144 /* SSH options */
6abbf9e3 145 char remote_cmd[512];
fef97f43 146 int nopty;
4ba9b64b 147 int compression;
979310f1 148 int agentfwd;
9697bfd2 149 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 150 char keyfile[FILENAME_MAX];
adf799dd 151 int sshprot; /* use v1 or v2 when both available */
7591b9ff 152 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 153 int try_tis_auth;
374330e2 154 /* Telnet options */
155 char termtype[32];
156 char termspeed[32];
37508af4 157 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 158 char username[32];
159 int rfc_environ;
160 /* Keyboard options */
161 int bksp_is_delete;
162 int rxvt_homeend;
c9def1b8 163 int funky_type;
b00f8b34 164 int no_applic_c; /* totally disable app cursor keys */
165 int no_applic_k; /* totally disable app keypad */
374330e2 166 int app_cursor;
167 int app_keypad;
c5e9c988 168 int nethack_keypad;
169 int alt_f4; /* is it special? */
170 int alt_space; /* is it special? */
a094ae43 171 int alt_only; /* is it special? */
5bc238bb 172 int ldisc_term;
e95edc00 173 int alwaysontop;
c9def1b8 174 int scroll_on_key;
a094ae43 175 int scroll_on_disp;
176 int compose_key;
9ca5da42 177 char wintitle[256]; /* initial window title */
374330e2 178 /* Terminal options */
179 int savelines;
180 int dec_om;
181 int wrap_mode;
fef97f43 182 int lfhascr;
4e30ff69 183 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 184 int blink_cur;
185 int beep;
186 int scrollbar;
187 int locksize;
188 int bce;
189 int blinktext;
374330e2 190 int win_name_always;
191 int width, height;
192 char font[64];
193 int fontisbold;
194 int fontheight;
14963b8f 195 int fontcharset;
e1c8e0ed 196 char logfilename[FILENAME_MAX];
197 int logtype;
374330e2 198 /* Colour options */
199 int try_palette;
200 int bold_colour;
201 unsigned char colours[22][3];
202 /* Selection options */
203 int mouse_is_xterm;
204 short wordness[256];
c9def1b8 205 /* translations */
206 VT_Mode vtmode;
14963b8f 207 int xlat_enablekoiwin;
d3d16feb 208 int xlat_88592w1250;
b0faa571 209 int xlat_88592cp852;
14963b8f 210 int xlat_capslockcyr;
374330e2 211} Config;
212
e277c42d 213/*
214 * You can compile with -DSSH_DEFAULT to have ssh by default.
215 */
216#ifndef SSH_DEFAULT
217#define DEFAULT_PROTOCOL PROT_TELNET
218#define DEFAULT_PORT 23
219#else
220#define DEFAULT_PROTOCOL PROT_SSH
221#define DEFAULT_PORT 22
222#endif
223
4017be6d 224/*
225 * Some global flags denoting the type of application.
67779be7 226 *
227 * FLAG_VERBOSE is set when the user requests verbose details.
228 *
229 * FLAG_STDERR is set in command-line applications (which have a
230 * functioning stderr that it makes sense to write to) and not in
231 * GUI applications (which don't).
232 *
233 * FLAG_INTERACTIVE is set when a full interactive shell session is
234 * being run, _either_ because no remote command has been provided
235 * _or_ because the application is GUI and can't run non-
236 * interactively.
4017be6d 237 */
67779be7 238#define FLAG_VERBOSE 0x0001
239#define FLAG_STDERR 0x0002
240#define FLAG_INTERACTIVE 0x0004
4017be6d 241GLOBAL int flags;
242
374330e2 243GLOBAL Config cfg;
e277c42d 244GLOBAL int default_protocol;
245GLOBAL int default_port;
374330e2 246
4e23b276 247struct RSAKey; /* be a little careful of scope */
248
374330e2 249/*
250 * Exports from window.c.
251 */
e14a5a13 252void request_resize (int, int, int);
c9def1b8 253void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 254void set_title (char *);
255void set_icon (char *);
256void set_sbar (int, int, int);
f67b4e85 257Context get_ctx(void);
374330e2 258void free_ctx (Context);
259void palette_set (int, int, int, int);
260void palette_reset (void);
f0df44da 261void write_clip (void *, int, int);
374330e2 262void get_clip (void **, int *);
263void optimised_move (int, int, int);
8d5de777 264void connection_fatal(char *, ...);
374330e2 265void fatalbox (char *, ...);
c9def1b8 266void beep (int);
6f34e365 267void begin_session(void);
ec8679e9 268void sys_cursor(int x, int y);
374330e2 269#define OPTIMISE_IS_SCROLL 1
270
271/*
272 * Exports from noise.c.
273 */
7d6ee6ff 274void noise_get_heavy(void (*func)(void *, int));
275void noise_get_light(void (*func)(void *, int));
276void noise_regular(void);
374330e2 277void noise_ultralight(DWORD data);
278void random_save_seed(void);
de3df031 279void random_destroy_seed(void);
374330e2 280
281/*
282 * Exports from windlg.c.
283 */
8c3cd914 284void defuse_showwindow(void);
374330e2 285int do_config (void);
286int do_reconfig (HWND);
a9422f39 287void do_defaults (char *, Config *);
c5e9c988 288void logevent (char *);
289void showeventlog (HWND);
374330e2 290void showabout (HWND);
d4857987 291void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 292 char *keystr, char *fingerprint);
e1c8e0ed 293int askappend(char *filename);
de3df031 294void registry_cleanup(void);
3da0b1d2 295void force_normal(HWND hwnd);
0a4aa984 296
7393a137 297GLOBAL int nsessions;
298GLOBAL char **sessions;
374330e2 299
300/*
a9422f39 301 * Exports from settings.c.
302 */
303void save_settings (char *section, int do_host, Config *cfg);
304void load_settings (char *section, int do_host, Config *cfg);
305void get_sesslist(int allocate);
306
307/*
374330e2 308 * Exports from terminal.c.
309 */
310
311void term_init (void);
312void term_size (int, int, int);
313void term_out (void);
314void term_paint (Context, int, int, int, int);
315void term_scroll (int, int);
316void term_pwron (void);
317void term_clrsb (void);
318void term_mouse (Mouse_Button, Mouse_Action, int, int);
319void term_deselect (void);
320void term_update (void);
321void term_invalidate(void);
e14a5a13 322void term_blink(int set_cursor);
c9def1b8 323void term_paste(void);
324void term_nopaste(void);
fe50e814 325void from_backend(int is_stderr, char *data, int len);
e1c8e0ed 326void logfopen (void);
327void logfclose (void);
bc1235d4 328void term_copyall(void);
374330e2 329
330/*
5e1a8e27 331 * Exports from raw.c.
332 */
333
3d9a14c9 334extern Backend raw_backend;
5e1a8e27 335
336/*
374330e2 337 * Exports from telnet.c.
338 */
339
c14776e8 340extern Backend telnet_backend;
374330e2 341
342/*
343 * Exports from ssh.c.
344 */
345
67779be7 346extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
c14776e8 347extern Backend ssh_backend;
374330e2 348
349/*
5bc238bb 350 * Exports from ldisc.c.
351 */
352
353extern Ldisc ldisc_term, ldisc_simple;
354
355/*
374330e2 356 * Exports from sshrand.c.
357 */
358
359void random_add_noise(void *noise, int length);
360void random_init(void);
361int random_byte(void);
362void random_get_savedata(void **data, int *len);
363
364/*
365 * Exports from misc.c.
366 */
367
dcbde236 368#include "puttymem.h"
374330e2 369
370/*
067a15ea 371 * Exports from version.c.
372 */
373extern char ver[];
374
375/*
b73fd1b1 376 * Exports from sizetip.c.
377 */
378void UpdateSizeTip(HWND src, int cx, int cy);
379void EnableSizeTip(int bEnable);
380
381/*
14963b8f 382 * Exports from xlat.c.
383 */
384unsigned char xlat_kbd2tty(unsigned char c);
385unsigned char xlat_tty2scr(unsigned char c);
386unsigned char xlat_latkbd2win(unsigned char c);
387
388/*
8f203108 389 * Exports from mscrypto.c
390 */
391#ifdef MSCRYPTOAPI
392int crypto_startup();
393void crypto_wrapup();
394#endif
395
396/*
5c58ad2d 397 * Exports from pageantc.c
398 */
399void agent_query(void *in, int inlen, void **out, int *outlen);
400int agent_exists(void);
401
374330e2 402#ifdef DEBUG
c82bda52 403void dprintf(char *fmt, ...);
374330e2 404#define debug(x) (dprintf x)
374330e2 405#else
406#define debug(x)
407#endif
408
409#endif