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