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