SCO ACS patch from RDB. Apparently required for the Linux console
[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
4eeb7d09 23/* Three attribute types:
24 * The ATTRs (normal attributes) are stored with the characters in the main
25 * display arrays
26 *
27 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
28 * with characters but not with normal attributes.
29 *
30 * The LATTRs (line attributes) conflict with no others and only have one
31 * value per line. But on area clears the LATTR cells are set to the erase_char
32 * (or DEFAULT_ATTR + 'E')
33 *
34 * ATTR_INVALID is an illegal colour combination.
35 */
36
37#define TATTR_ACTCURS 0x4UL /* active cursor (block) */
38#define TATTR_PASCURS 0x2UL /* passive cursor (box) */
39#define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
374330e2 40
c9def1b8 41#define LATTR_NORM 0x00000000UL
42#define LATTR_WIDE 0x01000000UL
43#define LATTR_TOP 0x02000000UL
44#define LATTR_BOT 0x03000000UL
45#define LATTR_MODE 0x03000000UL
4eeb7d09 46#define LATTR_WRAPPED 0x10000000UL
47
48#define ATTR_INVALID 0x00FF0000UL
49
50/* Like Linux use the F000 page for direct to font. */
51#define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
52#define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
53
54/* These are internal use overlapping with the UTF-16 surrogates */
55#define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
56#define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
d3cb5465 57#define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
4eeb7d09 58#define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
59#define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
60
61#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
62#define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
63
64#define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
65#define UCSWIDE 0x303F
66
67#define ATTR_WIDE 0x10000000UL
68#define ATTR_BOLD 0x01000000UL
69#define ATTR_UNDER 0x02000000UL
70#define ATTR_REVERSE 0x04000000UL
71#define ATTR_BLINK 0x08000000UL
72#define ATTR_FGMASK 0x000F0000UL
73#define ATTR_BGMASK 0x00F00000UL
74#define ATTR_COLOURS 0x00FF0000UL
75#define ATTR_FGSHIFT 16
76#define ATTR_BGSHIFT 20
77
78#define ATTR_DEFAULT 0x00980000UL
79#define ATTR_DEFFG 0x00080000UL
80#define ATTR_DEFBG 0x00900000UL
374330e2 81#define ERASE_CHAR (ATTR_DEFAULT | ' ')
82#define ATTR_MASK 0xFFFFFF00UL
83#define CHAR_MASK 0x000000FFUL
4eeb7d09 84
85#define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
86#define ATTR_CUR_XOR 0x00BA0000UL
374330e2 87
88typedef HDC Context;
89#define SEL_NL { 13, 10 }
90
91GLOBAL int rows, cols, savelines;
92
93GLOBAL int font_width, font_height;
94
95#define INBUF_SIZE 2048
374330e2 96GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 97GLOBAL int inbuf_head;
374330e2 98
99#define OUTBUF_SIZE 2048
100#define OUTBUF_MASK (OUTBUF_SIZE-1)
101GLOBAL unsigned char outbuf[OUTBUF_SIZE];
102GLOBAL int outbuf_head, outbuf_reap;
103
104GLOBAL int has_focus;
105
156686ef 106GLOBAL int in_vbell;
107GLOBAL long vbell_timeout;
108
c9def1b8 109GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
110GLOBAL int repeat_off, cr_lf_return;
374330e2 111
cabfd08c 112GLOBAL int seen_key_event;
113GLOBAL int seen_disp_event;
114
d85548fe 115GLOBAL int session_closed;
116
4eeb7d09 117GLOBAL int big_cursor;
118
119GLOBAL int utf;
120GLOBAL int dbcs_screenfont;
121GLOBAL int font_codepage;
122GLOBAL int kbd_codepage;
123GLOBAL int line_codepage;
d3cb5465 124GLOBAL WCHAR unitab_scoacs[256];
4eeb7d09 125GLOBAL WCHAR unitab_line[256];
126GLOBAL WCHAR unitab_font[256];
127GLOBAL WCHAR unitab_xterm[256];
128GLOBAL WCHAR unitab_oemcp[256];
129GLOBAL unsigned char unitab_ctrl[256];
130
32874aea 131#define LGXF_OVR 1 /* existing logfile overwrite */
132#define LGXF_APN 0 /* existing logfile append */
133#define LGXF_ASK -1 /* existing logfile ask */
134#define LGTYP_NONE 0 /* logmode: no logging */
135#define LGTYP_ASCII 1 /* logmode: pure ascii */
136#define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
5fd04f07 137GLOBAL char *logfile;
138
e14a5a13 139/*
475eebf9 140 * Window handles for the dialog boxes that can be running during a
141 * PuTTY session.
142 */
143GLOBAL HWND logbox;
144
145/*
e14a5a13 146 * I've just looked in the windows standard headr files for WM_USER, there
147 * are hundreds of flags defined using the form WM_USER+123 so I've
148 * renumbered this NETEVENT value and the two in window.c
149 */
150#define WM_XUSER (WM_USER + 0x2000)
151#define WM_NETEVENT (WM_XUSER + 5)
374330e2 152
153typedef enum {
154 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
a5f3e637 155 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
156 TS_EOL
374330e2 157} Telnet_Special;
158
159typedef enum {
01c034ad 160 MBT_NOTHING,
161 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
162 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
163 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
374330e2 164} Mouse_Button;
165
166typedef enum {
167 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
168} Mouse_Action;
169
170typedef enum {
4eeb7d09 171 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
374330e2 172} VT_Mode;
173
0965bee0 174enum {
175 /*
176 * Line discipline option states: off, on, up to the backend.
177 */
178 LD_YES, LD_NO, LD_BACKEND
179};
180
181enum {
182 /*
183 * Line discipline options which the backend might try to control.
184 */
32874aea 185 LD_EDIT, /* local line editing */
186 LD_ECHO /* local echo */
0965bee0 187};
188
b41069ff 189enum {
190 /*
191 * Close On Exit behaviours. (cfg.close_on_exit)
192 */
32874aea 193 COE_NEVER, /* Never close the window */
194 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
195 COE_ALWAYS /* Always close the window */
b41069ff 196};
197
374330e2 198typedef struct {
8df7a775 199 char *(*init) (char *host, int port, char **realhost);
374330e2 200 void (*send) (char *buf, int len);
201 void (*size) (void);
202 void (*special) (Telnet_Special code);
32874aea 203 Socket(*socket) (void);
8ccc75b0 204 int (*sendok) (void);
0965bee0 205 int (*ldisc) (int);
97db3be4 206 int default_port;
374330e2 207} Backend;
208
209GLOBAL Backend *back;
210
297d398b 211extern struct backend_list {
89ee5268 212 int protocol;
213 char *name;
214 Backend *backend;
215} backends[];
216
374330e2 217typedef struct {
218 /* Basic options */
219 char host[512];
220 int port;
c91409da 221 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 222 int close_on_exit;
9ef49106 223 int warn_on_close;
32874aea 224 int ping_interval; /* in seconds */
fef97f43 225 /* SSH options */
6abbf9e3 226 char remote_cmd[512];
32874aea 227 char *remote_cmd_ptr; /* might point to a larger command
228 * but never for loading/saving */
fef97f43 229 int nopty;
4ba9b64b 230 int compression;
979310f1 231 int agentfwd;
0a3f1d48 232 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
7cca0d81 233 char keyfile[FILENAME_MAX];
32874aea 234 int sshprot; /* use v1 or v2 when both available */
235 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 236 int try_tis_auth;
4a8fc3c4 237 int ssh_subsys; /* run a subsystem rather than a command */
374330e2 238 /* Telnet options */
239 char termtype[32];
240 char termspeed[32];
32874aea 241 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 242 char username[32];
c91409da 243 char localusername[32];
374330e2 244 int rfc_environ;
8faa456c 245 int passive_telnet;
374330e2 246 /* Keyboard options */
247 int bksp_is_delete;
248 int rxvt_homeend;
c9def1b8 249 int funky_type;
32874aea 250 int no_applic_c; /* totally disable app cursor keys */
251 int no_applic_k; /* totally disable app keypad */
374330e2 252 int app_cursor;
253 int app_keypad;
c5e9c988 254 int nethack_keypad;
a5f3e637 255 int telnet_keyboard;
c5e9c988 256 int alt_f4; /* is it special? */
257 int alt_space; /* is it special? */
a094ae43 258 int alt_only; /* is it special? */
0965bee0 259 int localecho;
260 int localedit;
e95edc00 261 int alwaysontop;
c9def1b8 262 int scroll_on_key;
a094ae43 263 int scroll_on_disp;
264 int compose_key;
95bbe1ae 265 int ctrlaltkeys;
32874aea 266 char wintitle[256]; /* initial window title */
374330e2 267 /* Terminal options */
268 int savelines;
269 int dec_om;
270 int wrap_mode;
fef97f43 271 int lfhascr;
4e30ff69 272 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 273 int blink_cur;
03169ad0 274 enum {
275 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
276 } beep;
f8a28d1f 277 enum {
278 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
279 } beep_ind;
156686ef 280 int bellovl; /* bell overload protection active? */
281 int bellovl_n; /* number of bells to cause overload */
282 int bellovl_t; /* time interval for overload (seconds) */
283 int bellovl_s; /* period of silence to re-enable bell (s) */
03169ad0 284 char bell_wavefile[FILENAME_MAX];
c9def1b8 285 int scrollbar;
286 int locksize;
287 int bce;
288 int blinktext;
374330e2 289 int win_name_always;
290 int width, height;
291 char font[64];
292 int fontisbold;
293 int fontheight;
14963b8f 294 int fontcharset;
e1c8e0ed 295 char logfilename[FILENAME_MAX];
296 int logtype;
9f89f96e 297 int logxfovr;
554c540d 298 int hide_mouseptr;
57d08f2f 299 int sunken_edge;
e7fbcdd8 300 char answerback[256];
374330e2 301 /* Colour options */
302 int try_palette;
303 int bold_colour;
304 unsigned char colours[22][3];
305 /* Selection options */
306 int mouse_is_xterm;
d3a22f79 307 int rawcnp;
374330e2 308 short wordness[256];
c9def1b8 309 /* translations */
310 VT_Mode vtmode;
4eeb7d09 311 char line_codepage[32];
9c964e85 312 /* X11 forwarding */
313 int x11_forward;
314 char x11_display[128];
374330e2 315} Config;
316
e277c42d 317/*
318 * You can compile with -DSSH_DEFAULT to have ssh by default.
319 */
320#ifndef SSH_DEFAULT
321#define DEFAULT_PROTOCOL PROT_TELNET
322#define DEFAULT_PORT 23
323#else
324#define DEFAULT_PROTOCOL PROT_SSH
325#define DEFAULT_PORT 22
326#endif
327
4017be6d 328/*
329 * Some global flags denoting the type of application.
67779be7 330 *
331 * FLAG_VERBOSE is set when the user requests verbose details.
332 *
333 * FLAG_STDERR is set in command-line applications (which have a
334 * functioning stderr that it makes sense to write to) and not in
335 * GUI applications (which don't).
336 *
337 * FLAG_INTERACTIVE is set when a full interactive shell session is
338 * being run, _either_ because no remote command has been provided
339 * _or_ because the application is GUI and can't run non-
340 * interactively.
4017be6d 341 */
67779be7 342#define FLAG_VERBOSE 0x0001
343#define FLAG_STDERR 0x0002
344#define FLAG_INTERACTIVE 0x0004
4017be6d 345GLOBAL int flags;
346
374330e2 347GLOBAL Config cfg;
e277c42d 348GLOBAL int default_protocol;
349GLOBAL int default_port;
374330e2 350
4e23b276 351struct RSAKey; /* be a little careful of scope */
352
374330e2 353/*
354 * Exports from window.c.
355 */
32874aea 356void request_resize(int, int, int);
357void do_text(Context, int, int, char *, int, unsigned long, int);
4eeb7d09 358void do_cursor(Context, int, int, char *, int, unsigned long, int);
32874aea 359void set_title(char *);
360void set_icon(char *);
361void set_sbar(int, int, int);
f67b4e85 362Context get_ctx(void);
32874aea 363void free_ctx(Context);
364void palette_set(int, int, int, int);
365void palette_reset(void);
4eeb7d09 366void write_aclip(char *, int, int);
367void write_clip(wchar_t *, int, int);
368void get_clip(wchar_t **, int *);
32874aea 369void optimised_move(int, int, int);
01c034ad 370void set_raw_mouse_mode(int);
371Mouse_Button translate_button(Mouse_Button b);
8d5de777 372void connection_fatal(char *, ...);
32874aea 373void fatalbox(char *, ...);
374void beep(int);
6f34e365 375void begin_session(void);
ec8679e9 376void sys_cursor(int x, int y);
374330e2 377#define OPTIMISE_IS_SCROLL 1
378
379/*
380 * Exports from noise.c.
381 */
32874aea 382void noise_get_heavy(void (*func) (void *, int));
383void noise_get_light(void (*func) (void *, int));
7d6ee6ff 384void noise_regular(void);
374330e2 385void noise_ultralight(DWORD data);
386void random_save_seed(void);
de3df031 387void random_destroy_seed(void);
374330e2 388
389/*
390 * Exports from windlg.c.
391 */
8c3cd914 392void defuse_showwindow(void);
32874aea 393int do_config(void);
394int do_reconfig(HWND);
395void do_defaults(char *, Config *);
396void logevent(char *);
397void showeventlog(HWND);
398void showabout(HWND);
d4857987 399void verify_ssh_host_key(char *host, int port, char *keytype,
32874aea 400 char *keystr, char *fingerprint);
e1c8e0ed 401int askappend(char *filename);
de3df031 402void registry_cleanup(void);
3da0b1d2 403void force_normal(HWND hwnd);
0a4aa984 404
7393a137 405GLOBAL int nsessions;
406GLOBAL char **sessions;
374330e2 407
408/*
a9422f39 409 * Exports from settings.c.
410 */
32874aea 411void save_settings(char *section, int do_host, Config * cfg);
412void load_settings(char *section, int do_host, Config * cfg);
a9422f39 413void get_sesslist(int allocate);
414
415/*
374330e2 416 * Exports from terminal.c.
417 */
418
32874aea 419void term_init(void);
420void term_size(int, int, int);
421void term_out(void);
422void term_paint(Context, int, int, int, int);
423void term_scroll(int, int);
424void term_pwron(void);
425void term_clrsb(void);
426void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int);
427void term_deselect(void);
428void term_update(void);
374330e2 429void term_invalidate(void);
e14a5a13 430void term_blink(int set_cursor);
568dd02f 431void term_do_paste(void);
c9def1b8 432void term_paste(void);
433void term_nopaste(void);
feb7fdfe 434int term_ldisc(int option);
fe50e814 435void from_backend(int is_stderr, char *data, int len);
32874aea 436void logfopen(void);
437void logfclose(void);
bc1235d4 438void term_copyall(void);
374330e2 439
440/*
5e1a8e27 441 * Exports from raw.c.
442 */
443
3d9a14c9 444extern Backend raw_backend;
5e1a8e27 445
446/*
c91409da 447 * Exports from rlogin.c.
448 */
449
450extern Backend rlogin_backend;
451
452/*
374330e2 453 * Exports from telnet.c.
454 */
455
c14776e8 456extern Backend telnet_backend;
374330e2 457
458/*
459 * Exports from ssh.c.
460 */
461
32874aea 462extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
463 int is_pw);
c14776e8 464extern Backend ssh_backend;
374330e2 465
466/*
5bc238bb 467 * Exports from ldisc.c.
468 */
469
0965bee0 470extern void ldisc_send(char *buf, int len);
5bc238bb 471
472/*
374330e2 473 * Exports from sshrand.c.
474 */
475
476void random_add_noise(void *noise, int length);
477void random_init(void);
478int random_byte(void);
479void random_get_savedata(void **data, int *len);
480
481/*
482 * Exports from misc.c.
483 */
484
db9c0f86 485#include "misc.h"
374330e2 486
487/*
067a15ea 488 * Exports from version.c.
489 */
490extern char ver[];
491
492/*
b73fd1b1 493 * Exports from sizetip.c.
494 */
495void UpdateSizeTip(HWND src, int cx, int cy);
496void EnableSizeTip(int bEnable);
497
498/*
4eeb7d09 499 * Exports from unicode.c.
14963b8f 500 */
4eeb7d09 501#ifndef CP_UTF8
502#define CP_UTF8 65001
503#endif
504void init_ucs_tables(void);
505void lpage_send(int codepage, char *buf, int len);
506void luni_send(wchar_t * widebuf, int len);
507int check_compose(int first, int second);
508int decode_codepage(char *cp_name);
509char *cp_name(int codepage);
14963b8f 510
511/*
8f203108 512 * Exports from mscrypto.c
513 */
514#ifdef MSCRYPTOAPI
515int crypto_startup();
516void crypto_wrapup();
517#endif
518
519/*
5c58ad2d 520 * Exports from pageantc.c
521 */
522void agent_query(void *in, int inlen, void **out, int *outlen);
523int agent_exists(void);
524
374330e2 525
526#endif