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];
343 unsigned char colours
[22][3];
344 /* Selection options */
353 char line_codepage
[128];
354 int xlat_capslockcyr
;
357 char x11_display
[128];
358 /* port forwarding */
359 int lport_acceptall
; /* accept conns from hosts other than localhost */
360 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
361 char portfwd
[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
365 * You can compile with -DSSH_DEFAULT to have ssh by default.
368 #define DEFAULT_PROTOCOL PROT_TELNET
369 #define DEFAULT_PORT 23
371 #define DEFAULT_PROTOCOL PROT_SSH
372 #define DEFAULT_PORT 22
376 * Some global flags denoting the type of application.
378 * FLAG_VERBOSE is set when the user requests verbose details.
380 * FLAG_STDERR is set in command-line applications (which have a
381 * functioning stderr that it makes sense to write to) and not in
382 * GUI applications (which don't).
384 * FLAG_INTERACTIVE is set when a full interactive shell session is
385 * being run, _either_ because no remote command has been provided
386 * _or_ because the application is GUI and can't run non-
389 #define FLAG_VERBOSE 0x0001
390 #define FLAG_STDERR 0x0002
391 #define FLAG_INTERACTIVE 0x0004
395 GLOBAL
int default_protocol
;
396 GLOBAL
int default_port
;
398 struct RSAKey
; /* be a little careful of scope */
401 * Exports from window.c.
403 void request_resize(int, int);
404 void do_text(Context
, int, int, char *, int, unsigned long, int);
405 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
406 int CharWidth(Context ctx
, int uc
);
407 void set_title(char *);
408 void set_icon(char *);
409 void set_sbar(int, int, int);
410 Context
get_ctx(void);
411 void free_ctx(Context
);
412 void palette_set(int, int, int, int);
413 void palette_reset(void);
414 void write_aclip(char *, int, int);
415 void write_clip(wchar_t *, int, int);
416 void get_clip(wchar_t **, int *);
417 void optimised_move(int, int, int);
418 void set_raw_mouse_mode(int);
419 Mouse_Button
translate_button(Mouse_Button b
);
420 void connection_fatal(char *, ...);
421 void fatalbox(char *, ...);
423 void begin_session(void);
424 void sys_cursor(int x
, int y
);
425 #define OPTIMISE_IS_SCROLL 1
427 void set_iconic(int iconic
);
428 void move_window(int x
, int y
);
429 void set_zorder(int top
);
430 void refresh_window(void);
431 void set_zoomed(int zoomed
);
433 void get_window_pos(int *x
, int *y
);
434 void get_window_pixels(int *x
, int *y
);
435 char *get_window_title(int icon
);
437 void cleanup_exit(int);
440 * Exports from noise.c.
442 void noise_get_heavy(void (*func
) (void *, int));
443 void noise_get_light(void (*func
) (void *, int));
444 void noise_regular(void);
445 void noise_ultralight(DWORD data
);
446 void random_save_seed(void);
447 void random_destroy_seed(void);
450 * Exports from windlg.c.
452 void defuse_showwindow(void);
454 int do_reconfig(HWND
);
455 void do_defaults(char *, Config
*);
456 void logevent(char *);
457 void showeventlog(HWND
);
458 void showabout(HWND
);
459 void verify_ssh_host_key(char *host
, int port
, char *keytype
,
460 char *keystr
, char *fingerprint
);
461 void askcipher(char *ciphername
, int cs
);
462 int askappend(char *filename
);
463 void registry_cleanup(void);
464 void force_normal(HWND hwnd
);
466 GLOBAL
int nsessions
;
467 GLOBAL
char **sessions
;
470 * Exports from settings.c.
472 void save_settings(char *section
, int do_host
, Config
* cfg
);
473 void load_settings(char *section
, int do_host
, Config
* cfg
);
474 void get_sesslist(int allocate
);
477 * Exports from terminal.c.
480 void term_init(void);
481 void term_size(int, int, int);
483 void term_paint(Context
, int, int, int, int);
484 void term_scroll(int, int);
485 void term_pwron(void);
486 void term_clrsb(void);
487 void term_mouse(Mouse_Button
, Mouse_Action
, int, int, int, int, int);
488 void term_deselect(void);
489 void term_update(void);
490 void term_invalidate(void);
491 void term_blink(int set_cursor
);
492 void term_do_paste(void);
493 void term_paste(void);
494 void term_nopaste(void);
495 int term_ldisc(int option
);
496 int from_backend(int is_stderr
, char *data
, int len
);
498 void logfclose(void);
499 void term_copyall(void);
500 void term_reconfig(void);
503 * Exports from logging.c.
505 void logtraffic(unsigned char c
, int logmode
);
506 enum { PKT_INCOMING
, PKT_OUTGOING
};
507 void log_packet(int direction
, int type
, char *texttype
, void *data
, int len
);
510 * Exports from raw.c.
513 extern Backend raw_backend
;
516 * Exports from rlogin.c.
519 extern Backend rlogin_backend
;
522 * Exports from telnet.c.
525 extern Backend telnet_backend
;
528 * Exports from ssh.c.
531 extern int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
533 extern Backend ssh_backend
;
536 * Exports from ldisc.c.
539 extern void ldisc_send(char *buf
, int len
, int interactive
);
542 * Exports from sshrand.c.
545 void random_add_noise(void *noise
, int length
);
546 void random_init(void);
547 int random_byte(void);
548 void random_get_savedata(void **data
, int *len
);
549 extern int random_active
;
552 * Exports from misc.c.
558 * Exports from version.c.
563 * Exports from sizetip.c.
565 void UpdateSizeTip(HWND src
, int cx
, int cy
);
566 void EnableSizeTip(int bEnable
);
569 * Exports from unicode.c.
572 #define CP_UTF8 65001
574 void init_ucs_tables(void);
575 void lpage_send(int codepage
, char *buf
, int len
, int interactive
);
576 void luni_send(wchar_t * widebuf
, int len
, int interactive
);
577 wchar_t xlat_uskbd2cyrllic(int ch
);
578 int check_compose(int first
, int second
);
579 int decode_codepage(char *cp_name
);
580 char *cp_enumerate (int index
);
581 char *cp_name(int codepage
);
582 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
585 * Exports from mscrypto.c
588 int crypto_startup();
589 void crypto_wrapup();
593 * Exports from pageantc.c
595 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
596 int agent_exists(void);
599 * Exports from wildcard.c
601 const char *wc_error(int value
);
602 int wc_match(const char *wildcard
, const char *target
);
603 int wc_unescape(char *output
, const char *wildcard
);
606 * Exports from console.c (that aren't equivalents to things in
609 extern int console_batch_mode
;
610 extern char *console_password
;
611 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
614 * Exports from printing.c.
616 typedef struct printer_enum_tag printer_enum
;
617 typedef struct printer_job_tag printer_job
;
618 printer_enum
*printer_start_enum(int *nprinters
);
619 char *printer_get_name(printer_enum
*, int);
620 void printer_finish_enum(printer_enum
*);
621 printer_job
*printer_start_job(char *printer
);
622 void printer_job_data(printer_job
*, void *, int);
623 void printer_finish_job(printer_job
*);