Wez Furlong's patch to add xterm mouse reporting and proper mouse
[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 {
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 */
139 LD_EDIT, /* local line editing */
140 LD_ECHO /* local echo */
141};
142
b41069ff 143enum {
144 /*
145 * Close On Exit behaviours. (cfg.close_on_exit)
146 */
147 COE_NEVER, /* Never close the window */
1cd48051 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);
8df7a775 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;
edce8e45 178 int ping_interval; /* in seconds */
fef97f43 179 /* SSH options */
6abbf9e3 180 char remote_cmd[512];
96621a84 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];
adf799dd 188 int sshprot; /* use v1 or v2 when both available */
7591b9ff 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];
37508af4 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;
199 /* Keyboard options */
200 int bksp_is_delete;
201 int rxvt_homeend;
c9def1b8 202 int funky_type;
b00f8b34 203 int no_applic_c; /* totally disable app cursor keys */
204 int no_applic_k; /* totally disable app keypad */
374330e2 205 int app_cursor;
206 int app_keypad;
c5e9c988 207 int nethack_keypad;
208 int alt_f4; /* is it special? */
209 int alt_space; /* is it special? */
a094ae43 210 int alt_only; /* is it special? */
0965bee0 211 int localecho;
212 int localedit;
e95edc00 213 int alwaysontop;
c9def1b8 214 int scroll_on_key;
a094ae43 215 int scroll_on_disp;
216 int compose_key;
95bbe1ae 217 int ctrlaltkeys;
9ca5da42 218 char wintitle[256]; /* initial window title */
374330e2 219 /* Terminal options */
220 int savelines;
221 int dec_om;
222 int wrap_mode;
fef97f43 223 int lfhascr;
4e30ff69 224 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 225 int blink_cur;
03169ad0 226 enum {
227 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
228 } beep;
156686ef 229 int bellovl; /* bell overload protection active? */
230 int bellovl_n; /* number of bells to cause overload */
231 int bellovl_t; /* time interval for overload (seconds) */
232 int bellovl_s; /* period of silence to re-enable bell (s) */
03169ad0 233 char bell_wavefile[FILENAME_MAX];
c9def1b8 234 int scrollbar;
235 int locksize;
236 int bce;
237 int blinktext;
374330e2 238 int win_name_always;
239 int width, height;
240 char font[64];
241 int fontisbold;
242 int fontheight;
14963b8f 243 int fontcharset;
e1c8e0ed 244 char logfilename[FILENAME_MAX];
245 int logtype;
9f89f96e 246 int logxfovr;
554c540d 247 int hide_mouseptr;
57d08f2f 248 int sunken_edge;
e7fbcdd8 249 char answerback[256];
374330e2 250 /* Colour options */
251 int try_palette;
252 int bold_colour;
253 unsigned char colours[22][3];
254 /* Selection options */
255 int mouse_is_xterm;
d3a22f79 256 int rawcnp;
374330e2 257 short wordness[256];
c9def1b8 258 /* translations */
259 VT_Mode vtmode;
14963b8f 260 int xlat_enablekoiwin;
d3d16feb 261 int xlat_88592w1250;
b0faa571 262 int xlat_88592cp852;
14963b8f 263 int xlat_capslockcyr;
9c964e85 264 /* X11 forwarding */
265 int x11_forward;
266 char x11_display[128];
374330e2 267} Config;
268
e277c42d 269/*
270 * You can compile with -DSSH_DEFAULT to have ssh by default.
271 */
272#ifndef SSH_DEFAULT
273#define DEFAULT_PROTOCOL PROT_TELNET
274#define DEFAULT_PORT 23
275#else
276#define DEFAULT_PROTOCOL PROT_SSH
277#define DEFAULT_PORT 22
278#endif
279
4017be6d 280/*
281 * Some global flags denoting the type of application.
67779be7 282 *
283 * FLAG_VERBOSE is set when the user requests verbose details.
284 *
285 * FLAG_STDERR is set in command-line applications (which have a
286 * functioning stderr that it makes sense to write to) and not in
287 * GUI applications (which don't).
288 *
289 * FLAG_INTERACTIVE is set when a full interactive shell session is
290 * being run, _either_ because no remote command has been provided
291 * _or_ because the application is GUI and can't run non-
292 * interactively.
4017be6d 293 */
67779be7 294#define FLAG_VERBOSE 0x0001
295#define FLAG_STDERR 0x0002
296#define FLAG_INTERACTIVE 0x0004
4017be6d 297GLOBAL int flags;
298
374330e2 299GLOBAL Config cfg;
e277c42d 300GLOBAL int default_protocol;
301GLOBAL int default_port;
374330e2 302
4e23b276 303struct RSAKey; /* be a little careful of scope */
304
374330e2 305/*
306 * Exports from window.c.
307 */
e14a5a13 308void request_resize (int, int, int);
c9def1b8 309void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 310void set_title (char *);
311void set_icon (char *);
312void set_sbar (int, int, int);
f67b4e85 313Context get_ctx(void);
374330e2 314void free_ctx (Context);
315void palette_set (int, int, int, int);
316void palette_reset (void);
f0df44da 317void write_clip (void *, int, int);
374330e2 318void get_clip (void **, int *);
319void optimised_move (int, int, int);
01c034ad 320void set_raw_mouse_mode(int);
321Mouse_Button translate_button(Mouse_Button b);
8d5de777 322void connection_fatal(char *, ...);
374330e2 323void fatalbox (char *, ...);
c9def1b8 324void beep (int);
6f34e365 325void begin_session(void);
ec8679e9 326void sys_cursor(int x, int y);
374330e2 327#define OPTIMISE_IS_SCROLL 1
328
329/*
330 * Exports from noise.c.
331 */
7d6ee6ff 332void noise_get_heavy(void (*func)(void *, int));
333void noise_get_light(void (*func)(void *, int));
334void noise_regular(void);
374330e2 335void noise_ultralight(DWORD data);
336void random_save_seed(void);
de3df031 337void random_destroy_seed(void);
374330e2 338
339/*
340 * Exports from windlg.c.
341 */
8c3cd914 342void defuse_showwindow(void);
374330e2 343int do_config (void);
344int do_reconfig (HWND);
a9422f39 345void do_defaults (char *, Config *);
c5e9c988 346void logevent (char *);
347void showeventlog (HWND);
374330e2 348void showabout (HWND);
d4857987 349void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 350 char *keystr, char *fingerprint);
e1c8e0ed 351int askappend(char *filename);
de3df031 352void registry_cleanup(void);
3da0b1d2 353void force_normal(HWND hwnd);
0a4aa984 354
7393a137 355GLOBAL int nsessions;
356GLOBAL char **sessions;
374330e2 357
358/*
a9422f39 359 * Exports from settings.c.
360 */
361void save_settings (char *section, int do_host, Config *cfg);
362void load_settings (char *section, int do_host, Config *cfg);
363void get_sesslist(int allocate);
364
365/*
374330e2 366 * Exports from terminal.c.
367 */
368
369void term_init (void);
370void term_size (int, int, int);
371void term_out (void);
372void term_paint (Context, int, int, int, int);
373void term_scroll (int, int);
374void term_pwron (void);
375void term_clrsb (void);
01c034ad 376void term_mouse (Mouse_Button, Mouse_Action, int, int, int, int);
374330e2 377void term_deselect (void);
378void term_update (void);
379void term_invalidate(void);
e14a5a13 380void term_blink(int set_cursor);
c9def1b8 381void term_paste(void);
382void term_nopaste(void);
feb7fdfe 383int term_ldisc(int option);
fe50e814 384void from_backend(int is_stderr, char *data, int len);
e1c8e0ed 385void logfopen (void);
386void logfclose (void);
bc1235d4 387void term_copyall(void);
374330e2 388
389/*
5e1a8e27 390 * Exports from raw.c.
391 */
392
3d9a14c9 393extern Backend raw_backend;
5e1a8e27 394
395/*
c91409da 396 * Exports from rlogin.c.
397 */
398
399extern Backend rlogin_backend;
400
401/*
374330e2 402 * Exports from telnet.c.
403 */
404
c14776e8 405extern Backend telnet_backend;
374330e2 406
407/*
408 * Exports from ssh.c.
409 */
410
fa17a66e 411extern int (*ssh_get_line)(const char *prompt, char *str, int maxlen,
412 int is_pw);
c14776e8 413extern Backend ssh_backend;
374330e2 414
415/*
5bc238bb 416 * Exports from ldisc.c.
417 */
418
0965bee0 419extern void ldisc_send(char *buf, int len);
5bc238bb 420
421/*
374330e2 422 * Exports from sshrand.c.
423 */
424
425void random_add_noise(void *noise, int length);
426void random_init(void);
427int random_byte(void);
428void random_get_savedata(void **data, int *len);
429
430/*
431 * Exports from misc.c.
432 */
433
db9c0f86 434#include "misc.h"
374330e2 435
436/*
067a15ea 437 * Exports from version.c.
438 */
439extern char ver[];
440
441/*
b73fd1b1 442 * Exports from sizetip.c.
443 */
444void UpdateSizeTip(HWND src, int cx, int cy);
445void EnableSizeTip(int bEnable);
446
447/*
14963b8f 448 * Exports from xlat.c.
449 */
450unsigned char xlat_kbd2tty(unsigned char c);
451unsigned char xlat_tty2scr(unsigned char c);
452unsigned char xlat_latkbd2win(unsigned char c);
453
454/*
8f203108 455 * Exports from mscrypto.c
456 */
457#ifdef MSCRYPTOAPI
458int crypto_startup();
459void crypto_wrapup();
460#endif
461
462/*
5c58ad2d 463 * Exports from pageantc.c
464 */
465void agent_query(void *in, int inlen, void **out, int *outlen);
466int agent_exists(void);
467
374330e2 468
469#endif