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