4 #include <stdio.h> /* for FILENAME_MAX */
7 * Global variables. Most modules declare these `extern', but
8 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
9 * module, and so will get them properly defined.
12 #ifdef PUTTY_DO_GLOBALS
21 typedef struct config_tag Config
;
22 typedef struct backend_tag Backend
;
23 typedef struct terminal_tag Terminal
;
29 /* Three attribute types:
30 * The ATTRs (normal attributes) are stored with the characters in the main
33 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
34 * with characters but not with normal attributes.
36 * The LATTRs (line attributes) conflict with no others and only have one
37 * value per line. But on area clears the LATTR cells are set to the erase_char
38 * (or DEFAULT_ATTR + 'E')
40 * ATTR_INVALID is an illegal colour combination.
43 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
44 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
45 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
47 #define LATTR_NORM 0x00000000UL
48 #define LATTR_WIDE 0x01000000UL
49 #define LATTR_TOP 0x02000000UL
50 #define LATTR_BOT 0x03000000UL
51 #define LATTR_MODE 0x03000000UL
52 #define LATTR_WRAPPED 0x10000000UL
54 #define ATTR_INVALID 0x00FF0000UL
56 /* Like Linux use the F000 page for direct to font. */
57 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
58 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
60 /* These are internal use overlapping with the UTF-16 surrogates */
61 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
62 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
63 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
64 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
65 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
67 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
68 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
70 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
71 #define UCSWIDE 0x303F
73 #define ATTR_NARROW 0x20000000UL
74 #define ATTR_WIDE 0x10000000UL
75 #define ATTR_BOLD 0x01000000UL
76 #define ATTR_UNDER 0x02000000UL
77 #define ATTR_REVERSE 0x04000000UL
78 #define ATTR_BLINK 0x08000000UL
79 #define ATTR_FGMASK 0x000F0000UL
80 #define ATTR_BGMASK 0x00F00000UL
81 #define ATTR_COLOURS 0x00FF0000UL
82 #define ATTR_FGSHIFT 16
83 #define ATTR_BGSHIFT 20
85 #define ATTR_DEFAULT 0x00980000UL
86 #define ATTR_DEFFG 0x00080000UL
87 #define ATTR_DEFBG 0x00900000UL
88 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
89 #define ATTR_MASK 0xFFFFFF00UL
90 #define CHAR_MASK 0x000000FFUL
92 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
93 #define ATTR_CUR_XOR 0x00BA0000UL
95 GLOBAL
int alt_pressed
;
97 GLOBAL
int session_closed
;
100 GLOBAL
char **sessions
;
103 GLOBAL
int dbcs_screenfont
;
104 GLOBAL
int font_codepage
;
105 GLOBAL
int kbd_codepage
;
106 GLOBAL
int line_codepage
;
107 GLOBAL
wchar_t unitab_scoacs
[256];
108 GLOBAL
wchar_t unitab_line
[256];
109 GLOBAL
wchar_t unitab_font
[256];
110 GLOBAL
wchar_t unitab_xterm
[256];
111 GLOBAL
wchar_t unitab_oemcp
[256];
112 GLOBAL
unsigned char unitab_ctrl
[256];
114 #define LGXF_OVR 1 /* existing logfile overwrite */
115 #define LGXF_APN 0 /* existing logfile append */
116 #define LGXF_ASK -1 /* existing logfile ask */
117 #define LGTYP_NONE 0 /* logmode: no logging */
118 #define LGTYP_ASCII 1 /* logmode: pure ascii */
119 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
120 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
123 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
124 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
130 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
131 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
132 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
136 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
140 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
145 * SSH ciphers (both SSH1 and SSH2)
147 CIPHER_WARN
, /* pseudo 'cipher' */
150 CIPHER_AES
, /* (SSH 2 only) */
152 CIPHER_MAX
/* no. ciphers (inc warn) */
157 * Line discipline option states: off, on, up to the backend.
159 LD_YES
, LD_NO
, LD_BACKEND
164 * Line discipline options which the backend might try to control.
166 LD_EDIT
, /* local line editing */
167 LD_ECHO
/* local echo */
172 * Close On Exit behaviours. (cfg.close_on_exit)
174 COE_NEVER
, /* Never close the window */
175 COE_NORMAL
, /* Close window on "normal" (non-error) exits only */
176 COE_ALWAYS
/* Always close the window */
180 char *(*init
) (void *frontend_handle
, void **backend_handle
,
181 char *host
, int port
, char **realhost
, int nodelay
);
182 /* back->send() returns the current amount of buffered data. */
183 int (*send
) (void *handle
, char *buf
, int len
);
184 /* back->sendbuffer() does the same thing but without attempting a send */
185 int (*sendbuffer
) (void *handle
);
186 void (*size
) (void *handle
, int width
, int height
);
187 void (*special
) (void *handle
, Telnet_Special code
);
188 Socket(*socket
) (void *handle
);
189 int (*exitcode
) (void *handle
);
190 int (*sendok
) (void *handle
);
191 int (*ldisc
) (void *handle
, int);
192 void (*provide_ldisc
) (void *handle
, void *ldisc
);
193 void (*provide_logctx
) (void *handle
, void *logctx
);
195 * back->unthrottle() tells the back end that the front end
196 * buffer is clearing.
198 void (*unthrottle
) (void *handle
, int);
202 extern struct backend_list
{
212 enum { PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
} protocol
;
215 int ping_interval
; /* in seconds */
218 char proxy_exclude_list
[512];
219 enum { PROXY_NONE
, PROXY_HTTP
, PROXY_SOCKS
, PROXY_TELNET
} proxy_type
;
220 char proxy_host
[512];
222 char proxy_username
[32];
223 char proxy_password
[32];
224 char proxy_telnet_command
[512];
225 int proxy_socks_version
;
227 char remote_cmd
[512];
228 char remote_cmd2
[512]; /* fallback if the first fails
229 * (used internally for scp) */
230 char *remote_cmd_ptr
; /* might point to a larger command
231 * but never for loading/saving */
232 char *remote_cmd_ptr2
; /* might point to a larger command
233 * but never for loading/saving */
237 int change_username
; /* allow username switching in SSH2 */
238 int ssh_cipherlist
[CIPHER_MAX
];
239 char keyfile
[FILENAME_MAX
];
240 int sshprot
; /* use v1 or v2 when both available */
241 int ssh2_des_cbc
; /* "des-cbc" nonstandard SSH2 cipher */
244 int ssh_subsys
; /* run a subsystem rather than a command */
245 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
249 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
251 char localusername
[100];
254 /* Keyboard options */
258 int no_applic_c
; /* totally disable app cursor keys */
259 int no_applic_k
; /* totally disable app keypad */
260 int no_mouse_rep
; /* totally disable mouse reporting */
261 int no_remote_resize
; /* disable remote resizing */
262 int no_alt_screen
; /* disable alternate screen */
263 int no_remote_wintitle
; /* disable remote retitling */
264 int no_dbackspace
; /* disable destructive backspace */
265 int no_remote_charset
; /* disable remote charset config */
271 int alt_f4
; /* is it special? */
272 int alt_space
; /* is it special? */
273 int alt_only
; /* is it special? */
277 int fullscreenonaltenter
;
282 char wintitle
[256]; /* initial window title */
283 /* Terminal options */
288 int cursor_type
; /* 0=block 1=underline 2=vertical */
291 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
294 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
296 int bellovl
; /* bell overload protection active? */
297 int bellovl_n
; /* number of bells to cause overload */
298 int bellovl_t
; /* time interval for overload (seconds) */
299 int bellovl_s
; /* period of silence to re-enable bell (s) */
300 char bell_wavefile
[FILENAME_MAX
];
302 int scrollbar_in_fullscreen
;
303 enum { RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
} resize_action
;
312 char logfilename
[FILENAME_MAX
];
318 char answerback
[256];
323 unsigned char colours
[22][3];
324 /* Selection options */
333 char line_codepage
[128];
334 int xlat_capslockcyr
;
337 char x11_display
[128];
338 /* port forwarding */
339 int lport_acceptall
; /* accept conns from hosts other than localhost */
340 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
341 char portfwd
[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
342 /* SSH bug compatibility modes */
344 BUG_AUTO
, BUG_OFF
, BUG_ON
345 } sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
346 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
348 /* Options for pterm. Should split out into platform-dependent part. */
351 int scrollbar_on_left
;
353 int shadowboldoffset
;
357 * You can compile with -DSSH_DEFAULT to have ssh by default.
360 #define DEFAULT_PROTOCOL PROT_TELNET
361 #define DEFAULT_PORT 23
363 #define DEFAULT_PROTOCOL PROT_SSH
364 #define DEFAULT_PORT 22
368 * Some global flags denoting the type of application.
370 * FLAG_VERBOSE is set when the user requests verbose details.
372 * FLAG_STDERR is set in command-line applications (which have a
373 * functioning stderr that it makes sense to write to) and not in
374 * GUI applications (which don't).
376 * FLAG_INTERACTIVE is set when a full interactive shell session is
377 * being run, _either_ because no remote command has been provided
378 * _or_ because the application is GUI and can't run non-
381 #define FLAG_VERBOSE 0x0001
382 #define FLAG_STDERR 0x0002
383 #define FLAG_INTERACTIVE 0x0004
387 GLOBAL
int default_protocol
;
388 GLOBAL
int default_port
;
390 struct RSAKey
; /* be a little careful of scope */
393 * Exports from window.c.
395 void request_resize(void *frontend
, int, int);
396 void do_text(Context
, int, int, char *, int, unsigned long, int);
397 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
398 int CharWidth(Context ctx
, int uc
);
399 void set_title(void *frontend
, char *);
400 void set_icon(void *frontend
, char *);
401 void set_sbar(void *frontend
, int, int, int);
402 Context
get_ctx(void *frontend
);
403 void free_ctx(Context
);
404 void palette_set(void *frontend
, int, int, int, int);
405 void palette_reset(void *frontend
);
406 void write_aclip(void *frontend
, char *, int, int);
407 void write_clip(void *frontend
, wchar_t *, int, int);
408 void get_clip(void *frontend
, wchar_t **, int *);
409 void optimised_move(void *frontend
, int, int, int);
410 void set_raw_mouse_mode(void *frontend
, int);
411 Mouse_Button
translate_button(void *frontend
, Mouse_Button b
);
412 void connection_fatal(void *frontend
, char *, ...);
413 void fatalbox(char *, ...);
414 void modalfatalbox(char *, ...);
415 void beep(void *frontend
, int);
416 void begin_session(void *frontend
);
417 void sys_cursor(void *frontend
, int x
, int y
);
418 void request_paste(void *frontend
);
419 void frontend_keypress(void *frontend
);
420 void ldisc_update(void *frontend
, int echo
, int edit
);
421 #define OPTIMISE_IS_SCROLL 1
423 void set_iconic(void *frontend
, int iconic
);
424 void move_window(void *frontend
, int x
, int y
);
425 void set_zorder(void *frontend
, int top
);
426 void refresh_window(void *frontend
);
427 void set_zoomed(void *frontend
, int zoomed
);
428 int is_iconic(void *frontend
);
429 void get_window_pos(void *frontend
, int *x
, int *y
);
430 void get_window_pixels(void *frontend
, int *x
, int *y
);
431 char *get_window_title(void *frontend
, int icon
);
433 void cleanup_exit(int);
436 * Exports from noise.c.
438 void noise_get_heavy(void (*func
) (void *, int));
439 void noise_get_light(void (*func
) (void *, int));
440 void noise_regular(void);
441 void noise_ultralight(unsigned long data
);
442 void random_save_seed(void);
443 void random_destroy_seed(void);
446 * Exports from settings.c.
448 void save_settings(char *section
, int do_host
, Config
* cfg
);
449 void load_settings(char *section
, int do_host
, Config
* cfg
);
450 void get_sesslist(int allocate
);
451 void do_defaults(char *, Config
*);
452 void registry_cleanup(void);
455 * Exports from terminal.c.
458 Terminal
*term_init(void *frontend
);
459 void term_size(Terminal
*, int, int, int);
460 void term_out(Terminal
*);
461 void term_paint(Terminal
*, Context
, int, int, int, int);
462 void term_scroll(Terminal
*, int, int);
463 void term_pwron(Terminal
*);
464 void term_clrsb(Terminal
*);
465 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Action
, int,int,int,int,int);
466 void term_deselect(Terminal
*);
467 void term_update(Terminal
*);
468 void term_invalidate(Terminal
*);
469 void term_blink(Terminal
*, int set_cursor
);
470 void term_do_paste(Terminal
*);
471 int term_paste_pending(Terminal
*);
472 void term_paste(Terminal
*);
473 void term_nopaste(Terminal
*);
474 int term_ldisc(Terminal
*, int option
);
475 void term_copyall(Terminal
*);
476 void term_reconfig(Terminal
*);
477 void term_seen_key_event(Terminal
*);
478 int from_backend(void *, int is_stderr
, char *data
, int len
);
479 void term_provide_resize_fn(Terminal
*term
,
480 void (*resize_fn
)(void *, int, int),
482 void term_provide_logctx(Terminal
*term
, void *logctx
);
485 * Exports from logging.c.
487 void *log_init(void *frontend
);
488 void logfopen(void *logctx
);
489 void logfclose(void *logctx
);
490 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
491 void log_eventlog(void *logctx
, char *string
);
492 enum { PKT_INCOMING
, PKT_OUTGOING
};
493 void log_packet(void *logctx
, int direction
, int type
,
494 char *texttype
, void *data
, int len
);
497 * Exports from raw.c.
500 extern Backend raw_backend
;
503 * Exports from rlogin.c.
506 extern Backend rlogin_backend
;
509 * Exports from telnet.c.
512 extern Backend telnet_backend
;
515 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
516 * so that PuTTYtel will still compile - otherwise it would depend
520 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
522 GLOBAL
int ssh_getline_pw_only
;
523 extern Backend ssh_backend
;
526 * Exports from ldisc.c.
528 void *ldisc_create(Terminal
*, Backend
*, void *, void *);
529 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
532 * Exports from ldiscucs.c.
534 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
535 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
538 * Exports from sshrand.c.
541 void random_add_noise(void *noise
, int length
);
542 void random_init(void);
543 int random_byte(void);
544 void random_get_savedata(void **data
, int *len
);
545 extern int random_active
;
548 * Exports from misc.c.
554 * Exports from version.c.
559 * Exports from unicode.c.
562 #define CP_UTF8 65001
565 int is_dbcs_leadbyte(int codepage
, char byte
);
566 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
567 wchar_t *wcstr
, int wclen
);
568 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
569 char *mbstr
, int mblen
, char *defchr
, int *defused
);
570 wchar_t xlat_uskbd2cyrllic(int ch
);
571 int check_compose(int first
, int second
);
572 int decode_codepage(char *cp_name
);
573 char *cp_enumerate (int index
);
574 char *cp_name(int codepage
);
575 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
578 * Exports from mscrypto.c
581 int crypto_startup();
582 void crypto_wrapup();
586 * Exports from pageantc.c
588 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
589 int agent_exists(void);
592 * Exports from wildcard.c
594 const char *wc_error(int value
);
595 int wc_match(const char *wildcard
, const char *target
);
596 int wc_unescape(char *output
, const char *wildcard
);
599 * Exports from windlg.c
601 void logevent(void *frontend
, char *);
602 void verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
603 char *keystr
, char *fingerprint
);
604 void askcipher(void *frontend
, char *ciphername
, int cs
);
605 int askappend(void *frontend
, char *filename
);
608 * Exports from console.c (that aren't equivalents to things in
611 extern int console_batch_mode
;
612 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
615 * Exports from printing.c.
617 typedef struct printer_enum_tag printer_enum
;
618 typedef struct printer_job_tag printer_job
;
619 printer_enum
*printer_start_enum(int *nprinters
);
620 char *printer_get_name(printer_enum
*, int);
621 void printer_finish_enum(printer_enum
*);
622 printer_job
*printer_start_job(char *printer
);
623 void printer_job_data(printer_job
*, void *, int);
624 void printer_finish_job(printer_job
*);
627 * Exports from cmdline.c (and also cmdline_error(), which is
628 * defined differently in various places and required _by_
631 int cmdline_process_param(char *, char *, int);
632 void cmdline_run_saved(void);
633 extern char *cmdline_password
;
634 #define TOOLTYPE_FILETRANSFER 1
635 extern int cmdline_tooltype
;
637 void cmdline_error(char *, ...);