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