4 #include <stdio.h> /* for FILENAME_MAX */
5 #include <stddef.h> /* for wchar_t */
8 * Global variables. Most modules declare these `extern', but
9 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
10 * module, and so will get them properly defined.
13 #ifdef PUTTY_DO_GLOBALS
22 typedef struct config_tag Config
;
23 typedef struct backend_tag Backend
;
24 typedef struct terminal_tag Terminal
;
30 /* Three attribute types:
31 * The ATTRs (normal attributes) are stored with the characters in the main
34 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
35 * with characters but not with normal attributes.
37 * The LATTRs (line attributes) conflict with no others and only have one
38 * value per line. But on area clears the LATTR cells are set to the erase_char
39 * (or DEFAULT_ATTR + 'E')
41 * ATTR_INVALID is an illegal colour combination.
44 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
45 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
46 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
48 #define LATTR_NORM 0x00000000UL
49 #define LATTR_WIDE 0x01000000UL
50 #define LATTR_TOP 0x02000000UL
51 #define LATTR_BOT 0x03000000UL
52 #define LATTR_MODE 0x03000000UL
53 #define LATTR_WRAPPED 0x10000000UL
55 #define ATTR_INVALID 0x00FF0000UL
57 /* Like Linux use the F000 page for direct to font. */
58 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
59 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
61 /* These are internal use overlapping with the UTF-16 surrogates */
62 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
63 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
64 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
65 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
66 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
68 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
69 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
71 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
72 #define UCSWIDE 0x303F
74 #define ATTR_NARROW 0x20000000UL
75 #define ATTR_WIDE 0x10000000UL
76 #define ATTR_BOLD 0x01000000UL
77 #define ATTR_UNDER 0x02000000UL
78 #define ATTR_REVERSE 0x04000000UL
79 #define ATTR_BLINK 0x08000000UL
80 #define ATTR_FGMASK 0x000F0000UL
81 #define ATTR_BGMASK 0x00F00000UL
82 #define ATTR_COLOURS 0x00FF0000UL
83 #define ATTR_FGSHIFT 16
84 #define ATTR_BGSHIFT 20
86 #define ATTR_DEFAULT 0x00980000UL
87 #define ATTR_DEFFG 0x00080000UL
88 #define ATTR_DEFBG 0x00900000UL
89 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
90 #define ATTR_MASK 0xFFFFFF00UL
91 #define CHAR_MASK 0x000000FFUL
93 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
94 #define ATTR_CUR_XOR 0x00BA0000UL
99 char *buffer
; /* so memory can be freed later */
102 GLOBAL
int dbcs_screenfont
;
103 GLOBAL
int font_codepage
;
104 GLOBAL
int line_codepage
;
105 GLOBAL
wchar_t unitab_scoacs
[256];
106 GLOBAL
wchar_t unitab_line
[256];
107 GLOBAL
wchar_t unitab_font
[256];
108 GLOBAL
wchar_t unitab_xterm
[256];
109 GLOBAL
wchar_t unitab_oemcp
[256];
110 GLOBAL
unsigned char unitab_ctrl
[256];
112 #define LGXF_OVR 1 /* existing logfile overwrite */
113 #define LGXF_APN 0 /* existing logfile append */
114 #define LGXF_ASK -1 /* existing logfile ask */
115 #define LGTYP_NONE 0 /* logmode: no logging */
116 #define LGTYP_ASCII 1 /* logmode: pure ascii */
117 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
118 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
121 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
122 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
128 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
129 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
130 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
134 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
138 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
143 * SSH ciphers (both SSH1 and SSH2)
145 CIPHER_WARN
, /* pseudo 'cipher' */
148 CIPHER_AES
, /* (SSH 2 only) */
150 CIPHER_MAX
/* no. ciphers (inc warn) */
155 * Line discipline option states: off, on, up to the backend.
157 LD_YES
, LD_NO
, LD_BACKEND
162 * Line discipline options which the backend might try to control.
164 LD_EDIT
, /* local line editing */
165 LD_ECHO
/* local echo */
170 * Close On Exit behaviours. (cfg.close_on_exit)
172 COE_NEVER
, /* Never close the window */
173 COE_NORMAL
, /* Close window on "normal" (non-error) exits only */
174 COE_ALWAYS
/* Always close the window */
178 char *(*init
) (void *frontend_handle
, void **backend_handle
,
179 char *host
, int port
, char **realhost
, int nodelay
);
180 /* back->send() returns the current amount of buffered data. */
181 int (*send
) (void *handle
, char *buf
, int len
);
182 /* back->sendbuffer() does the same thing but without attempting a send */
183 int (*sendbuffer
) (void *handle
);
184 void (*size
) (void *handle
, int width
, int height
);
185 void (*special
) (void *handle
, Telnet_Special code
);
186 Socket(*socket
) (void *handle
);
187 int (*exitcode
) (void *handle
);
188 int (*sendok
) (void *handle
);
189 int (*ldisc
) (void *handle
, int);
190 void (*provide_ldisc
) (void *handle
, void *ldisc
);
191 void (*provide_logctx
) (void *handle
, void *logctx
);
193 * back->unthrottle() tells the back end that the front end
194 * buffer is clearing.
196 void (*unthrottle
) (void *handle
, int);
200 extern struct backend_list
{
210 enum { PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
} protocol
;
213 int ping_interval
; /* in seconds */
216 char proxy_exclude_list
[512];
217 enum { PROXYDNS_NO
, PROXYDNS_AUTO
, PROXYDNS_YES
} proxy_dns
;
218 int even_proxy_localhost
;
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 * These flags describe the type of _application_ - they wouldn't
382 * vary between individual sessions - and so it's OK to have this
383 * variable be GLOBAL.
385 #define FLAG_VERBOSE 0x0001
386 #define FLAG_STDERR 0x0002
387 #define FLAG_INTERACTIVE 0x0004
391 * Likewise, these two variables are set up when the application
392 * initialises, and inform all default-settings accesses after
395 GLOBAL
int default_protocol
;
396 GLOBAL
int default_port
;
398 /* This variable, OTOH, needs to be made non-global ASAP. FIXME. */
401 struct RSAKey
; /* be a little careful of scope */
404 * Exports from window.c.
406 void request_resize(void *frontend
, int, int);
407 void do_text(Context
, int, int, char *, int, unsigned long, int);
408 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
409 int char_width(Context ctx
, int uc
);
410 #ifdef OPTIMISE_SCROLL
411 void do_scroll(void *, int, int, int);
413 void set_title(void *frontend
, char *);
414 void set_icon(void *frontend
, char *);
415 void set_sbar(void *frontend
, int, int, int);
416 Context
get_ctx(void *frontend
);
417 void free_ctx(Context
);
418 void palette_set(void *frontend
, int, int, int, int);
419 void palette_reset(void *frontend
);
420 void write_aclip(void *frontend
, char *, int, int);
421 void write_clip(void *frontend
, wchar_t *, int, int);
422 void get_clip(void *frontend
, wchar_t **, int *);
423 void optimised_move(void *frontend
, int, int, int);
424 void set_raw_mouse_mode(void *frontend
, int);
425 Mouse_Button
translate_button(void *frontend
, Mouse_Button b
);
426 void connection_fatal(void *frontend
, char *, ...);
427 void fatalbox(char *, ...);
428 void modalfatalbox(char *, ...);
430 #pragma noreturn(fatalbox)
431 #pragma noreturn(modalfatalbox)
433 void beep(void *frontend
, int);
434 void begin_session(void *frontend
);
435 void sys_cursor(void *frontend
, int x
, int y
);
436 void request_paste(void *frontend
);
437 void frontend_keypress(void *frontend
);
438 void ldisc_update(void *frontend
, int echo
, int edit
);
439 #define OPTIMISE_IS_SCROLL 1
441 void set_iconic(void *frontend
, int iconic
);
442 void move_window(void *frontend
, int x
, int y
);
443 void set_zorder(void *frontend
, int top
);
444 void refresh_window(void *frontend
);
445 void set_zoomed(void *frontend
, int zoomed
);
446 int is_iconic(void *frontend
);
447 void get_window_pos(void *frontend
, int *x
, int *y
);
448 void get_window_pixels(void *frontend
, int *x
, int *y
);
449 char *get_window_title(void *frontend
, int icon
);
451 void cleanup_exit(int);
454 * Exports from noise.c.
456 void noise_get_heavy(void (*func
) (void *, int));
457 void noise_get_light(void (*func
) (void *, int));
458 void noise_regular(void);
459 void noise_ultralight(unsigned long data
);
460 void random_save_seed(void);
461 void random_destroy_seed(void);
464 * Exports from settings.c.
466 void save_settings(char *section
, int do_host
, Config
* cfg
);
467 void load_settings(char *section
, int do_host
, Config
* cfg
);
468 void load_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
469 void get_sesslist(struct sesslist
*, int allocate
);
470 void do_defaults(char *, Config
*);
471 void registry_cleanup(void);
474 * Exports from terminal.c.
477 Terminal
*term_init(Config
*, void *);
478 void term_size(Terminal
*, int, int, int);
479 void term_out(Terminal
*);
480 void term_paint(Terminal
*, Context
, int, int, int, int, int);
481 void term_scroll(Terminal
*, int, int);
482 void term_pwron(Terminal
*);
483 void term_clrsb(Terminal
*);
484 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Action
, int,int,int,int,int);
485 void term_deselect(Terminal
*);
486 void term_update(Terminal
*);
487 void term_invalidate(Terminal
*);
488 void term_blink(Terminal
*, int set_cursor
);
489 void term_do_paste(Terminal
*);
490 int term_paste_pending(Terminal
*);
491 void term_paste(Terminal
*);
492 void term_nopaste(Terminal
*);
493 int term_ldisc(Terminal
*, int option
);
494 void term_copyall(Terminal
*);
495 void term_reconfig(Terminal
*);
496 void term_seen_key_event(Terminal
*);
497 int from_backend(void *, int is_stderr
, char *data
, int len
);
498 void term_provide_resize_fn(Terminal
*term
,
499 void (*resize_fn
)(void *, int, int),
501 void term_provide_logctx(Terminal
*term
, void *logctx
);
504 * Exports from logging.c.
506 void *log_init(void *frontend
);
507 void logfopen(void *logctx
);
508 void logfclose(void *logctx
);
509 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
510 void log_eventlog(void *logctx
, char *string
);
511 enum { PKT_INCOMING
, PKT_OUTGOING
};
512 void log_packet(void *logctx
, int direction
, int type
,
513 char *texttype
, void *data
, int len
);
516 * Exports from testback.c
519 extern Backend null_backend
;
520 extern Backend loop_backend
;
523 * Exports from raw.c.
526 extern Backend raw_backend
;
529 * Exports from rlogin.c.
532 extern Backend rlogin_backend
;
535 * Exports from telnet.c.
538 extern Backend telnet_backend
;
541 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
542 * so that PuTTYtel will still compile - otherwise it would depend
546 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
548 GLOBAL
int ssh_getline_pw_only
;
549 extern Backend ssh_backend
;
552 * Exports from ldisc.c.
554 void *ldisc_create(Config
*, Terminal
*, Backend
*, void *, void *);
555 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
558 * Exports from ldiscucs.c.
560 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
561 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
564 * Exports from sshrand.c.
567 void random_add_noise(void *noise
, int length
);
568 void random_init(void);
569 int random_byte(void);
570 void random_get_savedata(void **data
, int *len
);
571 extern int random_active
;
574 * Exports from misc.c.
580 * Exports from version.c.
585 * Exports from unicode.c.
588 #define CP_UTF8 65001
591 int is_dbcs_leadbyte(int codepage
, char byte
);
592 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
593 wchar_t *wcstr
, int wclen
);
594 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
595 char *mbstr
, int mblen
, char *defchr
, int *defused
);
596 wchar_t xlat_uskbd2cyrllic(int ch
);
597 int check_compose(int first
, int second
);
598 int decode_codepage(char *cp_name
);
599 char *cp_enumerate (int index
);
600 char *cp_name(int codepage
);
601 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
604 * Exports from wcwidth.c
606 int wcwidth(wchar_t ucs
);
607 int wcswidth(const wchar_t *pwcs
, size_t n
);
610 * Exports from mscrypto.c
613 int crypto_startup();
614 void crypto_wrapup();
618 * Exports from pageantc.c
620 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
621 int agent_exists(void);
624 * Exports from wildcard.c
626 const char *wc_error(int value
);
627 int wc_match(const char *wildcard
, const char *target
);
628 int wc_unescape(char *output
, const char *wildcard
);
631 * Exports from windlg.c
633 void logevent(void *frontend
, char *);
634 void verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
635 char *keystr
, char *fingerprint
);
636 void askcipher(void *frontend
, char *ciphername
, int cs
);
637 int askappend(void *frontend
, char *filename
);
640 * Exports from console.c (that aren't equivalents to things in
643 extern int console_batch_mode
;
644 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
647 * Exports from printing.c.
649 typedef struct printer_enum_tag printer_enum
;
650 typedef struct printer_job_tag printer_job
;
651 printer_enum
*printer_start_enum(int *nprinters
);
652 char *printer_get_name(printer_enum
*, int);
653 void printer_finish_enum(printer_enum
*);
654 printer_job
*printer_start_job(char *printer
);
655 void printer_job_data(printer_job
*, void *, int);
656 void printer_finish_job(printer_job
*);
659 * Exports from cmdline.c (and also cmdline_error(), which is
660 * defined differently in various places and required _by_
663 int cmdline_process_param(char *, char *, int);
664 void cmdline_run_saved(void);
665 extern char *cmdline_password
;
666 #define TOOLTYPE_FILETRANSFER 1
667 extern int cmdline_tooltype
;
669 void cmdline_error(char *, ...);