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