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;
25 * Global variables. Most modules declare these `extern', but
26 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
27 * module, and so will get them properly defined.
29 #ifdef PUTTY_DO_GLOBALS
35 /* Three attribute types:
36 * The ATTRs (normal attributes) are stored with the characters in the main
39 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
40 * with characters but not with normal attributes.
42 * The LATTRs (line attributes) conflict with no others and only have one
43 * value per line. But on area clears the LATTR cells are set to the erase_char
44 * (or DEFAULT_ATTR + 'E')
46 * ATTR_INVALID is an illegal colour combination.
49 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
50 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
51 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
53 #define LATTR_NORM 0x00000000UL
54 #define LATTR_WIDE 0x01000000UL
55 #define LATTR_TOP 0x02000000UL
56 #define LATTR_BOT 0x03000000UL
57 #define LATTR_MODE 0x03000000UL
58 #define LATTR_WRAPPED 0x10000000UL
60 #define ATTR_INVALID 0x00FF0000UL
62 /* Like Linux use the F000 page for direct to font. */
63 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
64 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
66 /* These are internal use overlapping with the UTF-16 surrogates */
67 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
68 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
69 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
70 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
71 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
73 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
74 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
76 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
77 #define UCSWIDE 0x303F
79 #define ATTR_NARROW 0x20000000UL
80 #define ATTR_WIDE 0x10000000UL
81 #define ATTR_BOLD 0x01000000UL
82 #define ATTR_UNDER 0x02000000UL
83 #define ATTR_REVERSE 0x04000000UL
84 #define ATTR_BLINK 0x08000000UL
85 #define ATTR_FGMASK 0x000F0000UL
86 #define ATTR_BGMASK 0x00F00000UL
87 #define ATTR_COLOURS 0x00FF0000UL
88 #define ATTR_FGSHIFT 16
89 #define ATTR_BGSHIFT 20
91 #define ATTR_DEFAULT 0x00980000UL
92 #define ATTR_DEFFG 0x00080000UL
93 #define ATTR_DEFBG 0x00900000UL
94 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
95 #define ATTR_MASK 0xFFFFFF00UL
96 #define CHAR_MASK 0x000000FFUL
98 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
99 #define ATTR_CUR_XOR 0x00BA0000UL
101 #define SEL_NL { 13, 10 }
103 GLOBAL int rows, cols, savelines;
105 GLOBAL int has_focus;
108 GLOBAL unsigned long vbell_startpoint;
110 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
111 GLOBAL int repeat_off, cr_lf_return;
113 GLOBAL int seen_key_event;
114 GLOBAL int seen_disp_event;
115 GLOBAL int alt_pressed;
117 GLOBAL int session_closed;
119 GLOBAL int big_cursor;
121 GLOBAL char *help_path;
122 GLOBAL int help_has_contents;
125 GLOBAL int dbcs_screenfont;
126 GLOBAL int font_codepage;
127 GLOBAL int kbd_codepage;
128 GLOBAL int line_codepage;
129 GLOBAL wchar_t unitab_scoacs[256];
130 GLOBAL wchar_t unitab_line[256];
131 GLOBAL wchar_t unitab_font[256];
132 GLOBAL wchar_t unitab_xterm[256];
133 GLOBAL wchar_t unitab_oemcp[256];
134 GLOBAL unsigned char unitab_ctrl[256];
135 #define in_utf (utf || line_codepage==CP_UTF8)
137 #define LGXF_OVR 1 /* existing logfile overwrite */
138 #define LGXF_APN 0 /* existing logfile append */
139 #define LGXF_ASK -1 /* existing logfile ask */
140 #define LGTYP_NONE 0 /* logmode: no logging */
141 #define LGTYP_ASCII 1 /* logmode: pure ascii */
142 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
143 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
146 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
147 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
153 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
154 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
155 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
159 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
163 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
168 * SSH ciphers (both SSH1 and SSH2)
170 CIPHER_WARN, /* pseudo 'cipher' */
173 CIPHER_AES, /* (SSH 2 only) */
175 CIPHER_MAX /* no. ciphers (inc warn) */
180 * Line discipline option states: off, on, up to the backend.
182 LD_YES, LD_NO, LD_BACKEND
187 * Line discipline options which the backend might try to control.
189 LD_EDIT, /* local line editing */
190 LD_ECHO /* local echo */
195 * Close On Exit behaviours. (cfg.close_on_exit)
197 COE_NEVER, /* Never close the window */
198 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
199 COE_ALWAYS /* Always close the window */
203 char *(*init) (char *host, int port, char **realhost, int nodelay);
204 /* back->send() returns the current amount of buffered data. */
205 int (*send) (char *buf, int len);
206 /* back->sendbuffer() does the same thing but without attempting a send */
207 int (*sendbuffer) (void);
209 void (*special) (Telnet_Special code);
210 Socket(*socket) (void);
211 int (*exitcode) (void);
212 int (*sendok) (void);
215 * back->unthrottle() tells the back end that the front end
216 * buffer is clearing.
218 void (*unthrottle) (int);
222 GLOBAL Backend *back;
224 extern struct backend_list {
234 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
237 int ping_interval; /* in seconds */
240 char proxy_exclude_list[512];
241 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
242 char proxy_host[512];
244 char proxy_username[32];
245 char proxy_password[32];
246 char proxy_telnet_command[512];
247 int proxy_socks_version;
249 char remote_cmd[512];
250 char remote_cmd2[512]; /* fallback if the first fails
251 * (used internally for scp) */
252 char *remote_cmd_ptr; /* might point to a larger command
253 * but never for loading/saving */
254 char *remote_cmd_ptr2; /* might point to a larger command
255 * but never for loading/saving */
259 int change_username; /* allow username switching in SSH2 */
260 int ssh_cipherlist[CIPHER_MAX];
261 char keyfile[FILENAME_MAX];
262 int sshprot; /* use v1 or v2 when both available */
263 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
266 int ssh_subsys; /* run a subsystem rather than a command */
267 int ssh_subsys2; /* fallback to go with remote_cmd2 */
271 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
273 char localusername[100];
276 /* Keyboard options */
280 int no_applic_c; /* totally disable app cursor keys */
281 int no_applic_k; /* totally disable app keypad */
282 int no_mouse_rep; /* totally disable mouse reporting */
283 int no_remote_resize; /* disable remote resizing */
284 int no_alt_screen; /* disable alternate screen */
285 int no_remote_wintitle; /* disable remote retitling */
286 int no_dbackspace; /* disable destructive backspace */
287 int no_remote_charset; /* disable remote charset config */
293 int alt_f4; /* is it special? */
294 int alt_space; /* is it special? */
295 int alt_only; /* is it special? */
299 int fullscreenonaltenter;
304 char wintitle[256]; /* initial window title */
305 /* Terminal options */
310 int cursor_type; /* 0=block 1=underline 2=vertical */
313 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
316 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
318 int bellovl; /* bell overload protection active? */
319 int bellovl_n; /* number of bells to cause overload */
320 int bellovl_t; /* time interval for overload (seconds) */
321 int bellovl_s; /* period of silence to re-enable bell (s) */
322 char bell_wavefile[FILENAME_MAX];
324 int scrollbar_in_fullscreen;
325 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
334 char logfilename[FILENAME_MAX];
340 char answerback[256];
345 unsigned char colours[22][3];
346 /* Selection options */
355 char line_codepage[128];
356 int xlat_capslockcyr;
359 char x11_display[128];
360 /* port forwarding */
361 int lport_acceptall; /* accept conns from hosts other than localhost */
362 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
363 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
364 /* SSH bug compatibility modes */
366 BUG_AUTO, BUG_OFF, BUG_ON
367 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
368 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
373 * You can compile with -DSSH_DEFAULT to have ssh by default.
376 #define DEFAULT_PROTOCOL PROT_TELNET
377 #define DEFAULT_PORT 23
379 #define DEFAULT_PROTOCOL PROT_SSH
380 #define DEFAULT_PORT 22
384 * Some global flags denoting the type of application.
386 * FLAG_VERBOSE is set when the user requests verbose details.
388 * FLAG_STDERR is set in command-line applications (which have a
389 * functioning stderr that it makes sense to write to) and not in
390 * GUI applications (which don't).
392 * FLAG_INTERACTIVE is set when a full interactive shell session is
393 * being run, _either_ because no remote command has been provided
394 * _or_ because the application is GUI and can't run non-
397 #define FLAG_VERBOSE 0x0001
398 #define FLAG_STDERR 0x0002
399 #define FLAG_INTERACTIVE 0x0004
403 GLOBAL int default_protocol;
404 GLOBAL int default_port;
406 struct RSAKey; /* be a little careful of scope */
409 * Exports from window.c.
411 void request_resize(int, int);
412 void do_text(Context, int, int, char *, int, unsigned long, int);
413 void do_cursor(Context, int, int, char *, int, unsigned long, int);
414 int CharWidth(Context ctx, int uc);
415 void set_title(char *);
416 void set_icon(char *);
417 void set_sbar(int, int, int);
418 Context get_ctx(void);
419 void free_ctx(Context);
420 void palette_set(int, int, int, int);
421 void palette_reset(void);
422 void write_aclip(char *, int, int);
423 void write_clip(wchar_t *, int, int);
424 void get_clip(wchar_t **, int *);
425 void optimised_move(int, int, int);
426 void set_raw_mouse_mode(int);
427 Mouse_Button translate_button(Mouse_Button b);
428 void connection_fatal(char *, ...);
429 void fatalbox(char *, ...);
431 void begin_session(void);
432 void sys_cursor(int x, int y);
433 #define OPTIMISE_IS_SCROLL 1
435 void set_iconic(int iconic);
436 void move_window(int x, int y);
437 void set_zorder(int top);
438 void refresh_window(void);
439 void set_zoomed(int zoomed);
441 void get_window_pos(int *x, int *y);
442 void get_window_pixels(int *x, int *y);
443 char *get_window_title(int icon);
445 void cleanup_exit(int);
448 * Exports from noise.c.
450 void noise_get_heavy(void (*func) (void *, int));
451 void noise_get_light(void (*func) (void *, int));
452 void noise_regular(void);
453 void noise_ultralight(unsigned long data);
454 void random_save_seed(void);
455 void random_destroy_seed(void);
458 * Exports from settings.c.
460 void save_settings(char *section, int do_host, Config * cfg);
461 void load_settings(char *section, int do_host, Config * cfg);
462 void get_sesslist(int allocate);
465 * Exports from terminal.c.
468 void term_init(void);
469 void term_size(int, int, int);
471 void term_paint(Context, int, int, int, int);
472 void term_scroll(int, int);
473 void term_pwron(void);
474 void term_clrsb(void);
475 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
476 void term_deselect(void);
477 void term_update(void);
478 void term_invalidate(void);
479 void term_blink(int set_cursor);
480 void term_do_paste(void);
481 void term_paste(void);
482 void term_nopaste(void);
483 int term_ldisc(int option);
484 int from_backend(int is_stderr, char *data, int len);
486 void logfclose(void);
487 void term_copyall(void);
488 void term_reconfig(void);
491 * Exports from logging.c.
493 void logtraffic(unsigned char c, int logmode);
494 enum { PKT_INCOMING, PKT_OUTGOING };
495 void log_eventlog(char *string);
496 void log_packet(int direction, int type, char *texttype, void *data, int len);
499 * Exports from raw.c.
502 extern Backend raw_backend;
505 * Exports from rlogin.c.
508 extern Backend rlogin_backend;
511 * Exports from telnet.c.
514 extern Backend telnet_backend;
517 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
518 * so that PuTTYtel will still compile - otherwise it would depend
522 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
524 GLOBAL int ssh_getline_pw_only;
525 extern Backend ssh_backend;
528 * Exports from ldisc.c.
531 extern void ldisc_send(char *buf, int len, int interactive);
534 * Exports from sshrand.c.
537 void random_add_noise(void *noise, int length);
538 void random_init(void);
539 int random_byte(void);
540 void random_get_savedata(void **data, int *len);
541 extern int random_active;
544 * Exports from misc.c.
550 * Exports from version.c.
555 * Exports from unicode.c.
558 #define CP_UTF8 65001
560 void init_ucs_tables(void);
561 void lpage_send(int codepage, char *buf, int len, int interactive);
562 void luni_send(wchar_t * widebuf, int len, int interactive);
563 wchar_t xlat_uskbd2cyrllic(int ch);
564 int check_compose(int first, int second);
565 int decode_codepage(char *cp_name);
566 char *cp_enumerate (int index);
567 char *cp_name(int codepage);
568 void get_unitab(int codepage, wchar_t * unitab, int ftype);
571 * Exports from mscrypto.c
574 int crypto_startup();
575 void crypto_wrapup();
579 * Exports from pageantc.c
581 void agent_query(void *in, int inlen, void **out, int *outlen);
582 int agent_exists(void);
585 * Exports from wildcard.c
587 const char *wc_error(int value);
588 int wc_match(const char *wildcard, const char *target);
589 int wc_unescape(char *output, const char *wildcard);
592 * Exports from console.c (that aren't equivalents to things in
595 extern int console_batch_mode;
596 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
599 * Exports from printing.c.
601 typedef struct printer_enum_tag printer_enum;
602 typedef struct printer_job_tag printer_job;
603 printer_enum *printer_start_enum(int *nprinters);
604 char *printer_get_name(printer_enum *, int);
605 void printer_finish_enum(printer_enum *);
606 printer_job *printer_start_job(char *printer);
607 void printer_job_data(printer_job *, void *, int);
608 void printer_finish_job(printer_job *);
611 * Exports from cmdline.c (and also cmdline_error(), which is
612 * defined differently in various places and required _by_
615 int cmdline_process_param(char *, char *, int);
616 void cmdline_run_saved(void);
617 extern char *cmdline_password;
618 #define TOOLTYPE_FILETRANSFER 1
619 extern int cmdline_tooltype;
621 void cmdline_error(char *, ...);