4 #include <stdio.h> /* for FILENAME_MAX */
8 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
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"
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.
19 #ifdef PUTTY_DO_GLOBALS
25 /* Three attribute types:
26 * The ATTRs (normal attributes) are stored with the characters in the main
29 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
30 * with characters but not with normal attributes.
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')
36 * ATTR_INVALID is an illegal colour combination.
39 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
40 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
41 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
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
48 #define LATTR_WRAPPED 0x10000000UL
50 #define ATTR_INVALID 0x00FF0000UL
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 */
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 */
59 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
60 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
61 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
63 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
64 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
66 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
67 #define UCSWIDE 0x303F
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
80 #define ATTR_DEFAULT 0x00980000UL
81 #define ATTR_DEFFG 0x00080000UL
82 #define ATTR_DEFBG 0x00900000UL
83 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
84 #define ATTR_MASK 0xFFFFFF00UL
85 #define CHAR_MASK 0x000000FFUL
87 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
88 #define ATTR_CUR_XOR 0x00BA0000UL
91 #define SEL_NL { 13, 10 }
93 GLOBAL int rows, cols, savelines;
95 GLOBAL int font_width, font_height;
97 #define INBUF_SIZE 2048
98 GLOBAL unsigned char inbuf[INBUF_SIZE];
99 GLOBAL int inbuf_head;
101 #define OUTBUF_SIZE 2048
102 #define OUTBUF_MASK (OUTBUF_SIZE-1)
103 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
104 GLOBAL int outbuf_head, outbuf_reap;
106 GLOBAL int has_focus;
109 GLOBAL long vbell_timeout;
111 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
112 GLOBAL int repeat_off, cr_lf_return;
114 GLOBAL int seen_key_event;
115 GLOBAL int seen_disp_event;
117 GLOBAL int session_closed;
119 GLOBAL int big_cursor;
122 GLOBAL int dbcs_screenfont;
123 GLOBAL int font_codepage;
124 GLOBAL int kbd_codepage;
125 GLOBAL int line_codepage;
126 GLOBAL WCHAR unitab_scoacs[256];
127 GLOBAL WCHAR unitab_line[256];
128 GLOBAL WCHAR unitab_font[256];
129 GLOBAL WCHAR unitab_xterm[256];
130 GLOBAL WCHAR unitab_oemcp[256];
131 GLOBAL unsigned char unitab_ctrl[256];
132 #define in_utf (utf || line_codepage==CP_UTF8)
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 */
140 GLOBAL char *logfile;
143 * Window handles for the dialog boxes that can be running during a
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
153 #define WM_XUSER (WM_USER + 0x2000)
154 #define WM_NETEVENT (WM_XUSER + 5)
157 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
158 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
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 */
170 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
174 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
179 * SSH ciphers (both SSH1 and SSH2)
181 CIPHER_WARN, /* pseudo 'cipher' */
184 CIPHER_AES, /* (SSH 2 only) */
185 CIPHER_DES, /* (SSH 1 only) */
186 CIPHER_MAX /* no. ciphers (inc warn) */
191 * Line discipline option states: off, on, up to the backend.
193 LD_YES, LD_NO, LD_BACKEND
198 * Line discipline options which the backend might try to control.
200 LD_EDIT, /* local line editing */
201 LD_ECHO /* local echo */
206 * Close On Exit behaviours. (cfg.close_on_exit)
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 */
214 char *(*init) (char *host, int port, char **realhost);
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);
220 void (*special) (Telnet_Special code);
221 Socket(*socket) (void);
222 int (*sendok) (void);
225 * back->unthrottle() tells the back end that the front end
226 * buffer is clearing.
228 void (*unthrottle) (int);
232 GLOBAL Backend *back;
234 extern struct backend_list {
244 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
247 int ping_interval; /* in seconds */
249 char remote_cmd[512];
250 char remote_cmd2[512]; /* fallback if the first fails
251 * (used internally for scp) */
252 char *remote_cmd_ptr; /* might point to a larger command
253 * but never for loading/saving */
254 char *remote_cmd_ptr2; /* might point to a larger command
255 * but never for loading/saving */
259 int ssh_cipherlist[CIPHER_MAX];
260 char keyfile[FILENAME_MAX];
261 int sshprot; /* use v1 or v2 when both available */
262 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
264 int ssh_subsys; /* run a subsystem rather than a command */
265 int ssh_subsys2; /* fallback to go with remote_cmd2 */
269 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
271 char localusername[32];
274 /* Keyboard options */
278 int no_applic_c; /* totally disable app cursor keys */
279 int no_applic_k; /* totally disable app keypad */
284 int alt_f4; /* is it special? */
285 int alt_space; /* is it special? */
286 int alt_only; /* is it special? */
294 char wintitle[256]; /* initial window title */
295 /* Terminal options */
300 int cursor_type; /* 0=block 1=underline 2=vertical */
303 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
306 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
308 int bellovl; /* bell overload protection active? */
309 int bellovl_n; /* number of bells to cause overload */
310 int bellovl_t; /* time interval for overload (seconds) */
311 int bellovl_s; /* period of silence to re-enable bell (s) */
312 char bell_wavefile[FILENAME_MAX];
323 char logfilename[FILENAME_MAX];
328 char answerback[256];
332 unsigned char colours[22][3];
333 /* Selection options */
339 char line_codepage[32];
342 char x11_display[128];
343 /* port forwarding */
344 int lport_acceptall; /* accepts connection from hosts other than localhost */
345 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
349 * You can compile with -DSSH_DEFAULT to have ssh by default.
352 #define DEFAULT_PROTOCOL PROT_TELNET
353 #define DEFAULT_PORT 23
355 #define DEFAULT_PROTOCOL PROT_SSH
356 #define DEFAULT_PORT 22
360 * Some global flags denoting the type of application.
362 * FLAG_VERBOSE is set when the user requests verbose details.
364 * FLAG_STDERR is set in command-line applications (which have a
365 * functioning stderr that it makes sense to write to) and not in
366 * GUI applications (which don't).
368 * FLAG_INTERACTIVE is set when a full interactive shell session is
369 * being run, _either_ because no remote command has been provided
370 * _or_ because the application is GUI and can't run non-
373 #define FLAG_VERBOSE 0x0001
374 #define FLAG_STDERR 0x0002
375 #define FLAG_INTERACTIVE 0x0004
379 GLOBAL int default_protocol;
380 GLOBAL int default_port;
382 struct RSAKey; /* be a little careful of scope */
385 * Exports from window.c.
387 void request_resize(int, int, int);
388 void do_text(Context, int, int, char *, int, unsigned long, int);
389 void do_cursor(Context, int, int, char *, int, unsigned long, int);
390 void set_title(char *);
391 void set_icon(char *);
392 void set_sbar(int, int, int);
393 Context get_ctx(void);
394 void free_ctx(Context);
395 void palette_set(int, int, int, int);
396 void palette_reset(void);
397 void write_aclip(char *, int, int);
398 void write_clip(wchar_t *, int, int);
399 void get_clip(wchar_t **, int *);
400 void optimised_move(int, int, int);
401 void set_raw_mouse_mode(int);
402 Mouse_Button translate_button(Mouse_Button b);
403 void connection_fatal(char *, ...);
404 void fatalbox(char *, ...);
406 void begin_session(void);
407 void sys_cursor(int x, int y);
408 #define OPTIMISE_IS_SCROLL 1
411 * Exports from noise.c.
413 void noise_get_heavy(void (*func) (void *, int));
414 void noise_get_light(void (*func) (void *, int));
415 void noise_regular(void);
416 void noise_ultralight(DWORD data);
417 void random_save_seed(void);
418 void random_destroy_seed(void);
421 * Exports from windlg.c.
423 void defuse_showwindow(void);
425 int do_reconfig(HWND);
426 void do_defaults(char *, Config *);
427 void logevent(char *);
428 void showeventlog(HWND);
429 void showabout(HWND);
430 void verify_ssh_host_key(char *host, int port, char *keytype,
431 char *keystr, char *fingerprint);
432 void askcipher(char *ciphername, int cs);
433 int askappend(char *filename);
434 void registry_cleanup(void);
435 void force_normal(HWND hwnd);
437 GLOBAL int nsessions;
438 GLOBAL char **sessions;
441 * Exports from settings.c.
443 void save_settings(char *section, int do_host, Config * cfg);
444 void load_settings(char *section, int do_host, Config * cfg);
445 void get_sesslist(int allocate);
448 * Exports from terminal.c.
451 void term_init(void);
452 void term_size(int, int, int);
454 void term_paint(Context, int, int, int, int);
455 void term_scroll(int, int);
456 void term_pwron(void);
457 void term_clrsb(void);
458 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int);
459 void term_deselect(void);
460 void term_update(void);
461 void term_invalidate(void);
462 void term_blink(int set_cursor);
463 void term_do_paste(void);
464 void term_paste(void);
465 void term_nopaste(void);
466 int term_ldisc(int option);
467 int from_backend(int is_stderr, char *data, int len);
469 void logfclose(void);
470 void term_copyall(void);
473 * Exports from raw.c.
476 extern Backend raw_backend;
479 * Exports from rlogin.c.
482 extern Backend rlogin_backend;
485 * Exports from telnet.c.
488 extern Backend telnet_backend;
491 * Exports from ssh.c.
494 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
496 extern Backend ssh_backend;
499 * Exports from ldisc.c.
502 extern void ldisc_send(char *buf, int len);
505 * Exports from sshrand.c.
508 void random_add_noise(void *noise, int length);
509 void random_init(void);
510 int random_byte(void);
511 void random_get_savedata(void **data, int *len);
514 * Exports from misc.c.
520 * Exports from version.c.
525 * Exports from sizetip.c.
527 void UpdateSizeTip(HWND src, int cx, int cy);
528 void EnableSizeTip(int bEnable);
531 * Exports from unicode.c.
534 #define CP_UTF8 65001
536 void init_ucs_tables(void);
537 void lpage_send(int codepage, char *buf, int len);
538 void luni_send(wchar_t * widebuf, int len);
539 int check_compose(int first, int second);
540 int decode_codepage(char *cp_name);
541 char *cp_enumerate (int index);
542 char *cp_name(int codepage);
545 * Exports from mscrypto.c
548 int crypto_startup();
549 void crypto_wrapup();
553 * Exports from pageantc.c
555 void agent_query(void *in, int inlen, void **out, int *outlen);
556 int agent_exists(void);
559 * Exports from wildcard.c
561 const char *wc_error(int value);
562 int wc_match(const char *wildcard, const char *target);
563 int wc_unescape(char *output, const char *wildcard);