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;
26 /* Three attribute types:
27 * The ATTRs (normal attributes) are stored with the characters in the main
30 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
31 * with characters but not with normal attributes.
33 * The LATTRs (line attributes) conflict with no others and only have one
34 * value per line. But on area clears the LATTR cells are set to the erase_char
35 * (or DEFAULT_ATTR + 'E')
37 * ATTR_INVALID is an illegal colour combination.
40 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
41 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
42 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
44 #define LATTR_NORM 0x00000000UL
45 #define LATTR_WIDE 0x01000000UL
46 #define LATTR_TOP 0x02000000UL
47 #define LATTR_BOT 0x03000000UL
48 #define LATTR_MODE 0x03000000UL
49 #define LATTR_WRAPPED 0x10000000UL
51 #define ATTR_INVALID 0x00FF0000UL
53 /* Like Linux use the F000 page for direct to font. */
54 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
55 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
57 /* These are internal use overlapping with the UTF-16 surrogates */
58 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
59 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
60 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
61 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
62 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
64 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
65 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
67 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
68 #define UCSWIDE 0x303F
70 #define ATTR_NARROW 0x20000000UL
71 #define ATTR_WIDE 0x10000000UL
72 #define ATTR_BOLD 0x01000000UL
73 #define ATTR_UNDER 0x02000000UL
74 #define ATTR_REVERSE 0x04000000UL
75 #define ATTR_BLINK 0x08000000UL
76 #define ATTR_FGMASK 0x000F0000UL
77 #define ATTR_BGMASK 0x00F00000UL
78 #define ATTR_COLOURS 0x00FF0000UL
79 #define ATTR_FGSHIFT 16
80 #define ATTR_BGSHIFT 20
82 #define ATTR_DEFAULT 0x00980000UL
83 #define ATTR_DEFFG 0x00080000UL
84 #define ATTR_DEFBG 0x00900000UL
85 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
86 #define ATTR_MASK 0xFFFFFF00UL
87 #define CHAR_MASK 0x000000FFUL
89 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
90 #define ATTR_CUR_XOR 0x00BA0000UL
92 GLOBAL int alt_pressed;
94 GLOBAL int session_closed;
97 GLOBAL char **sessions;
100 GLOBAL int dbcs_screenfont;
101 GLOBAL int font_codepage;
102 GLOBAL int kbd_codepage;
103 GLOBAL int line_codepage;
104 GLOBAL wchar_t unitab_scoacs[256];
105 GLOBAL wchar_t unitab_line[256];
106 GLOBAL wchar_t unitab_font[256];
107 GLOBAL wchar_t unitab_xterm[256];
108 GLOBAL wchar_t unitab_oemcp[256];
109 GLOBAL unsigned char unitab_ctrl[256];
111 #define LGXF_OVR 1 /* existing logfile overwrite */
112 #define LGXF_APN 0 /* existing logfile append */
113 #define LGXF_ASK -1 /* existing logfile ask */
114 #define LGTYP_NONE 0 /* logmode: no logging */
115 #define LGTYP_ASCII 1 /* logmode: pure ascii */
116 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
117 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
120 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
121 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
127 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
128 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
129 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
133 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
137 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
142 * SSH ciphers (both SSH1 and SSH2)
144 CIPHER_WARN, /* pseudo 'cipher' */
147 CIPHER_AES, /* (SSH 2 only) */
149 CIPHER_MAX /* no. ciphers (inc warn) */
154 * Line discipline option states: off, on, up to the backend.
156 LD_YES, LD_NO, LD_BACKEND
161 * Line discipline options which the backend might try to control.
163 LD_EDIT, /* local line editing */
164 LD_ECHO /* local echo */
169 * Close On Exit behaviours. (cfg.close_on_exit)
171 COE_NEVER, /* Never close the window */
172 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
173 COE_ALWAYS /* Always close the window */
177 char *(*init) (void *frontend_handle, void **backend_handle,
178 char *host, int port, char **realhost, int nodelay);
179 /* back->send() returns the current amount of buffered data. */
180 int (*send) (void *handle, char *buf, int len);
181 /* back->sendbuffer() does the same thing but without attempting a send */
182 int (*sendbuffer) (void *handle);
183 void (*size) (void *handle, int width, int height);
184 void (*special) (void *handle, Telnet_Special code);
185 Socket(*socket) (void *handle);
186 int (*exitcode) (void *handle);
187 int (*sendok) (void *handle);
188 int (*ldisc) (void *handle, int);
189 void (*provide_ldisc) (void *handle, void *ldisc);
191 * back->unthrottle() tells the back end that the front end
192 * buffer is clearing.
194 void (*unthrottle) (void *handle, int);
198 extern struct backend_list {
208 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
211 int ping_interval; /* in seconds */
214 char proxy_exclude_list[512];
215 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
216 char proxy_host[512];
218 char proxy_username[32];
219 char proxy_password[32];
220 char proxy_telnet_command[512];
221 int proxy_socks_version;
223 char remote_cmd[512];
224 char remote_cmd2[512]; /* fallback if the first fails
225 * (used internally for scp) */
226 char *remote_cmd_ptr; /* might point to a larger command
227 * but never for loading/saving */
228 char *remote_cmd_ptr2; /* might point to a larger command
229 * but never for loading/saving */
233 int change_username; /* allow username switching in SSH2 */
234 int ssh_cipherlist[CIPHER_MAX];
235 char keyfile[FILENAME_MAX];
236 int sshprot; /* use v1 or v2 when both available */
237 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
240 int ssh_subsys; /* run a subsystem rather than a command */
241 int ssh_subsys2; /* fallback to go with remote_cmd2 */
245 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
247 char localusername[100];
250 /* Keyboard options */
254 int no_applic_c; /* totally disable app cursor keys */
255 int no_applic_k; /* totally disable app keypad */
256 int no_mouse_rep; /* totally disable mouse reporting */
257 int no_remote_resize; /* disable remote resizing */
258 int no_alt_screen; /* disable alternate screen */
259 int no_remote_wintitle; /* disable remote retitling */
260 int no_dbackspace; /* disable destructive backspace */
261 int no_remote_charset; /* disable remote charset config */
267 int alt_f4; /* is it special? */
268 int alt_space; /* is it special? */
269 int alt_only; /* is it special? */
273 int fullscreenonaltenter;
278 char wintitle[256]; /* initial window title */
279 /* Terminal options */
284 int cursor_type; /* 0=block 1=underline 2=vertical */
287 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
290 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
292 int bellovl; /* bell overload protection active? */
293 int bellovl_n; /* number of bells to cause overload */
294 int bellovl_t; /* time interval for overload (seconds) */
295 int bellovl_s; /* period of silence to re-enable bell (s) */
296 char bell_wavefile[FILENAME_MAX];
298 int scrollbar_in_fullscreen;
299 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
308 char logfilename[FILENAME_MAX];
314 char answerback[256];
319 unsigned char colours[22][3];
320 /* Selection options */
329 char line_codepage[128];
330 int xlat_capslockcyr;
333 char x11_display[128];
334 /* port forwarding */
335 int lport_acceptall; /* accept conns from hosts other than localhost */
336 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
337 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
338 /* SSH bug compatibility modes */
340 BUG_AUTO, BUG_OFF, BUG_ON
341 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
342 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
344 /* Options for pterm. Should split out into platform-dependent part. */
347 int scrollbar_on_left;
349 int shadowboldoffset;
353 * You can compile with -DSSH_DEFAULT to have ssh by default.
356 #define DEFAULT_PROTOCOL PROT_TELNET
357 #define DEFAULT_PORT 23
359 #define DEFAULT_PROTOCOL PROT_SSH
360 #define DEFAULT_PORT 22
364 * Some global flags denoting the type of application.
366 * FLAG_VERBOSE is set when the user requests verbose details.
368 * FLAG_STDERR is set in command-line applications (which have a
369 * functioning stderr that it makes sense to write to) and not in
370 * GUI applications (which don't).
372 * FLAG_INTERACTIVE is set when a full interactive shell session is
373 * being run, _either_ because no remote command has been provided
374 * _or_ because the application is GUI and can't run non-
377 #define FLAG_VERBOSE 0x0001
378 #define FLAG_STDERR 0x0002
379 #define FLAG_INTERACTIVE 0x0004
383 GLOBAL int default_protocol;
384 GLOBAL int default_port;
386 GLOBAL Terminal *term; /* temporary while changes are made */
388 struct RSAKey; /* be a little careful of scope */
391 * Exports from window.c.
393 void request_resize(int, int);
394 void do_text(Context, int, int, char *, int, unsigned long, int);
395 void do_cursor(Context, int, int, char *, int, unsigned long, int);
396 int CharWidth(Context ctx, int uc);
397 void set_title(char *);
398 void set_icon(char *);
399 void set_sbar(int, int, int);
400 Context get_ctx(void);
401 void free_ctx(Context);
402 void palette_set(int, int, int, int);
403 void palette_reset(void);
404 void write_aclip(char *, int, int);
405 void write_clip(wchar_t *, int, int);
406 void get_clip(wchar_t **, int *);
407 void optimised_move(int, int, int);
408 void set_raw_mouse_mode(int);
409 Mouse_Button translate_button(Mouse_Button b);
410 void connection_fatal(char *, ...);
411 void fatalbox(char *, ...);
412 void modalfatalbox(char *, ...);
414 void begin_session(void);
415 void sys_cursor(int x, int y);
416 void request_paste(void);
417 void frontend_keypress(void *frontend);
418 void ldisc_update(void *frontend, int echo, int edit);
419 #define OPTIMISE_IS_SCROLL 1
421 void set_iconic(int iconic);
422 void move_window(int x, int y);
423 void set_zorder(int top);
424 void refresh_window(void);
425 void set_zoomed(int zoomed);
427 void get_window_pos(int *x, int *y);
428 void get_window_pixels(int *x, int *y);
429 char *get_window_title(int icon);
431 void cleanup_exit(int);
434 * Exports from noise.c.
436 void noise_get_heavy(void (*func) (void *, int));
437 void noise_get_light(void (*func) (void *, int));
438 void noise_regular(void);
439 void noise_ultralight(unsigned long data);
440 void random_save_seed(void);
441 void random_destroy_seed(void);
444 * Exports from settings.c.
446 void save_settings(char *section, int do_host, Config * cfg);
447 void load_settings(char *section, int do_host, Config * cfg);
448 void get_sesslist(int allocate);
449 void do_defaults(char *, Config *);
450 void registry_cleanup(void);
453 * Exports from terminal.c.
456 Terminal *term_init(void);
457 void term_size(Terminal *, int, int, int);
458 void term_out(Terminal *);
459 void term_paint(Terminal *, Context, int, int, int, int);
460 void term_scroll(Terminal *, int, int);
461 void term_pwron(Terminal *);
462 void term_clrsb(Terminal *);
463 void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
464 void term_deselect(Terminal *);
465 void term_update(Terminal *);
466 void term_invalidate(Terminal *);
467 void term_blink(Terminal *, int set_cursor);
468 void term_do_paste(Terminal *);
469 int term_paste_pending(Terminal *);
470 void term_paste(Terminal *);
471 void term_nopaste(Terminal *);
472 int term_ldisc(Terminal *, int option);
473 void term_copyall(Terminal *);
474 void term_reconfig(Terminal *);
475 void term_seen_key_event(Terminal *);
476 int from_backend(void *, int is_stderr, char *data, int len);
477 void term_provide_resize_fn(Terminal *term,
478 void (*resize_fn)(void *, int, int),
482 * Exports from logging.c.
486 void logtraffic(unsigned char c, int logmode);
487 enum { PKT_INCOMING, PKT_OUTGOING };
488 void log_eventlog(char *string);
489 void log_packet(int direction, int type, char *texttype, void *data, int len);
492 * Exports from raw.c.
495 extern Backend raw_backend;
498 * Exports from rlogin.c.
501 extern Backend rlogin_backend;
504 * Exports from telnet.c.
507 extern Backend telnet_backend;
510 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
511 * so that PuTTYtel will still compile - otherwise it would depend
515 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
517 GLOBAL int ssh_getline_pw_only;
518 extern Backend ssh_backend;
521 * Exports from ldisc.c.
524 void *ldisc_create(Terminal *, Backend *, void *, void *);
525 void ldisc_send(void *handle, char *buf, int len, int interactive);
528 * Exports from sshrand.c.
531 void random_add_noise(void *noise, int length);
532 void random_init(void);
533 int random_byte(void);
534 void random_get_savedata(void **data, int *len);
535 extern int random_active;
538 * Exports from misc.c.
544 * Exports from version.c.
549 * Exports from unicode.c.
552 #define CP_UTF8 65001
554 void init_ucs_tables(void);
555 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
556 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
557 wchar_t xlat_uskbd2cyrllic(int ch);
558 int check_compose(int first, int second);
559 int decode_codepage(char *cp_name);
560 char *cp_enumerate (int index);
561 char *cp_name(int codepage);
562 void get_unitab(int codepage, wchar_t * unitab, int ftype);
565 * Exports from mscrypto.c
568 int crypto_startup();
569 void crypto_wrapup();
573 * Exports from pageantc.c
575 void agent_query(void *in, int inlen, void **out, int *outlen);
576 int agent_exists(void);
579 * Exports from wildcard.c
581 const char *wc_error(int value);
582 int wc_match(const char *wildcard, const char *target);
583 int wc_unescape(char *output, const char *wildcard);
586 * Exports from windlg.c
588 void logevent(char *);
589 void verify_ssh_host_key(char *host, int port, char *keytype,
590 char *keystr, char *fingerprint);
591 void askcipher(char *ciphername, int cs);
592 int askappend(char *filename);
595 * Exports from console.c (that aren't equivalents to things in
598 extern int console_batch_mode;
599 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
602 * Exports from printing.c.
604 typedef struct printer_enum_tag printer_enum;
605 typedef struct printer_job_tag printer_job;
606 printer_enum *printer_start_enum(int *nprinters);
607 char *printer_get_name(printer_enum *, int);
608 void printer_finish_enum(printer_enum *);
609 printer_job *printer_start_job(char *printer);
610 void printer_job_data(printer_job *, void *, int);
611 void printer_finish_job(printer_job *);
614 * Exports from cmdline.c (and also cmdline_error(), which is
615 * defined differently in various places and required _by_
618 int cmdline_process_param(char *, char *, int);
619 void cmdline_run_saved(void);
620 extern char *cmdline_password;
621 #define TOOLTYPE_FILETRANSFER 1
622 extern int cmdline_tooltype;
624 void cmdline_error(char *, ...);