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