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_NARROW 0x20000000UL
70 #define ATTR_WIDE 0x10000000UL
71 #define ATTR_BOLD 0x01000000UL
72 #define ATTR_UNDER 0x02000000UL
73 #define ATTR_REVERSE 0x04000000UL
74 #define ATTR_BLINK 0x08000000UL
75 #define ATTR_FGMASK 0x000F0000UL
76 #define ATTR_BGMASK 0x00F00000UL
77 #define ATTR_COLOURS 0x00FF0000UL
78 #define ATTR_FGSHIFT 16
79 #define ATTR_BGSHIFT 20
81 #define ATTR_DEFAULT 0x00980000UL
82 #define ATTR_DEFFG 0x00080000UL
83 #define ATTR_DEFBG 0x00900000UL
84 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
85 #define ATTR_MASK 0xFFFFFF00UL
86 #define CHAR_MASK 0x000000FFUL
88 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
89 #define ATTR_CUR_XOR 0x00BA0000UL
92 #define SEL_NL { 13, 10 }
94 GLOBAL int rows, cols, savelines;
99 GLOBAL unsigned long vbell_startpoint;
101 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
102 GLOBAL int repeat_off, cr_lf_return;
104 GLOBAL int seen_key_event;
105 GLOBAL int seen_disp_event;
106 GLOBAL int alt_pressed;
108 GLOBAL int session_closed;
110 GLOBAL int big_cursor;
112 GLOBAL char *help_path;
113 GLOBAL int help_has_contents;
116 GLOBAL int dbcs_screenfont;
117 GLOBAL int font_codepage;
118 GLOBAL int kbd_codepage;
119 GLOBAL int line_codepage;
120 GLOBAL WCHAR unitab_scoacs[256];
121 GLOBAL WCHAR unitab_line[256];
122 GLOBAL WCHAR unitab_font[256];
123 GLOBAL WCHAR unitab_xterm[256];
124 GLOBAL WCHAR unitab_oemcp[256];
125 GLOBAL unsigned char unitab_ctrl[256];
126 #define in_utf (utf || line_codepage==CP_UTF8)
128 #define LGXF_OVR 1 /* existing logfile overwrite */
129 #define LGXF_APN 0 /* existing logfile append */
130 #define LGXF_ASK -1 /* existing logfile ask */
131 #define LGTYP_NONE 0 /* logmode: no logging */
132 #define LGTYP_ASCII 1 /* logmode: pure ascii */
133 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
134 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
135 GLOBAL char *logfile;
138 * Window handles for the dialog boxes that can be running during a
144 * I've just looked in the windows standard headr files for WM_USER, there
145 * are hundreds of flags defined using the form WM_USER+123 so I've
146 * renumbered this NETEVENT value and the two in window.c
148 #define WM_XUSER (WM_USER + 0x2000)
149 #define WM_NETEVENT (WM_XUSER + 5)
152 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
153 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
159 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
160 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
161 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
165 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
169 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
174 * SSH ciphers (both SSH1 and SSH2)
176 CIPHER_WARN, /* pseudo 'cipher' */
179 CIPHER_AES, /* (SSH 2 only) */
181 CIPHER_MAX /* no. ciphers (inc warn) */
186 * Line discipline option states: off, on, up to the backend.
188 LD_YES, LD_NO, LD_BACKEND
193 * Line discipline options which the backend might try to control.
195 LD_EDIT, /* local line editing */
196 LD_ECHO /* local echo */
201 * Close On Exit behaviours. (cfg.close_on_exit)
203 COE_NEVER, /* Never close the window */
204 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
205 COE_ALWAYS /* Always close the window */
209 char *(*init) (char *host, int port, char **realhost, int nodelay);
210 /* back->send() returns the current amount of buffered data. */
211 int (*send) (char *buf, int len);
212 /* back->sendbuffer() does the same thing but without attempting a send */
213 int (*sendbuffer) (void);
215 void (*special) (Telnet_Special code);
216 Socket(*socket) (void);
217 int (*exitcode) (void);
218 int (*sendok) (void);
221 * back->unthrottle() tells the back end that the front end
222 * buffer is clearing.
224 void (*unthrottle) (int);
228 GLOBAL Backend *back;
230 extern struct backend_list {
240 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
243 int ping_interval; /* in seconds */
246 char remote_cmd[512];
247 char remote_cmd2[512]; /* fallback if the first fails
248 * (used internally for scp) */
249 char *remote_cmd_ptr; /* might point to a larger command
250 * but never for loading/saving */
251 char *remote_cmd_ptr2; /* might point to a larger command
252 * but never for loading/saving */
256 int change_username; /* allow username switching in SSH2 */
257 int ssh_cipherlist[CIPHER_MAX];
258 char keyfile[FILENAME_MAX];
259 int sshprot; /* use v1 or v2 when both available */
260 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
261 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
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 */
280 int no_mouse_rep; /* totally disable mouse reporting */
281 int no_remote_resize; /* disable remote resizing */
282 int no_alt_screen; /* disable alternate screen */
283 int no_remote_wintitle; /* disable remote retitling */
284 int no_dbackspace; /* disable destructive backspace */
285 int no_remote_charset; /* disable remote charset config */
291 int alt_f4; /* is it special? */
292 int alt_space; /* is it special? */
293 int alt_only; /* is it special? */
297 int fullscreenonaltenter;
302 char wintitle[256]; /* initial window title */
303 /* Terminal options */
308 int cursor_type; /* 0=block 1=underline 2=vertical */
311 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
314 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
316 int bellovl; /* bell overload protection active? */
317 int bellovl_n; /* number of bells to cause overload */
318 int bellovl_t; /* time interval for overload (seconds) */
319 int bellovl_s; /* period of silence to re-enable bell (s) */
320 char bell_wavefile[FILENAME_MAX];
322 int scrollbar_in_fullscreen;
323 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
332 char logfilename[FILENAME_MAX];
338 char answerback[256];
342 unsigned char colours[22][3];
343 /* Selection options */
352 char line_codepage[128];
353 int xlat_capslockcyr;
356 char x11_display[128];
357 /* port forwarding */
358 int lport_acceptall; /* accept conns from hosts other than localhost */
359 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
360 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
364 * You can compile with -DSSH_DEFAULT to have ssh by default.
367 #define DEFAULT_PROTOCOL PROT_TELNET
368 #define DEFAULT_PORT 23
370 #define DEFAULT_PROTOCOL PROT_SSH
371 #define DEFAULT_PORT 22
375 * Some global flags denoting the type of application.
377 * FLAG_VERBOSE is set when the user requests verbose details.
379 * FLAG_STDERR is set in command-line applications (which have a
380 * functioning stderr that it makes sense to write to) and not in
381 * GUI applications (which don't).
383 * FLAG_INTERACTIVE is set when a full interactive shell session is
384 * being run, _either_ because no remote command has been provided
385 * _or_ because the application is GUI and can't run non-
388 #define FLAG_VERBOSE 0x0001
389 #define FLAG_STDERR 0x0002
390 #define FLAG_INTERACTIVE 0x0004
394 GLOBAL int default_protocol;
395 GLOBAL int default_port;
397 struct RSAKey; /* be a little careful of scope */
400 * Exports from window.c.
402 void request_resize(int, int);
403 void do_text(Context, int, int, char *, int, unsigned long, int);
404 void do_cursor(Context, int, int, char *, int, unsigned long, int);
405 int CharWidth(Context ctx, int uc);
406 void set_title(char *);
407 void set_icon(char *);
408 void set_sbar(int, int, int);
409 Context get_ctx(void);
410 void free_ctx(Context);
411 void palette_set(int, int, int, int);
412 void palette_reset(void);
413 void write_aclip(char *, int, int);
414 void write_clip(wchar_t *, int, int);
415 void get_clip(wchar_t **, int *);
416 void optimised_move(int, int, int);
417 void set_raw_mouse_mode(int);
418 Mouse_Button translate_button(Mouse_Button b);
419 void connection_fatal(char *, ...);
420 void fatalbox(char *, ...);
422 void begin_session(void);
423 void sys_cursor(int x, int y);
424 #define OPTIMISE_IS_SCROLL 1
426 void set_iconic(int iconic);
427 void move_window(int x, int y);
428 void set_zorder(int top);
429 void refresh_window(void);
430 void set_zoomed(int zoomed);
432 void get_window_pos(int *x, int *y);
433 void get_window_pixels(int *x, int *y);
434 char *get_window_title(int icon);
436 void cleanup_exit(int);
439 * Exports from noise.c.
441 void noise_get_heavy(void (*func) (void *, int));
442 void noise_get_light(void (*func) (void *, int));
443 void noise_regular(void);
444 void noise_ultralight(DWORD data);
445 void random_save_seed(void);
446 void random_destroy_seed(void);
449 * Exports from windlg.c.
451 void defuse_showwindow(void);
453 int do_reconfig(HWND);
454 void do_defaults(char *, Config *);
455 void logevent(char *);
456 void showeventlog(HWND);
457 void showabout(HWND);
458 void verify_ssh_host_key(char *host, int port, char *keytype,
459 char *keystr, char *fingerprint);
460 void askcipher(char *ciphername, int cs);
461 int askappend(char *filename);
462 void registry_cleanup(void);
463 void force_normal(HWND hwnd);
465 GLOBAL int nsessions;
466 GLOBAL char **sessions;
469 * Exports from settings.c.
471 void save_settings(char *section, int do_host, Config * cfg);
472 void load_settings(char *section, int do_host, Config * cfg);
473 void get_sesslist(int allocate);
476 * Exports from terminal.c.
479 void term_init(void);
480 void term_size(int, int, int);
482 void term_paint(Context, int, int, int, int);
483 void term_scroll(int, int);
484 void term_pwron(void);
485 void term_clrsb(void);
486 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
487 void term_deselect(void);
488 void term_update(void);
489 void term_invalidate(void);
490 void term_blink(int set_cursor);
491 void term_do_paste(void);
492 void term_paste(void);
493 void term_nopaste(void);
494 int term_ldisc(int option);
495 int from_backend(int is_stderr, char *data, int len);
497 void logfclose(void);
498 void term_copyall(void);
499 void term_reconfig(void);
502 * Exports from logging.c.
504 void logtraffic(unsigned char c, int logmode);
505 enum { PKT_INCOMING, PKT_OUTGOING };
506 void log_packet(int direction, int type, char *texttype, void *data, int len);
509 * Exports from raw.c.
512 extern Backend raw_backend;
515 * Exports from rlogin.c.
518 extern Backend rlogin_backend;
521 * Exports from telnet.c.
524 extern Backend telnet_backend;
527 * Exports from ssh.c.
530 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
532 extern Backend ssh_backend;
535 * Exports from ldisc.c.
538 extern void ldisc_send(char *buf, int len, int interactive);
541 * Exports from sshrand.c.
544 void random_add_noise(void *noise, int length);
545 void random_init(void);
546 int random_byte(void);
547 void random_get_savedata(void **data, int *len);
548 extern int random_active;
551 * Exports from misc.c.
557 * Exports from version.c.
562 * Exports from sizetip.c.
564 void UpdateSizeTip(HWND src, int cx, int cy);
565 void EnableSizeTip(int bEnable);
568 * Exports from unicode.c.
571 #define CP_UTF8 65001
573 void init_ucs_tables(void);
574 void lpage_send(int codepage, char *buf, int len, int interactive);
575 void luni_send(wchar_t * widebuf, int len, int interactive);
576 wchar_t xlat_uskbd2cyrllic(int ch);
577 int check_compose(int first, int second);
578 int decode_codepage(char *cp_name);
579 char *cp_enumerate (int index);
580 char *cp_name(int codepage);
581 void get_unitab(int codepage, wchar_t * unitab, int ftype);
584 * Exports from mscrypto.c
587 int crypto_startup();
588 void crypto_wrapup();
592 * Exports from pageantc.c
594 void agent_query(void *in, int inlen, void **out, int *outlen);
595 int agent_exists(void);
598 * Exports from wildcard.c
600 const char *wc_error(int value);
601 int wc_match(const char *wildcard, const char *target);
602 int wc_unescape(char *output, const char *wildcard);
605 * Exports from console.c (that aren't equivalents to things in
608 extern int console_batch_mode;
609 extern char *console_password;
610 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);