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 #define SEL_NL { 13, 10 }
104 GLOBAL
int rows
, cols
, savelines
;
106 GLOBAL
int has_focus
;
109 GLOBAL
unsigned long vbell_startpoint
;
111 GLOBAL
int app_cursor_keys
, app_keypad_keys
, vt52_mode
;
112 GLOBAL
int repeat_off
, cr_lf_return
;
114 GLOBAL
int seen_key_event
;
115 GLOBAL
int seen_disp_event
;
116 GLOBAL
int alt_pressed
;
118 GLOBAL
int session_closed
;
120 GLOBAL
int big_cursor
;
122 GLOBAL
char *help_path
;
123 GLOBAL
int help_has_contents
;
125 GLOBAL
int nsessions
;
126 GLOBAL
char **sessions
;
129 GLOBAL
int dbcs_screenfont
;
130 GLOBAL
int font_codepage
;
131 GLOBAL
int kbd_codepage
;
132 GLOBAL
int line_codepage
;
133 GLOBAL
wchar_t unitab_scoacs
[256];
134 GLOBAL
wchar_t unitab_line
[256];
135 GLOBAL
wchar_t unitab_font
[256];
136 GLOBAL
wchar_t unitab_xterm
[256];
137 GLOBAL
wchar_t unitab_oemcp
[256];
138 GLOBAL
unsigned char unitab_ctrl
[256];
139 #define in_utf (utf || line_codepage==CP_UTF8)
141 #define LGXF_OVR 1 /* existing logfile overwrite */
142 #define LGXF_APN 0 /* existing logfile append */
143 #define LGXF_ASK -1 /* existing logfile ask */
144 #define LGTYP_NONE 0 /* logmode: no logging */
145 #define LGTYP_ASCII 1 /* logmode: pure ascii */
146 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
147 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
150 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
151 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
157 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
158 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
159 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
163 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
167 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
172 * SSH ciphers (both SSH1 and SSH2)
174 CIPHER_WARN
, /* pseudo 'cipher' */
177 CIPHER_AES
, /* (SSH 2 only) */
179 CIPHER_MAX
/* no. ciphers (inc warn) */
184 * Line discipline option states: off, on, up to the backend.
186 LD_YES
, LD_NO
, LD_BACKEND
191 * Line discipline options which the backend might try to control.
193 LD_EDIT
, /* local line editing */
194 LD_ECHO
/* local echo */
199 * Close On Exit behaviours. (cfg.close_on_exit)
201 COE_NEVER
, /* Never close the window */
202 COE_NORMAL
, /* Close window on "normal" (non-error) exits only */
203 COE_ALWAYS
/* Always close the window */
207 char *(*init
) (char *host
, int port
, char **realhost
, int nodelay
);
208 /* back->send() returns the current amount of buffered data. */
209 int (*send
) (char *buf
, int len
);
210 /* back->sendbuffer() does the same thing but without attempting a send */
211 int (*sendbuffer
) (void);
213 void (*special
) (Telnet_Special code
);
214 Socket(*socket
) (void);
215 int (*exitcode
) (void);
216 int (*sendok
) (void);
219 * back->unthrottle() tells the back end that the front end
220 * buffer is clearing.
222 void (*unthrottle
) (int);
226 GLOBAL Backend
*back
;
228 extern struct backend_list
{
238 enum { PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
} protocol
;
241 int ping_interval
; /* in seconds */
244 char proxy_exclude_list
[512];
245 enum { PROXY_NONE
, PROXY_HTTP
, PROXY_SOCKS
, PROXY_TELNET
} proxy_type
;
246 char proxy_host
[512];
248 char proxy_username
[32];
249 char proxy_password
[32];
250 char proxy_telnet_command
[512];
251 int proxy_socks_version
;
253 char remote_cmd
[512];
254 char remote_cmd2
[512]; /* fallback if the first fails
255 * (used internally for scp) */
256 char *remote_cmd_ptr
; /* might point to a larger command
257 * but never for loading/saving */
258 char *remote_cmd_ptr2
; /* might point to a larger command
259 * but never for loading/saving */
263 int change_username
; /* allow username switching in SSH2 */
264 int ssh_cipherlist
[CIPHER_MAX
];
265 char keyfile
[FILENAME_MAX
];
266 int sshprot
; /* use v1 or v2 when both available */
267 int ssh2_des_cbc
; /* "des-cbc" nonstandard SSH2 cipher */
270 int ssh_subsys
; /* run a subsystem rather than a command */
271 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
275 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
277 char localusername
[100];
280 /* Keyboard options */
284 int no_applic_c
; /* totally disable app cursor keys */
285 int no_applic_k
; /* totally disable app keypad */
286 int no_mouse_rep
; /* totally disable mouse reporting */
287 int no_remote_resize
; /* disable remote resizing */
288 int no_alt_screen
; /* disable alternate screen */
289 int no_remote_wintitle
; /* disable remote retitling */
290 int no_dbackspace
; /* disable destructive backspace */
291 int no_remote_charset
; /* disable remote charset config */
297 int alt_f4
; /* is it special? */
298 int alt_space
; /* is it special? */
299 int alt_only
; /* is it special? */
303 int fullscreenonaltenter
;
308 char wintitle
[256]; /* initial window title */
309 /* Terminal options */
314 int cursor_type
; /* 0=block 1=underline 2=vertical */
317 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
320 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
322 int bellovl
; /* bell overload protection active? */
323 int bellovl_n
; /* number of bells to cause overload */
324 int bellovl_t
; /* time interval for overload (seconds) */
325 int bellovl_s
; /* period of silence to re-enable bell (s) */
326 char bell_wavefile
[FILENAME_MAX
];
328 int scrollbar_in_fullscreen
;
329 enum { RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
} resize_action
;
338 char logfilename
[FILENAME_MAX
];
344 char answerback
[256];
349 unsigned char colours
[22][3];
350 /* Selection options */
359 char line_codepage
[128];
360 int xlat_capslockcyr
;
363 char x11_display
[128];
364 /* port forwarding */
365 int lport_acceptall
; /* accept conns from hosts other than localhost */
366 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
367 char portfwd
[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
368 /* SSH bug compatibility modes */
370 BUG_AUTO
, BUG_OFF
, BUG_ON
371 } sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
372 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
377 * You can compile with -DSSH_DEFAULT to have ssh by default.
380 #define DEFAULT_PROTOCOL PROT_TELNET
381 #define DEFAULT_PORT 23
383 #define DEFAULT_PROTOCOL PROT_SSH
384 #define DEFAULT_PORT 22
388 * Some global flags denoting the type of application.
390 * FLAG_VERBOSE is set when the user requests verbose details.
392 * FLAG_STDERR is set in command-line applications (which have a
393 * functioning stderr that it makes sense to write to) and not in
394 * GUI applications (which don't).
396 * FLAG_INTERACTIVE is set when a full interactive shell session is
397 * being run, _either_ because no remote command has been provided
398 * _or_ because the application is GUI and can't run non-
401 #define FLAG_VERBOSE 0x0001
402 #define FLAG_STDERR 0x0002
403 #define FLAG_INTERACTIVE 0x0004
407 GLOBAL
int default_protocol
;
408 GLOBAL
int default_port
;
410 struct RSAKey
; /* be a little careful of scope */
413 * Exports from window.c.
415 void request_resize(int, int);
416 void do_text(Context
, int, int, char *, int, unsigned long, int);
417 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
418 int CharWidth(Context ctx
, int uc
);
419 void set_title(char *);
420 void set_icon(char *);
421 void set_sbar(int, int, int);
422 Context
get_ctx(void);
423 void free_ctx(Context
);
424 void palette_set(int, int, int, int);
425 void palette_reset(void);
426 void write_aclip(char *, int, int);
427 void write_clip(wchar_t *, int, int);
428 void get_clip(wchar_t **, int *);
429 void optimised_move(int, int, int);
430 void set_raw_mouse_mode(int);
431 Mouse_Button
translate_button(Mouse_Button b
);
432 void connection_fatal(char *, ...);
433 void fatalbox(char *, ...);
434 void modalfatalbox(char *, ...);
436 void begin_session(void);
437 void sys_cursor(int x
, int y
);
438 void request_paste(void);
439 #define OPTIMISE_IS_SCROLL 1
441 void set_iconic(int iconic
);
442 void move_window(int x
, int y
);
443 void set_zorder(int top
);
444 void refresh_window(void);
445 void set_zoomed(int zoomed
);
447 void get_window_pos(int *x
, int *y
);
448 void get_window_pixels(int *x
, int *y
);
449 char *get_window_title(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 get_sesslist(int allocate
);
469 void do_defaults(char *, Config
*);
470 void registry_cleanup(void);
473 * Exports from terminal.c.
476 void term_init(void);
477 void term_size(int, int, int);
479 void term_paint(Context
, int, int, int, int);
480 void term_scroll(int, int);
481 void term_pwron(void);
482 void term_clrsb(void);
483 void term_mouse(Mouse_Button
, Mouse_Action
, int, int, int, int, int);
484 void term_deselect(void);
485 void term_update(void);
486 void term_invalidate(void);
487 void term_blink(int set_cursor
);
488 void term_do_paste(void);
489 void term_paste(void);
490 void term_nopaste(void);
491 int term_ldisc(int option
);
492 int from_backend(int is_stderr
, char *data
, int len
);
494 void logfclose(void);
495 void term_copyall(void);
496 void term_reconfig(void);
499 * Exports from logging.c.
501 void logtraffic(unsigned char c
, int logmode
);
502 enum { PKT_INCOMING
, PKT_OUTGOING
};
503 void log_eventlog(char *string
);
504 void log_packet(int direction
, int type
, char *texttype
, void *data
, int len
);
507 * Exports from raw.c.
510 extern Backend raw_backend
;
513 * Exports from rlogin.c.
516 extern Backend rlogin_backend
;
519 * Exports from telnet.c.
522 extern Backend telnet_backend
;
525 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
526 * so that PuTTYtel will still compile - otherwise it would depend
530 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
532 GLOBAL
int ssh_getline_pw_only
;
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 unicode.c.
566 #define CP_UTF8 65001
568 void init_ucs_tables(void);
569 void lpage_send(int codepage
, char *buf
, int len
, int interactive
);
570 void luni_send(wchar_t * widebuf
, int len
, int interactive
);
571 wchar_t xlat_uskbd2cyrllic(int ch
);
572 int check_compose(int first
, int second
);
573 int decode_codepage(char *cp_name
);
574 char *cp_enumerate (int index
);
575 char *cp_name(int codepage
);
576 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
579 * Exports from mscrypto.c
582 int crypto_startup();
583 void crypto_wrapup();
587 * Exports from pageantc.c
589 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
590 int agent_exists(void);
593 * Exports from wildcard.c
595 const char *wc_error(int value
);
596 int wc_match(const char *wildcard
, const char *target
);
597 int wc_unescape(char *output
, const char *wildcard
);
600 * Exports from windlg.c
602 void logevent(char *);
603 void verify_ssh_host_key(char *host
, int port
, char *keytype
,
604 char *keystr
, char *fingerprint
);
605 void askcipher(char *ciphername
, int cs
);
606 int askappend(char *filename
);
609 * Exports from console.c (that aren't equivalents to things in
612 extern int console_batch_mode
;
613 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
616 * Exports from printing.c.
618 typedef struct printer_enum_tag printer_enum
;
619 typedef struct printer_job_tag printer_job
;
620 printer_enum
*printer_start_enum(int *nprinters
);
621 char *printer_get_name(printer_enum
*, int);
622 void printer_finish_enum(printer_enum
*);
623 printer_job
*printer_start_job(char *printer
);
624 void printer_job_data(printer_job
*, void *, int);
625 void printer_finish_job(printer_job
*);
628 * Exports from cmdline.c (and also cmdline_error(), which is
629 * defined differently in various places and required _by_
632 int cmdline_process_param(char *, char *, int);
633 void cmdline_run_saved(void);
634 extern char *cmdline_password
;
635 #define TOOLTYPE_FILETRANSFER 1
636 extern int cmdline_tooltype
;
638 void cmdline_error(char *, ...);