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;
21 typedef struct terminal_tag Terminal;
27 * Global variables. Most modules declare these `extern', but
28 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
29 * module, and so will get them properly defined.
31 #ifdef PUTTY_DO_GLOBALS
37 /* Three attribute types:
38 * The ATTRs (normal attributes) are stored with the characters in the main
41 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
42 * with characters but not with normal attributes.
44 * The LATTRs (line attributes) conflict with no others and only have one
45 * value per line. But on area clears the LATTR cells are set to the erase_char
46 * (or DEFAULT_ATTR + 'E')
48 * ATTR_INVALID is an illegal colour combination.
51 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
52 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
53 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
55 #define LATTR_NORM 0x00000000UL
56 #define LATTR_WIDE 0x01000000UL
57 #define LATTR_TOP 0x02000000UL
58 #define LATTR_BOT 0x03000000UL
59 #define LATTR_MODE 0x03000000UL
60 #define LATTR_WRAPPED 0x10000000UL
62 #define ATTR_INVALID 0x00FF0000UL
64 /* Like Linux use the F000 page for direct to font. */
65 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
66 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
68 /* These are internal use overlapping with the UTF-16 surrogates */
69 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
70 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
71 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
72 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
73 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
75 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
76 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
78 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
79 #define UCSWIDE 0x303F
81 #define ATTR_NARROW 0x20000000UL
82 #define ATTR_WIDE 0x10000000UL
83 #define ATTR_BOLD 0x01000000UL
84 #define ATTR_UNDER 0x02000000UL
85 #define ATTR_REVERSE 0x04000000UL
86 #define ATTR_BLINK 0x08000000UL
87 #define ATTR_FGMASK 0x000F0000UL
88 #define ATTR_BGMASK 0x00F00000UL
89 #define ATTR_COLOURS 0x00FF0000UL
90 #define ATTR_FGSHIFT 16
91 #define ATTR_BGSHIFT 20
93 #define ATTR_DEFAULT 0x00980000UL
94 #define ATTR_DEFFG 0x00080000UL
95 #define ATTR_DEFBG 0x00900000UL
96 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
97 #define ATTR_MASK 0xFFFFFF00UL
98 #define CHAR_MASK 0x000000FFUL
100 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
101 #define ATTR_CUR_XOR 0x00BA0000UL
103 GLOBAL int alt_pressed;
105 GLOBAL int session_closed;
107 GLOBAL char *help_path;
108 GLOBAL int help_has_contents;
110 GLOBAL int nsessions;
111 GLOBAL char **sessions;
114 GLOBAL int dbcs_screenfont;
115 GLOBAL int font_codepage;
116 GLOBAL int kbd_codepage;
117 GLOBAL int line_codepage;
118 GLOBAL wchar_t unitab_scoacs[256];
119 GLOBAL wchar_t unitab_line[256];
120 GLOBAL wchar_t unitab_font[256];
121 GLOBAL wchar_t unitab_xterm[256];
122 GLOBAL wchar_t unitab_oemcp[256];
123 GLOBAL unsigned char unitab_ctrl[256];
125 #define LGXF_OVR 1 /* existing logfile overwrite */
126 #define LGXF_APN 0 /* existing logfile append */
127 #define LGXF_ASK -1 /* existing logfile ask */
128 #define LGTYP_NONE 0 /* logmode: no logging */
129 #define LGTYP_ASCII 1 /* logmode: pure ascii */
130 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
131 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
134 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
135 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
141 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
142 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
143 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
147 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
151 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
156 * SSH ciphers (both SSH1 and SSH2)
158 CIPHER_WARN, /* pseudo 'cipher' */
161 CIPHER_AES, /* (SSH 2 only) */
163 CIPHER_MAX /* no. ciphers (inc warn) */
168 * Line discipline option states: off, on, up to the backend.
170 LD_YES, LD_NO, LD_BACKEND
175 * Line discipline options which the backend might try to control.
177 LD_EDIT, /* local line editing */
178 LD_ECHO /* local echo */
183 * Close On Exit behaviours. (cfg.close_on_exit)
185 COE_NEVER, /* Never close the window */
186 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
187 COE_ALWAYS /* Always close the window */
191 char *(*init) (void *frontend_handle,
192 char *host, int port, char **realhost, int nodelay);
193 /* back->send() returns the current amount of buffered data. */
194 int (*send) (char *buf, int len);
195 /* back->sendbuffer() does the same thing but without attempting a send */
196 int (*sendbuffer) (void);
197 void (*size) (int width, int height);
198 void (*special) (Telnet_Special code);
199 Socket(*socket) (void);
200 int (*exitcode) (void);
201 int (*sendok) (void);
204 * back->unthrottle() tells the back end that the front end
205 * buffer is clearing.
207 void (*unthrottle) (int);
211 GLOBAL Backend *back;
213 extern struct backend_list {
223 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
226 int ping_interval; /* in seconds */
229 char proxy_exclude_list[512];
230 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
231 char proxy_host[512];
233 char proxy_username[32];
234 char proxy_password[32];
235 char proxy_telnet_command[512];
236 int proxy_socks_version;
238 char remote_cmd[512];
239 char remote_cmd2[512]; /* fallback if the first fails
240 * (used internally for scp) */
241 char *remote_cmd_ptr; /* might point to a larger command
242 * but never for loading/saving */
243 char *remote_cmd_ptr2; /* might point to a larger command
244 * but never for loading/saving */
248 int change_username; /* allow username switching in SSH2 */
249 int ssh_cipherlist[CIPHER_MAX];
250 char keyfile[FILENAME_MAX];
251 int sshprot; /* use v1 or v2 when both available */
252 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
255 int ssh_subsys; /* run a subsystem rather than a command */
256 int ssh_subsys2; /* fallback to go with remote_cmd2 */
260 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
262 char localusername[100];
265 /* Keyboard options */
269 int no_applic_c; /* totally disable app cursor keys */
270 int no_applic_k; /* totally disable app keypad */
271 int no_mouse_rep; /* totally disable mouse reporting */
272 int no_remote_resize; /* disable remote resizing */
273 int no_alt_screen; /* disable alternate screen */
274 int no_remote_wintitle; /* disable remote retitling */
275 int no_dbackspace; /* disable destructive backspace */
276 int no_remote_charset; /* disable remote charset config */
282 int alt_f4; /* is it special? */
283 int alt_space; /* is it special? */
284 int alt_only; /* is it special? */
288 int fullscreenonaltenter;
293 char wintitle[256]; /* initial window title */
294 /* Terminal options */
299 int cursor_type; /* 0=block 1=underline 2=vertical */
302 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
305 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
307 int bellovl; /* bell overload protection active? */
308 int bellovl_n; /* number of bells to cause overload */
309 int bellovl_t; /* time interval for overload (seconds) */
310 int bellovl_s; /* period of silence to re-enable bell (s) */
311 char bell_wavefile[FILENAME_MAX];
313 int scrollbar_in_fullscreen;
314 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
323 char logfilename[FILENAME_MAX];
329 char answerback[256];
334 unsigned char colours[22][3];
335 /* Selection options */
344 char line_codepage[128];
345 int xlat_capslockcyr;
348 char x11_display[128];
349 /* port forwarding */
350 int lport_acceptall; /* accept conns from hosts other than localhost */
351 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
352 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
353 /* SSH bug compatibility modes */
355 BUG_AUTO, BUG_OFF, BUG_ON
356 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
357 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
359 /* Options for pterm. Should split out into platform-dependent part. */
362 int scrollbar_on_left;
364 int shadowboldoffset;
368 * You can compile with -DSSH_DEFAULT to have ssh by default.
371 #define DEFAULT_PROTOCOL PROT_TELNET
372 #define DEFAULT_PORT 23
374 #define DEFAULT_PROTOCOL PROT_SSH
375 #define DEFAULT_PORT 22
379 * Some global flags denoting the type of application.
381 * FLAG_VERBOSE is set when the user requests verbose details.
383 * FLAG_STDERR is set in command-line applications (which have a
384 * functioning stderr that it makes sense to write to) and not in
385 * GUI applications (which don't).
387 * FLAG_INTERACTIVE is set when a full interactive shell session is
388 * being run, _either_ because no remote command has been provided
389 * _or_ because the application is GUI and can't run non-
392 #define FLAG_VERBOSE 0x0001
393 #define FLAG_STDERR 0x0002
394 #define FLAG_INTERACTIVE 0x0004
398 GLOBAL int default_protocol;
399 GLOBAL int default_port;
401 GLOBAL Terminal *term; /* temporary while changes are made */
403 struct RSAKey; /* be a little careful of scope */
406 * Exports from window.c.
408 void request_resize(int, int);
409 void do_text(Context, int, int, char *, int, unsigned long, int);
410 void do_cursor(Context, int, int, char *, int, unsigned long, int);
411 int CharWidth(Context ctx, int uc);
412 void set_title(char *);
413 void set_icon(char *);
414 void set_sbar(int, int, int);
415 Context get_ctx(void);
416 void free_ctx(Context);
417 void palette_set(int, int, int, int);
418 void palette_reset(void);
419 void write_aclip(char *, int, int);
420 void write_clip(wchar_t *, int, int);
421 void get_clip(wchar_t **, int *);
422 void optimised_move(int, int, int);
423 void set_raw_mouse_mode(int);
424 Mouse_Button translate_button(Mouse_Button b);
425 void connection_fatal(char *, ...);
426 void fatalbox(char *, ...);
427 void modalfatalbox(char *, ...);
429 void begin_session(void);
430 void sys_cursor(int x, int y);
431 void request_paste(void);
432 void frontend_keypress(void);
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);
463 void do_defaults(char *, Config *);
464 void registry_cleanup(void);
467 * Exports from terminal.c.
470 Terminal *term_init(void);
471 void term_size(Terminal *, int, int, int);
472 void term_out(Terminal *);
473 void term_paint(Terminal *, Context, int, int, int, int);
474 void term_scroll(Terminal *, int, int);
475 void term_pwron(Terminal *);
476 void term_clrsb(Terminal *);
477 void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
478 void term_deselect(Terminal *);
479 void term_update(Terminal *);
480 void term_invalidate(Terminal *);
481 void term_blink(Terminal *, int set_cursor);
482 void term_do_paste(Terminal *);
483 int term_paste_pending(Terminal *);
484 void term_paste(Terminal *);
485 void term_nopaste(Terminal *);
486 int term_ldisc(Terminal *, int option);
487 void term_copyall(Terminal *);
488 void term_reconfig(Terminal *);
489 void term_seen_key_event(Terminal *);
490 int from_backend(void *, int is_stderr, char *data, int len);
493 * Exports from logging.c.
497 void logtraffic(unsigned char c, int logmode);
498 enum { PKT_INCOMING, PKT_OUTGOING };
499 void log_eventlog(char *string);
500 void log_packet(int direction, int type, char *texttype, void *data, int len);
503 * Exports from raw.c.
506 extern Backend raw_backend;
509 * Exports from rlogin.c.
512 extern Backend rlogin_backend;
515 * Exports from telnet.c.
518 extern Backend telnet_backend;
521 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
522 * so that PuTTYtel will still compile - otherwise it would depend
526 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
528 GLOBAL int ssh_getline_pw_only;
529 extern Backend ssh_backend;
532 * Exports from ldisc.c.
535 extern void ldisc_send(char *buf, 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
564 void init_ucs_tables(void);
565 void lpage_send(int codepage, char *buf, int len, int interactive);
566 void luni_send(wchar_t * widebuf, int len, int interactive);
567 wchar_t xlat_uskbd2cyrllic(int ch);
568 int check_compose(int first, int second);
569 int decode_codepage(char *cp_name);
570 char *cp_enumerate (int index);
571 char *cp_name(int codepage);
572 void get_unitab(int codepage, wchar_t * unitab, int ftype);
575 * Exports from mscrypto.c
578 int crypto_startup();
579 void crypto_wrapup();
583 * Exports from pageantc.c
585 void agent_query(void *in, int inlen, void **out, int *outlen);
586 int agent_exists(void);
589 * Exports from wildcard.c
591 const char *wc_error(int value);
592 int wc_match(const char *wildcard, const char *target);
593 int wc_unescape(char *output, const char *wildcard);
596 * Exports from windlg.c
598 void logevent(char *);
599 void verify_ssh_host_key(char *host, int port, char *keytype,
600 char *keystr, char *fingerprint);
601 void askcipher(char *ciphername, int cs);
602 int askappend(char *filename);
605 * Exports from console.c (that aren't equivalents to things in
608 extern int console_batch_mode;
609 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
612 * Exports from printing.c.
614 typedef struct printer_enum_tag printer_enum;
615 typedef struct printer_job_tag printer_job;
616 printer_enum *printer_start_enum(int *nprinters);
617 char *printer_get_name(printer_enum *, int);
618 void printer_finish_enum(printer_enum *);
619 printer_job *printer_start_job(char *printer);
620 void printer_job_data(printer_job *, void *, int);
621 void printer_finish_job(printer_job *);
624 * Exports from cmdline.c (and also cmdline_error(), which is
625 * defined differently in various places and required _by_
628 int cmdline_process_param(char *, char *, int);
629 void cmdline_run_saved(void);
630 extern char *cmdline_password;
631 #define TOOLTYPE_FILETRANSFER 1
632 extern int cmdline_tooltype;
634 void cmdline_error(char *, ...);