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