Stop plink losing data at start of session
[u/mdw/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
4#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
5
6/*
7 * Global variables. Most modules declare these `extern', but
8 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
9 * module, and so will get them properly defined.
10 */
11#ifdef PUTTY_DO_GLOBALS
12#define GLOBAL
13#else
14#define GLOBAL extern
15#endif
16
73251d5d 17GLOBAL HINSTANCE putty_inst;
18
374330e2 19#define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */
20#define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */
21#define ATTR_INVALID 0x20000000UL
22#define ATTR_WRAPPED 0x10000000UL
23
c9def1b8 24#define LATTR_NORM 0x00000000UL
25#define LATTR_WIDE 0x01000000UL
26#define LATTR_TOP 0x02000000UL
27#define LATTR_BOT 0x03000000UL
28#define LATTR_MODE 0x03000000UL
29
374330e2 30#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
31#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
32#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
33
34#define ATTR_BOLD 0x00000100UL
35#define ATTR_UNDER 0x00000200UL
36#define ATTR_REVERSE 0x00000400UL
e14a5a13 37#define ATTR_BLINK 0x00000800UL
374330e2 38#define ATTR_FGMASK 0x0000F000UL
39#define ATTR_BGMASK 0x000F0000UL
40#define ATTR_FGSHIFT 12
41#define ATTR_BGSHIFT 16
42
43#define ATTR_DEFAULT 0x00098000UL
44#define ATTR_DEFFG 0x00008000UL
45#define ATTR_DEFBG 0x00090000UL
46#define ATTR_CUR_XOR 0x000BA000UL
47#define ERASE_CHAR (ATTR_DEFAULT | ' ')
48#define ATTR_MASK 0xFFFFFF00UL
49#define CHAR_MASK 0x000000FFUL
50
51typedef HDC Context;
52#define SEL_NL { 13, 10 }
53
54GLOBAL int rows, cols, savelines;
55
56GLOBAL int font_width, font_height;
57
c9def1b8 58#define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
59 inbuf[inbuf_head++] = (_C) ; } while(0)
374330e2 60#define INBUF_SIZE 2048
374330e2 61GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 62GLOBAL int inbuf_head;
374330e2 63
64#define OUTBUF_SIZE 2048
65#define OUTBUF_MASK (OUTBUF_SIZE-1)
66GLOBAL unsigned char outbuf[OUTBUF_SIZE];
67GLOBAL int outbuf_head, outbuf_reap;
68
69GLOBAL int has_focus;
70
c9def1b8 71GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
72GLOBAL int repeat_off, cr_lf_return;
374330e2 73
cabfd08c 74GLOBAL int seen_key_event;
75GLOBAL int seen_disp_event;
76
d85548fe 77GLOBAL int session_closed;
78
5fd04f07 79GLOBAL char *logfile;
80
e14a5a13 81/*
82 * I've just looked in the windows standard headr files for WM_USER, there
83 * are hundreds of flags defined using the form WM_USER+123 so I've
84 * renumbered this NETEVENT value and the two in window.c
85 */
86#define WM_XUSER (WM_USER + 0x2000)
87#define WM_NETEVENT (WM_XUSER + 5)
374330e2 88
89typedef enum {
90 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
684d367c 91 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO
374330e2 92} Telnet_Special;
93
94typedef enum {
95 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
96} Mouse_Button;
97
98typedef enum {
99 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
100} Mouse_Action;
101
102typedef enum {
103 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
104} VT_Mode;
105
106typedef struct {
107 char *(*init) (HWND hwnd, char *host, int port, char **realhost);
108 int (*msg) (WPARAM wParam, LPARAM lParam);
109 void (*send) (char *buf, int len);
110 void (*size) (void);
111 void (*special) (Telnet_Special code);
4017be6d 112 SOCKET (*socket) (void);
8ccc75b0 113 int (*sendok) (void);
374330e2 114} Backend;
115
116GLOBAL Backend *back;
117
297d398b 118extern struct backend_list {
89ee5268 119 int protocol;
120 char *name;
121 Backend *backend;
122} backends[];
123
374330e2 124typedef struct {
5bc238bb 125 void (*send) (char *buf, int len);
126} Ldisc;
127
128GLOBAL Ldisc *ldisc;
129
130typedef struct {
374330e2 131 /* Basic options */
132 char host[512];
133 int port;
5e1a8e27 134 enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2 135 int close_on_exit;
9ef49106 136 int warn_on_close;
fef97f43 137 /* SSH options */
6abbf9e3 138 char remote_cmd[512];
fef97f43 139 int nopty;
9697bfd2 140 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 141 char keyfile[FILENAME_MAX];
ccbfb941 142 int try_tis_auth;
374330e2 143 /* Telnet options */
144 char termtype[32];
145 char termspeed[32];
37508af4 146 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 147 char username[32];
148 int rfc_environ;
149 /* Keyboard options */
150 int bksp_is_delete;
151 int rxvt_homeend;
c9def1b8 152 int funky_type;
374330e2 153 int app_cursor;
154 int app_keypad;
c5e9c988 155 int nethack_keypad;
156 int alt_f4; /* is it special? */
157 int alt_space; /* is it special? */
5bc238bb 158 int ldisc_term;
c9def1b8 159 int scroll_on_key;
374330e2 160 /* Terminal options */
161 int savelines;
162 int dec_om;
163 int wrap_mode;
fef97f43 164 int lfhascr;
c9def1b8 165 int blink_cur;
166 int beep;
167 int scrollbar;
168 int locksize;
169 int bce;
170 int blinktext;
374330e2 171 int win_name_always;
172 int width, height;
173 char font[64];
174 int fontisbold;
175 int fontheight;
14963b8f 176 int fontcharset;
374330e2 177 /* Colour options */
178 int try_palette;
179 int bold_colour;
180 unsigned char colours[22][3];
181 /* Selection options */
182 int mouse_is_xterm;
183 short wordness[256];
c9def1b8 184 /* translations */
185 VT_Mode vtmode;
14963b8f 186 int xlat_enablekoiwin;
d3d16feb 187 int xlat_88592w1250;
14963b8f 188 int xlat_capslockcyr;
374330e2 189} Config;
190
e277c42d 191/*
192 * You can compile with -DSSH_DEFAULT to have ssh by default.
193 */
194#ifndef SSH_DEFAULT
195#define DEFAULT_PROTOCOL PROT_TELNET
196#define DEFAULT_PORT 23
197#else
198#define DEFAULT_PROTOCOL PROT_SSH
199#define DEFAULT_PORT 22
200#endif
201
4017be6d 202/*
203 * Some global flags denoting the type of application.
204 */
205#define FLAG_VERBOSE 0x0001
206#define FLAG_WINDOWED 0x0002
207#define FLAG_CONNECTION 0x0004
208GLOBAL int flags;
209
374330e2 210GLOBAL Config cfg;
e277c42d 211GLOBAL int default_protocol;
212GLOBAL int default_port;
374330e2 213
4e23b276 214struct RSAKey; /* be a little careful of scope */
215
374330e2 216/*
217 * Exports from window.c.
218 */
e14a5a13 219void request_resize (int, int, int);
c9def1b8 220void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 221void set_title (char *);
222void set_icon (char *);
223void set_sbar (int, int, int);
f67b4e85 224Context get_ctx(void);
374330e2 225void free_ctx (Context);
226void palette_set (int, int, int, int);
227void palette_reset (void);
228void write_clip (void *, int);
229void get_clip (void **, int *);
230void optimised_move (int, int, int);
231void fatalbox (char *, ...);
c9def1b8 232void beep (int);
374330e2 233#define OPTIMISE_IS_SCROLL 1
234
235/*
236 * Exports from noise.c.
237 */
238void noise_get_heavy(void (*func) (void *, int));
239void noise_get_light(void (*func) (void *, int));
240void noise_ultralight(DWORD data);
241void random_save_seed(void);
242
243/*
244 * Exports from windlg.c.
245 */
246int do_config (void);
247int do_reconfig (HWND);
248void do_defaults (char *);
c5e9c988 249void logevent (char *);
250void showeventlog (HWND);
374330e2 251void showabout (HWND);
89ee5268 252void verify_ssh_host_key(char *host, char *keystr);
0a4aa984 253void get_sesslist(int allocate);
254
7393a137 255GLOBAL int nsessions;
256GLOBAL char **sessions;
374330e2 257
258/*
259 * Exports from terminal.c.
260 */
261
262void term_init (void);
263void term_size (int, int, int);
264void term_out (void);
265void term_paint (Context, int, int, int, int);
266void term_scroll (int, int);
267void term_pwron (void);
268void term_clrsb (void);
269void term_mouse (Mouse_Button, Mouse_Action, int, int);
270void term_deselect (void);
271void term_update (void);
272void term_invalidate(void);
e14a5a13 273void term_blink(int set_cursor);
c9def1b8 274void term_paste(void);
275void term_nopaste(void);
374330e2 276
277/*
5e1a8e27 278 * Exports from raw.c.
279 */
280
3d9a14c9 281extern Backend raw_backend;
5e1a8e27 282
283/*
374330e2 284 * Exports from telnet.c.
285 */
286
c14776e8 287extern Backend telnet_backend;
374330e2 288
289/*
290 * Exports from ssh.c.
291 */
292
c14776e8 293extern Backend ssh_backend;
374330e2 294
295/*
5bc238bb 296 * Exports from ldisc.c.
297 */
298
299extern Ldisc ldisc_term, ldisc_simple;
300
301/*
374330e2 302 * Exports from sshrand.c.
303 */
304
305void random_add_noise(void *noise, int length);
306void random_init(void);
307int random_byte(void);
308void random_get_savedata(void **data, int *len);
309
310/*
311 * Exports from misc.c.
312 */
313
314/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
315#ifdef MALLOC_LOG
316#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
317#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
318#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
319void mlog(char *, int);
320#else
321#define smalloc safemalloc
322#define srealloc saferealloc
323#define sfree safefree
324#endif
325
326void *safemalloc(size_t);
327void *saferealloc(void *, size_t);
328void safefree(void *);
329
330/*
067a15ea 331 * Exports from version.c.
332 */
333extern char ver[];
334
335/*
b73fd1b1 336 * Exports from sizetip.c.
337 */
338void UpdateSizeTip(HWND src, int cx, int cy);
339void EnableSizeTip(int bEnable);
340
341/*
14963b8f 342 * Exports from xlat.c.
343 */
344unsigned char xlat_kbd2tty(unsigned char c);
345unsigned char xlat_tty2scr(unsigned char c);
346unsigned char xlat_latkbd2win(unsigned char c);
347
348/*
8f203108 349 * Exports from mscrypto.c
350 */
351#ifdef MSCRYPTOAPI
352int crypto_startup();
353void crypto_wrapup();
354#endif
355
356/*
374330e2 357 * A debug system.
358 */
359#ifdef DEBUG
360#include <stdarg.h>
361#define debug(x) (dprintf x)
362static void dprintf(char *fmt, ...) {
363 char buf[2048];
364 DWORD dw;
365 va_list ap;
366 static int gotconsole = 0;
367
368 if (!gotconsole) {
369 AllocConsole();
370 gotconsole = 1;
371 }
372
373 va_start(ap, fmt);
374 vsprintf(buf, fmt, ap);
375 WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
376 va_end(ap);
377}
378#else
379#define debug(x)
380#endif
381
382#endif