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