Header file for 2-3-4 tree routines
[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];
adf799dd 142 int sshprot; /* use v1 or v2 when both available */
ccbfb941 143 int try_tis_auth;
374330e2 144 /* Telnet options */
145 char termtype[32];
146 char termspeed[32];
37508af4 147 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 148 char username[32];
149 int rfc_environ;
150 /* Keyboard options */
151 int bksp_is_delete;
152 int rxvt_homeend;
c9def1b8 153 int funky_type;
374330e2 154 int app_cursor;
155 int app_keypad;
c5e9c988 156 int nethack_keypad;
157 int alt_f4; /* is it special? */
158 int alt_space; /* is it special? */
5bc238bb 159 int ldisc_term;
c9def1b8 160 int scroll_on_key;
374330e2 161 /* Terminal options */
162 int savelines;
163 int dec_om;
164 int wrap_mode;
fef97f43 165 int lfhascr;
c9def1b8 166 int blink_cur;
167 int beep;
168 int scrollbar;
169 int locksize;
170 int bce;
171 int blinktext;
374330e2 172 int win_name_always;
173 int width, height;
174 char font[64];
175 int fontisbold;
176 int fontheight;
14963b8f 177 int fontcharset;
374330e2 178 /* Colour options */
179 int try_palette;
180 int bold_colour;
181 unsigned char colours[22][3];
182 /* Selection options */
183 int mouse_is_xterm;
184 short wordness[256];
c9def1b8 185 /* translations */
186 VT_Mode vtmode;
14963b8f 187 int xlat_enablekoiwin;
d3d16feb 188 int xlat_88592w1250;
14963b8f 189 int xlat_capslockcyr;
374330e2 190} Config;
191
e277c42d 192/*
193 * You can compile with -DSSH_DEFAULT to have ssh by default.
194 */
195#ifndef SSH_DEFAULT
196#define DEFAULT_PROTOCOL PROT_TELNET
197#define DEFAULT_PORT 23
198#else
199#define DEFAULT_PROTOCOL PROT_SSH
200#define DEFAULT_PORT 22
201#endif
202
4017be6d 203/*
204 * Some global flags denoting the type of application.
205 */
206#define FLAG_VERBOSE 0x0001
207#define FLAG_WINDOWED 0x0002
208#define FLAG_CONNECTION 0x0004
209GLOBAL int flags;
210
374330e2 211GLOBAL Config cfg;
e277c42d 212GLOBAL int default_protocol;
213GLOBAL int default_port;
374330e2 214
4e23b276 215struct RSAKey; /* be a little careful of scope */
216
374330e2 217/*
218 * Exports from window.c.
219 */
e14a5a13 220void request_resize (int, int, int);
c9def1b8 221void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 222void set_title (char *);
223void set_icon (char *);
224void set_sbar (int, int, int);
f67b4e85 225Context get_ctx(void);
374330e2 226void free_ctx (Context);
227void palette_set (int, int, int, int);
228void palette_reset (void);
229void write_clip (void *, int);
230void get_clip (void **, int *);
231void optimised_move (int, int, int);
232void fatalbox (char *, ...);
c9def1b8 233void beep (int);
374330e2 234#define OPTIMISE_IS_SCROLL 1
235
236/*
237 * Exports from noise.c.
238 */
239void noise_get_heavy(void (*func) (void *, int));
240void noise_get_light(void (*func) (void *, int));
241void noise_ultralight(DWORD data);
242void random_save_seed(void);
243
244/*
245 * Exports from windlg.c.
246 */
247int do_config (void);
248int do_reconfig (HWND);
249void do_defaults (char *);
c5e9c988 250void logevent (char *);
251void showeventlog (HWND);
374330e2 252void showabout (HWND);
89ee5268 253void verify_ssh_host_key(char *host, char *keystr);
0a4aa984 254void get_sesslist(int allocate);
255
7393a137 256GLOBAL int nsessions;
257GLOBAL char **sessions;
374330e2 258
259/*
260 * Exports from terminal.c.
261 */
262
263void term_init (void);
264void term_size (int, int, int);
265void term_out (void);
266void term_paint (Context, int, int, int, int);
267void term_scroll (int, int);
268void term_pwron (void);
269void term_clrsb (void);
270void term_mouse (Mouse_Button, Mouse_Action, int, int);
271void term_deselect (void);
272void term_update (void);
273void term_invalidate(void);
e14a5a13 274void term_blink(int set_cursor);
c9def1b8 275void term_paste(void);
276void term_nopaste(void);
374330e2 277
278/*
5e1a8e27 279 * Exports from raw.c.
280 */
281
3d9a14c9 282extern Backend raw_backend;
5e1a8e27 283
284/*
374330e2 285 * Exports from telnet.c.
286 */
287
c14776e8 288extern Backend telnet_backend;
374330e2 289
290/*
291 * Exports from ssh.c.
292 */
293
c14776e8 294extern Backend ssh_backend;
374330e2 295
296/*
5bc238bb 297 * Exports from ldisc.c.
298 */
299
300extern Ldisc ldisc_term, ldisc_simple;
301
302/*
374330e2 303 * Exports from sshrand.c.
304 */
305
306void random_add_noise(void *noise, int length);
307void random_init(void);
308int random_byte(void);
309void random_get_savedata(void **data, int *len);
310
311/*
312 * Exports from misc.c.
313 */
314
315/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
316#ifdef MALLOC_LOG
317#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
318#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
319#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
320void mlog(char *, int);
321#else
322#define smalloc safemalloc
323#define srealloc saferealloc
324#define sfree safefree
325#endif
326
327void *safemalloc(size_t);
328void *saferealloc(void *, size_t);
329void safefree(void *);
330
331/*
067a15ea 332 * Exports from version.c.
333 */
334extern char ver[];
335
336/*
b73fd1b1 337 * Exports from sizetip.c.
338 */
339void UpdateSizeTip(HWND src, int cx, int cy);
340void EnableSizeTip(int bEnable);
341
342/*
14963b8f 343 * Exports from xlat.c.
344 */
345unsigned char xlat_kbd2tty(unsigned char c);
346unsigned char xlat_tty2scr(unsigned char c);
347unsigned char xlat_latkbd2win(unsigned char c);
348
349/*
8f203108 350 * Exports from mscrypto.c
351 */
352#ifdef MSCRYPTOAPI
353int crypto_startup();
354void crypto_wrapup();
355#endif
356
357/*
374330e2 358 * A debug system.
359 */
360#ifdef DEBUG
361#include <stdarg.h>
362#define debug(x) (dprintf x)
363static void dprintf(char *fmt, ...) {
364 char buf[2048];
365 DWORD dw;
366 va_list ap;
367 static int gotconsole = 0;
368
369 if (!gotconsole) {
370 AllocConsole();
371 gotconsole = 1;
372 }
373
374 va_start(ap, fmt);
375 vsprintf(buf, fmt, ap);
376 WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
377 va_end(ap);
378}
379#else
380#define debug(x)
381#endif
382
383#endif