Various bug/warning fixes from Jacob
[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
4e30ff69 27#define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */
374330e2 28
c9def1b8 29#define LATTR_NORM 0x00000000UL
30#define LATTR_WIDE 0x01000000UL
31#define LATTR_TOP 0x02000000UL
32#define LATTR_BOT 0x03000000UL
33#define LATTR_MODE 0x03000000UL
34
374330e2 35#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
36#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
37#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
38
39#define ATTR_BOLD 0x00000100UL
40#define ATTR_UNDER 0x00000200UL
41#define ATTR_REVERSE 0x00000400UL
e14a5a13 42#define ATTR_BLINK 0x00000800UL
374330e2 43#define ATTR_FGMASK 0x0000F000UL
44#define ATTR_BGMASK 0x000F0000UL
45#define ATTR_FGSHIFT 12
46#define ATTR_BGSHIFT 16
47
48#define ATTR_DEFAULT 0x00098000UL
49#define ATTR_DEFFG 0x00008000UL
50#define ATTR_DEFBG 0x00090000UL
51#define ATTR_CUR_XOR 0x000BA000UL
52#define ERASE_CHAR (ATTR_DEFAULT | ' ')
53#define ATTR_MASK 0xFFFFFF00UL
54#define CHAR_MASK 0x000000FFUL
55
56typedef HDC Context;
57#define SEL_NL { 13, 10 }
58
59GLOBAL int rows, cols, savelines;
60
61GLOBAL int font_width, font_height;
62
63#define INBUF_SIZE 2048
374330e2 64GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 65GLOBAL int inbuf_head;
374330e2 66
67#define OUTBUF_SIZE 2048
68#define OUTBUF_MASK (OUTBUF_SIZE-1)
69GLOBAL unsigned char outbuf[OUTBUF_SIZE];
70GLOBAL int outbuf_head, outbuf_reap;
71
72GLOBAL int has_focus;
73
c9def1b8 74GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
75GLOBAL int repeat_off, cr_lf_return;
374330e2 76
cabfd08c 77GLOBAL int seen_key_event;
78GLOBAL int seen_disp_event;
79
d85548fe 80GLOBAL int session_closed;
81
e1c8e0ed 82#define LGTYP_NONE 0 /* logmode: no logging */
83#define LGTYP_ASCII 1 /* logmode: pure ascii */
84#define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
5fd04f07 85GLOBAL char *logfile;
86
e14a5a13 87/*
475eebf9 88 * Window handles for the dialog boxes that can be running during a
89 * PuTTY session.
90 */
91GLOBAL HWND logbox;
92
93/*
e14a5a13 94 * I've just looked in the windows standard headr files for WM_USER, there
95 * are hundreds of flags defined using the form WM_USER+123 so I've
96 * renumbered this NETEVENT value and the two in window.c
97 */
98#define WM_XUSER (WM_USER + 0x2000)
99#define WM_NETEVENT (WM_XUSER + 5)
374330e2 100
101typedef enum {
102 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
ec55b220 103 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
374330e2 104} Telnet_Special;
105
106typedef enum {
107 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
108} Mouse_Button;
109
110typedef enum {
111 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
112} Mouse_Action;
113
114typedef enum {
115 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
116} VT_Mode;
117
0965bee0 118enum {
119 /*
120 * Line discipline option states: off, on, up to the backend.
121 */
122 LD_YES, LD_NO, LD_BACKEND
123};
124
125enum {
126 /*
127 * Line discipline options which the backend might try to control.
128 */
129 LD_EDIT, /* local line editing */
130 LD_ECHO /* local echo */
131};
132
374330e2 133typedef struct {
8df7a775 134 char *(*init) (char *host, int port, char **realhost);
374330e2 135 void (*send) (char *buf, int len);
136 void (*size) (void);
137 void (*special) (Telnet_Special code);
8df7a775 138 Socket (*socket) (void);
8ccc75b0 139 int (*sendok) (void);
0965bee0 140 int (*ldisc) (int);
97db3be4 141 int default_port;
374330e2 142} Backend;
143
144GLOBAL Backend *back;
145
297d398b 146extern struct backend_list {
89ee5268 147 int protocol;
148 char *name;
149 Backend *backend;
150} backends[];
151
374330e2 152typedef struct {
153 /* Basic options */
154 char host[512];
155 int port;
c91409da 156 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 157 int close_on_exit;
9ef49106 158 int warn_on_close;
edce8e45 159 int ping_interval; /* in seconds */
fef97f43 160 /* SSH options */
6abbf9e3 161 char remote_cmd[512];
fef97f43 162 int nopty;
4ba9b64b 163 int compression;
979310f1 164 int agentfwd;
9697bfd2 165 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 166 char keyfile[FILENAME_MAX];
adf799dd 167 int sshprot; /* use v1 or v2 when both available */
7591b9ff 168 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 169 int try_tis_auth;
374330e2 170 /* Telnet options */
171 char termtype[32];
172 char termspeed[32];
37508af4 173 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 174 char username[32];
c91409da 175 char localusername[32];
374330e2 176 int rfc_environ;
177 /* Keyboard options */
178 int bksp_is_delete;
179 int rxvt_homeend;
c9def1b8 180 int funky_type;
b00f8b34 181 int no_applic_c; /* totally disable app cursor keys */
182 int no_applic_k; /* totally disable app keypad */
374330e2 183 int app_cursor;
184 int app_keypad;
c5e9c988 185 int nethack_keypad;
186 int alt_f4; /* is it special? */
187 int alt_space; /* is it special? */
a094ae43 188 int alt_only; /* is it special? */
0965bee0 189 int localecho;
190 int localedit;
e95edc00 191 int alwaysontop;
c9def1b8 192 int scroll_on_key;
a094ae43 193 int scroll_on_disp;
194 int compose_key;
9ca5da42 195 char wintitle[256]; /* initial window title */
374330e2 196 /* Terminal options */
197 int savelines;
198 int dec_om;
199 int wrap_mode;
fef97f43 200 int lfhascr;
4e30ff69 201 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 202 int blink_cur;
203 int beep;
204 int scrollbar;
205 int locksize;
206 int bce;
207 int blinktext;
374330e2 208 int win_name_always;
209 int width, height;
210 char font[64];
211 int fontisbold;
212 int fontheight;
14963b8f 213 int fontcharset;
e1c8e0ed 214 char logfilename[FILENAME_MAX];
215 int logtype;
554c540d 216 int hide_mouseptr;
374330e2 217 /* Colour options */
218 int try_palette;
219 int bold_colour;
220 unsigned char colours[22][3];
221 /* Selection options */
222 int mouse_is_xterm;
223 short wordness[256];
c9def1b8 224 /* translations */
225 VT_Mode vtmode;
14963b8f 226 int xlat_enablekoiwin;
d3d16feb 227 int xlat_88592w1250;
b0faa571 228 int xlat_88592cp852;
14963b8f 229 int xlat_capslockcyr;
9c964e85 230 /* X11 forwarding */
231 int x11_forward;
232 char x11_display[128];
374330e2 233} Config;
234
e277c42d 235/*
236 * You can compile with -DSSH_DEFAULT to have ssh by default.
237 */
238#ifndef SSH_DEFAULT
239#define DEFAULT_PROTOCOL PROT_TELNET
240#define DEFAULT_PORT 23
241#else
242#define DEFAULT_PROTOCOL PROT_SSH
243#define DEFAULT_PORT 22
244#endif
245
4017be6d 246/*
247 * Some global flags denoting the type of application.
67779be7 248 *
249 * FLAG_VERBOSE is set when the user requests verbose details.
250 *
251 * FLAG_STDERR is set in command-line applications (which have a
252 * functioning stderr that it makes sense to write to) and not in
253 * GUI applications (which don't).
254 *
255 * FLAG_INTERACTIVE is set when a full interactive shell session is
256 * being run, _either_ because no remote command has been provided
257 * _or_ because the application is GUI and can't run non-
258 * interactively.
4017be6d 259 */
67779be7 260#define FLAG_VERBOSE 0x0001
261#define FLAG_STDERR 0x0002
262#define FLAG_INTERACTIVE 0x0004
4017be6d 263GLOBAL int flags;
264
374330e2 265GLOBAL Config cfg;
e277c42d 266GLOBAL int default_protocol;
267GLOBAL int default_port;
374330e2 268
4e23b276 269struct RSAKey; /* be a little careful of scope */
270
374330e2 271/*
272 * Exports from window.c.
273 */
e14a5a13 274void request_resize (int, int, int);
c9def1b8 275void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 276void set_title (char *);
277void set_icon (char *);
278void set_sbar (int, int, int);
f67b4e85 279Context get_ctx(void);
374330e2 280void free_ctx (Context);
281void palette_set (int, int, int, int);
282void palette_reset (void);
f0df44da 283void write_clip (void *, int, int);
374330e2 284void get_clip (void **, int *);
285void optimised_move (int, int, int);
8d5de777 286void connection_fatal(char *, ...);
374330e2 287void fatalbox (char *, ...);
c9def1b8 288void beep (int);
6f34e365 289void begin_session(void);
ec8679e9 290void sys_cursor(int x, int y);
374330e2 291#define OPTIMISE_IS_SCROLL 1
292
293/*
294 * Exports from noise.c.
295 */
7d6ee6ff 296void noise_get_heavy(void (*func)(void *, int));
297void noise_get_light(void (*func)(void *, int));
298void noise_regular(void);
374330e2 299void noise_ultralight(DWORD data);
300void random_save_seed(void);
de3df031 301void random_destroy_seed(void);
374330e2 302
303/*
304 * Exports from windlg.c.
305 */
8c3cd914 306void defuse_showwindow(void);
374330e2 307int do_config (void);
308int do_reconfig (HWND);
a9422f39 309void do_defaults (char *, Config *);
c5e9c988 310void logevent (char *);
311void showeventlog (HWND);
374330e2 312void showabout (HWND);
d4857987 313void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 314 char *keystr, char *fingerprint);
e1c8e0ed 315int askappend(char *filename);
de3df031 316void registry_cleanup(void);
3da0b1d2 317void force_normal(HWND hwnd);
0a4aa984 318
7393a137 319GLOBAL int nsessions;
320GLOBAL char **sessions;
374330e2 321
322/*
a9422f39 323 * Exports from settings.c.
324 */
325void save_settings (char *section, int do_host, Config *cfg);
326void load_settings (char *section, int do_host, Config *cfg);
327void get_sesslist(int allocate);
328
329/*
374330e2 330 * Exports from terminal.c.
331 */
332
333void term_init (void);
334void term_size (int, int, int);
335void term_out (void);
336void term_paint (Context, int, int, int, int);
337void term_scroll (int, int);
338void term_pwron (void);
339void term_clrsb (void);
340void term_mouse (Mouse_Button, Mouse_Action, int, int);
341void term_deselect (void);
342void term_update (void);
343void term_invalidate(void);
e14a5a13 344void term_blink(int set_cursor);
c9def1b8 345void term_paste(void);
346void term_nopaste(void);
feb7fdfe 347int term_ldisc(int option);
fe50e814 348void from_backend(int is_stderr, char *data, int len);
e1c8e0ed 349void logfopen (void);
350void logfclose (void);
bc1235d4 351void term_copyall(void);
374330e2 352
353/*
5e1a8e27 354 * Exports from raw.c.
355 */
356
3d9a14c9 357extern Backend raw_backend;
5e1a8e27 358
359/*
c91409da 360 * Exports from rlogin.c.
361 */
362
363extern Backend rlogin_backend;
364
365/*
374330e2 366 * Exports from telnet.c.
367 */
368
c14776e8 369extern Backend telnet_backend;
374330e2 370
371/*
372 * Exports from ssh.c.
373 */
374
67779be7 375extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
c14776e8 376extern Backend ssh_backend;
374330e2 377
378/*
5bc238bb 379 * Exports from ldisc.c.
380 */
381
0965bee0 382extern void ldisc_send(char *buf, int len);
5bc238bb 383
384/*
374330e2 385 * Exports from sshrand.c.
386 */
387
388void random_add_noise(void *noise, int length);
389void random_init(void);
390int random_byte(void);
391void random_get_savedata(void **data, int *len);
392
393/*
394 * Exports from misc.c.
395 */
396
dcbde236 397#include "puttymem.h"
374330e2 398
399/*
067a15ea 400 * Exports from version.c.
401 */
402extern char ver[];
403
404/*
b73fd1b1 405 * Exports from sizetip.c.
406 */
407void UpdateSizeTip(HWND src, int cx, int cy);
408void EnableSizeTip(int bEnable);
409
410/*
14963b8f 411 * Exports from xlat.c.
412 */
413unsigned char xlat_kbd2tty(unsigned char c);
414unsigned char xlat_tty2scr(unsigned char c);
415unsigned char xlat_latkbd2win(unsigned char c);
416
417/*
8f203108 418 * Exports from mscrypto.c
419 */
420#ifdef MSCRYPTOAPI
421int crypto_startup();
422void crypto_wrapup();
423#endif
424
425/*
5c58ad2d 426 * Exports from pageantc.c
427 */
428void agent_query(void *in, int inlen, void **out, int *outlen);
429int agent_exists(void);
430
374330e2 431#ifdef DEBUG
c82bda52 432void dprintf(char *fmt, ...);
374330e2 433#define debug(x) (dprintf x)
374330e2 434#else
435#define debug(x)
436#endif
437
438#endif