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
19 typedef struct config_tag Config
;
20 typedef struct backend_tag Backend
;
26 * Global variables. Most modules declare these `extern', but
27 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
28 * module, and so will get them properly defined.
30 #ifdef PUTTY_DO_GLOBALS
36 /* Three attribute types:
37 * The ATTRs (normal attributes) are stored with the characters in the main
40 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
41 * with characters but not with normal attributes.
43 * The LATTRs (line attributes) conflict with no others and only have one
44 * value per line. But on area clears the LATTR cells are set to the erase_char
45 * (or DEFAULT_ATTR + 'E')
47 * ATTR_INVALID is an illegal colour combination.
50 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
51 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
52 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
54 #define LATTR_NORM 0x00000000UL
55 #define LATTR_WIDE 0x01000000UL
56 #define LATTR_TOP 0x02000000UL
57 #define LATTR_BOT 0x03000000UL
58 #define LATTR_MODE 0x03000000UL
59 #define LATTR_WRAPPED 0x10000000UL
61 #define ATTR_INVALID 0x00FF0000UL
63 /* Like Linux use the F000 page for direct to font. */
64 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
65 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
67 /* These are internal use overlapping with the UTF-16 surrogates */
68 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
69 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
70 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
71 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
72 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
74 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
75 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
77 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
78 #define UCSWIDE 0x303F
80 #define ATTR_NARROW 0x20000000UL
81 #define ATTR_WIDE 0x10000000UL
82 #define ATTR_BOLD 0x01000000UL
83 #define ATTR_UNDER 0x02000000UL
84 #define ATTR_REVERSE 0x04000000UL
85 #define ATTR_BLINK 0x08000000UL
86 #define ATTR_FGMASK 0x000F0000UL
87 #define ATTR_BGMASK 0x00F00000UL
88 #define ATTR_COLOURS 0x00FF0000UL
89 #define ATTR_FGSHIFT 16
90 #define ATTR_BGSHIFT 20
92 #define ATTR_DEFAULT 0x00980000UL
93 #define ATTR_DEFFG 0x00080000UL
94 #define ATTR_DEFBG 0x00900000UL
95 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
96 #define ATTR_MASK 0xFFFFFF00UL
97 #define CHAR_MASK 0x000000FFUL
99 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
100 #define ATTR_CUR_XOR 0x00BA0000UL
102 GLOBAL
int rows
, cols
, savelines
;
104 GLOBAL
int has_focus
;
107 GLOBAL
unsigned long vbell_startpoint
;
109 GLOBAL
int app_cursor_keys
, app_keypad_keys
, vt52_mode
;
110 GLOBAL
int repeat_off
, cr_lf_return
;
112 GLOBAL
int seen_key_event
;
113 GLOBAL
int seen_disp_event
;
114 GLOBAL
int alt_pressed
;
116 GLOBAL
int session_closed
;
118 GLOBAL
int big_cursor
;
120 GLOBAL
char *help_path
;
121 GLOBAL
int help_has_contents
;
123 GLOBAL
int nsessions
;
124 GLOBAL
char **sessions
;
127 GLOBAL
int dbcs_screenfont
;
128 GLOBAL
int font_codepage
;
129 GLOBAL
int kbd_codepage
;
130 GLOBAL
int line_codepage
;
131 GLOBAL
wchar_t unitab_scoacs
[256];
132 GLOBAL
wchar_t unitab_line
[256];
133 GLOBAL
wchar_t unitab_font
[256];
134 GLOBAL
wchar_t unitab_xterm
[256];
135 GLOBAL
wchar_t unitab_oemcp
[256];
136 GLOBAL
unsigned char unitab_ctrl
[256];
137 #define in_utf (utf || line_codepage==CP_UTF8)
139 #define LGXF_OVR 1 /* existing logfile overwrite */
140 #define LGXF_APN 0 /* existing logfile append */
141 #define LGXF_ASK -1 /* existing logfile ask */
142 #define LGTYP_NONE 0 /* logmode: no logging */
143 #define LGTYP_ASCII 1 /* logmode: pure ascii */
144 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
145 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
148 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
149 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
155 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
156 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
157 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
161 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
165 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
170 * SSH ciphers (both SSH1 and SSH2)
172 CIPHER_WARN
, /* pseudo 'cipher' */
175 CIPHER_AES
, /* (SSH 2 only) */
177 CIPHER_MAX
/* no. ciphers (inc warn) */
182 * Line discipline option states: off, on, up to the backend.
184 LD_YES
, LD_NO
, LD_BACKEND
189 * Line discipline options which the backend might try to control.
191 LD_EDIT
, /* local line editing */
192 LD_ECHO
/* local echo */
197 * Close On Exit behaviours. (cfg.close_on_exit)
199 COE_NEVER
, /* Never close the window */
200 COE_NORMAL
, /* Close window on "normal" (non-error) exits only */
201 COE_ALWAYS
/* Always close the window */
205 char *(*init
) (char *host
, int port
, char **realhost
, int nodelay
);
206 /* back->send() returns the current amount of buffered data. */
207 int (*send
) (char *buf
, int len
);
208 /* back->sendbuffer() does the same thing but without attempting a send */
209 int (*sendbuffer
) (void);
211 void (*special
) (Telnet_Special code
);
212 Socket(*socket
) (void);
213 int (*exitcode
) (void);
214 int (*sendok
) (void);
217 * back->unthrottle() tells the back end that the front end
218 * buffer is clearing.
220 void (*unthrottle
) (int);
224 GLOBAL Backend
*back
;
226 extern struct backend_list
{
236 enum { PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
} protocol
;
239 int ping_interval
; /* in seconds */
242 char proxy_exclude_list
[512];
243 enum { PROXY_NONE
, PROXY_HTTP
, PROXY_SOCKS
, PROXY_TELNET
} proxy_type
;
244 char proxy_host
[512];
246 char proxy_username
[32];
247 char proxy_password
[32];
248 char proxy_telnet_command
[512];
249 int proxy_socks_version
;
251 char remote_cmd
[512];
252 char remote_cmd2
[512]; /* fallback if the first fails
253 * (used internally for scp) */
254 char *remote_cmd_ptr
; /* might point to a larger command
255 * but never for loading/saving */
256 char *remote_cmd_ptr2
; /* might point to a larger command
257 * but never for loading/saving */
261 int change_username
; /* allow username switching in SSH2 */
262 int ssh_cipherlist
[CIPHER_MAX
];
263 char keyfile
[FILENAME_MAX
];
264 int sshprot
; /* use v1 or v2 when both available */
265 int ssh2_des_cbc
; /* "des-cbc" nonstandard SSH2 cipher */
268 int ssh_subsys
; /* run a subsystem rather than a command */
269 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
273 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
275 char localusername
[100];
278 /* Keyboard options */
282 int no_applic_c
; /* totally disable app cursor keys */
283 int no_applic_k
; /* totally disable app keypad */
284 int no_mouse_rep
; /* totally disable mouse reporting */
285 int no_remote_resize
; /* disable remote resizing */
286 int no_alt_screen
; /* disable alternate screen */
287 int no_remote_wintitle
; /* disable remote retitling */
288 int no_dbackspace
; /* disable destructive backspace */
289 int no_remote_charset
; /* disable remote charset config */
295 int alt_f4
; /* is it special? */
296 int alt_space
; /* is it special? */
297 int alt_only
; /* is it special? */
301 int fullscreenonaltenter
;
306 char wintitle
[256]; /* initial window title */
307 /* Terminal options */
312 int cursor_type
; /* 0=block 1=underline 2=vertical */
315 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
318 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
320 int bellovl
; /* bell overload protection active? */
321 int bellovl_n
; /* number of bells to cause overload */
322 int bellovl_t
; /* time interval for overload (seconds) */
323 int bellovl_s
; /* period of silence to re-enable bell (s) */
324 char bell_wavefile
[FILENAME_MAX
];
326 int scrollbar_in_fullscreen
;
327 enum { RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
} resize_action
;
336 char logfilename
[FILENAME_MAX
];
342 char answerback
[256];
347 unsigned char colours
[22][3];
348 /* Selection options */
357 char line_codepage
[128];
358 int xlat_capslockcyr
;
361 char x11_display
[128];
362 /* port forwarding */
363 int lport_acceptall
; /* accept conns from hosts other than localhost */
364 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
365 char portfwd
[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
366 /* SSH bug compatibility modes */
368 BUG_AUTO
, BUG_OFF
, BUG_ON
369 } sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
370 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
375 * You can compile with -DSSH_DEFAULT to have ssh by default.
378 #define DEFAULT_PROTOCOL PROT_TELNET
379 #define DEFAULT_PORT 23
381 #define DEFAULT_PROTOCOL PROT_SSH
382 #define DEFAULT_PORT 22
386 * Some global flags denoting the type of application.
388 * FLAG_VERBOSE is set when the user requests verbose details.
390 * FLAG_STDERR is set in command-line applications (which have a
391 * functioning stderr that it makes sense to write to) and not in
392 * GUI applications (which don't).
394 * FLAG_INTERACTIVE is set when a full interactive shell session is
395 * being run, _either_ because no remote command has been provided
396 * _or_ because the application is GUI and can't run non-
399 #define FLAG_VERBOSE 0x0001
400 #define FLAG_STDERR 0x0002
401 #define FLAG_INTERACTIVE 0x0004
405 GLOBAL
int default_protocol
;
406 GLOBAL
int default_port
;
408 struct RSAKey
; /* be a little careful of scope */
411 * Exports from window.c.
413 void request_resize(int, int);
414 void do_text(Context
, int, int, char *, int, unsigned long, int);
415 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
416 int CharWidth(Context ctx
, int uc
);
417 void set_title(char *);
418 void set_icon(char *);
419 void set_sbar(int, int, int);
420 Context
get_ctx(void);
421 void free_ctx(Context
);
422 void palette_set(int, int, int, int);
423 void palette_reset(void);
424 void write_aclip(char *, int, int);
425 void write_clip(wchar_t *, int, int);
426 void get_clip(wchar_t **, int *);
427 void optimised_move(int, int, int);
428 void set_raw_mouse_mode(int);
429 Mouse_Button
translate_button(Mouse_Button b
);
430 void connection_fatal(char *, ...);
431 void fatalbox(char *, ...);
432 void modalfatalbox(char *, ...);
434 void begin_session(void);
435 void sys_cursor(int x
, int y
);
436 void request_paste(void);
437 #define OPTIMISE_IS_SCROLL 1
439 void set_iconic(int iconic
);
440 void move_window(int x
, int y
);
441 void set_zorder(int top
);
442 void refresh_window(void);
443 void set_zoomed(int zoomed
);
445 void get_window_pos(int *x
, int *y
);
446 void get_window_pixels(int *x
, int *y
);
447 char *get_window_title(int icon
);
449 void cleanup_exit(int);
452 * Exports from noise.c.
454 void noise_get_heavy(void (*func
) (void *, int));
455 void noise_get_light(void (*func
) (void *, int));
456 void noise_regular(void);
457 void noise_ultralight(unsigned long data
);
458 void random_save_seed(void);
459 void random_destroy_seed(void);
462 * Exports from settings.c.
464 void save_settings(char *section
, int do_host
, Config
* cfg
);
465 void load_settings(char *section
, int do_host
, Config
* cfg
);
466 void get_sesslist(int allocate
);
467 void do_defaults(char *, Config
*);
468 void registry_cleanup(void);
471 * Exports from terminal.c.
474 void term_init(void);
475 void term_size(int, int, int);
477 void term_paint(Context
, int, int, int, int);
478 void term_scroll(int, int);
479 void term_pwron(void);
480 void term_clrsb(void);
481 void term_mouse(Mouse_Button
, Mouse_Action
, int, int, int, int, int);
482 void term_deselect(void);
483 void term_update(void);
484 void term_invalidate(void);
485 void term_blink(int set_cursor
);
486 void term_do_paste(void);
487 void term_paste(void);
488 void term_nopaste(void);
489 int term_ldisc(int option
);
490 int from_backend(int is_stderr
, char *data
, int len
);
492 void logfclose(void);
493 void term_copyall(void);
494 void term_reconfig(void);
497 * Exports from logging.c.
499 void logtraffic(unsigned char c
, int logmode
);
500 enum { PKT_INCOMING
, PKT_OUTGOING
};
501 void log_eventlog(char *string
);
502 void log_packet(int direction
, int type
, char *texttype
, void *data
, int len
);
505 * Exports from raw.c.
508 extern Backend raw_backend
;
511 * Exports from rlogin.c.
514 extern Backend rlogin_backend
;
517 * Exports from telnet.c.
520 extern Backend telnet_backend
;
523 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
524 * so that PuTTYtel will still compile - otherwise it would depend
528 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
530 GLOBAL
int ssh_getline_pw_only
;
531 extern Backend ssh_backend
;
534 * Exports from ldisc.c.
537 extern void ldisc_send(char *buf
, int len
, int interactive
);
540 * Exports from sshrand.c.
543 void random_add_noise(void *noise
, int length
);
544 void random_init(void);
545 int random_byte(void);
546 void random_get_savedata(void **data
, int *len
);
547 extern int random_active
;
550 * Exports from misc.c.
556 * Exports from version.c.
561 * Exports from unicode.c.
564 #define CP_UTF8 65001
566 void init_ucs_tables(void);
567 void lpage_send(int codepage
, char *buf
, int len
, int interactive
);
568 void luni_send(wchar_t * widebuf
, int len
, int interactive
);
569 wchar_t xlat_uskbd2cyrllic(int ch
);
570 int check_compose(int first
, int second
);
571 int decode_codepage(char *cp_name
);
572 char *cp_enumerate (int index
);
573 char *cp_name(int codepage
);
574 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
577 * Exports from mscrypto.c
580 int crypto_startup();
581 void crypto_wrapup();
585 * Exports from pageantc.c
587 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
588 int agent_exists(void);
591 * Exports from wildcard.c
593 const char *wc_error(int value
);
594 int wc_match(const char *wildcard
, const char *target
);
595 int wc_unescape(char *output
, const char *wildcard
);
598 * Exports from windlg.c
600 void logevent(char *);
601 void verify_ssh_host_key(char *host
, int port
, char *keytype
,
602 char *keystr
, char *fingerprint
);
603 void askcipher(char *ciphername
, int cs
);
604 int askappend(char *filename
);
607 * Exports from console.c (that aren't equivalents to things in
610 extern int console_batch_mode
;
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
*);
626 * Exports from cmdline.c (and also cmdline_error(), which is
627 * defined differently in various places and required _by_
630 int cmdline_process_param(char *, char *, int);
631 void cmdline_run_saved(void);
632 extern char *cmdline_password
;
633 #define TOOLTYPE_FILETRANSFER 1
634 extern int cmdline_tooltype
;
636 void cmdline_error(char *, ...);