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
21 typedef struct config_tag Config;
22 typedef struct backend_tag Backend;
23 typedef struct terminal_tag Terminal;
29 /* Three attribute types:
30 * The ATTRs (normal attributes) are stored with the characters in the main
33 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
34 * with characters but not with normal attributes.
36 * The LATTRs (line attributes) conflict with no others and only have one
37 * value per line. But on area clears the LATTR cells are set to the erase_char
38 * (or DEFAULT_ATTR + 'E')
40 * ATTR_INVALID is an illegal colour combination.
43 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
44 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
45 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
47 #define LATTR_NORM 0x00000000UL
48 #define LATTR_WIDE 0x01000000UL
49 #define LATTR_TOP 0x02000000UL
50 #define LATTR_BOT 0x03000000UL
51 #define LATTR_MODE 0x03000000UL
52 #define LATTR_WRAPPED 0x10000000UL
54 #define ATTR_INVALID 0x00FF0000UL
56 /* Like Linux use the F000 page for direct to font. */
57 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
58 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
60 /* These are internal use overlapping with the UTF-16 surrogates */
61 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
62 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
63 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
64 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
65 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
67 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
68 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
70 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
71 #define UCSWIDE 0x303F
73 #define ATTR_NARROW 0x20000000UL
74 #define ATTR_WIDE 0x10000000UL
75 #define ATTR_BOLD 0x01000000UL
76 #define ATTR_UNDER 0x02000000UL
77 #define ATTR_REVERSE 0x04000000UL
78 #define ATTR_BLINK 0x08000000UL
79 #define ATTR_FGMASK 0x000F0000UL
80 #define ATTR_BGMASK 0x00F00000UL
81 #define ATTR_COLOURS 0x00FF0000UL
82 #define ATTR_FGSHIFT 16
83 #define ATTR_BGSHIFT 20
85 #define ATTR_DEFAULT 0x00980000UL
86 #define ATTR_DEFFG 0x00080000UL
87 #define ATTR_DEFBG 0x00900000UL
88 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
89 #define ATTR_MASK 0xFFFFFF00UL
90 #define CHAR_MASK 0x000000FFUL
92 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
93 #define ATTR_CUR_XOR 0x00BA0000UL
98 char *buffer; /* so memory can be freed later */
101 GLOBAL int dbcs_screenfont;
102 GLOBAL int font_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);
190 void (*provide_logctx) (void *handle, void *logctx);
192 * back->unthrottle() tells the back end that the front end
193 * buffer is clearing.
195 void (*unthrottle) (void *handle, int);
199 extern struct backend_list {
209 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
212 int ping_interval; /* in seconds */
215 char proxy_exclude_list[512];
216 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
217 char proxy_host[512];
219 char proxy_username[32];
220 char proxy_password[32];
221 char proxy_telnet_command[512];
222 int proxy_socks_version;
224 char remote_cmd[512];
225 char remote_cmd2[512]; /* fallback if the first fails
226 * (used internally for scp) */
227 char *remote_cmd_ptr; /* might point to a larger command
228 * but never for loading/saving */
229 char *remote_cmd_ptr2; /* might point to a larger command
230 * but never for loading/saving */
234 int change_username; /* allow username switching in SSH2 */
235 int ssh_cipherlist[CIPHER_MAX];
236 char keyfile[FILENAME_MAX];
237 int sshprot; /* use v1 or v2 when both available */
238 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
241 int ssh_subsys; /* run a subsystem rather than a command */
242 int ssh_subsys2; /* fallback to go with remote_cmd2 */
246 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
248 char localusername[100];
251 /* Keyboard options */
255 int no_applic_c; /* totally disable app cursor keys */
256 int no_applic_k; /* totally disable app keypad */
257 int no_mouse_rep; /* totally disable mouse reporting */
258 int no_remote_resize; /* disable remote resizing */
259 int no_alt_screen; /* disable alternate screen */
260 int no_remote_wintitle; /* disable remote retitling */
261 int no_dbackspace; /* disable destructive backspace */
262 int no_remote_charset; /* disable remote charset config */
268 int alt_f4; /* is it special? */
269 int alt_space; /* is it special? */
270 int alt_only; /* is it special? */
274 int fullscreenonaltenter;
279 char wintitle[256]; /* initial window title */
280 /* Terminal options */
285 int cursor_type; /* 0=block 1=underline 2=vertical */
288 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
291 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
293 int bellovl; /* bell overload protection active? */
294 int bellovl_n; /* number of bells to cause overload */
295 int bellovl_t; /* time interval for overload (seconds) */
296 int bellovl_s; /* period of silence to re-enable bell (s) */
297 char bell_wavefile[FILENAME_MAX];
299 int scrollbar_in_fullscreen;
300 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
309 char logfilename[FILENAME_MAX];
315 char answerback[256];
320 unsigned char colours[22][3];
321 /* Selection options */
330 char line_codepage[128];
331 int xlat_capslockcyr;
334 char x11_display[128];
335 /* port forwarding */
336 int lport_acceptall; /* accept conns from hosts other than localhost */
337 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
338 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
339 /* SSH bug compatibility modes */
341 BUG_AUTO, BUG_OFF, BUG_ON
342 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
343 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
345 /* Options for pterm. Should split out into platform-dependent part. */
348 int scrollbar_on_left;
350 int shadowboldoffset;
354 * You can compile with -DSSH_DEFAULT to have ssh by default.
357 #define DEFAULT_PROTOCOL PROT_TELNET
358 #define DEFAULT_PORT 23
360 #define DEFAULT_PROTOCOL PROT_SSH
361 #define DEFAULT_PORT 22
365 * Some global flags denoting the type of application.
367 * FLAG_VERBOSE is set when the user requests verbose details.
369 * FLAG_STDERR is set in command-line applications (which have a
370 * functioning stderr that it makes sense to write to) and not in
371 * GUI applications (which don't).
373 * FLAG_INTERACTIVE is set when a full interactive shell session is
374 * being run, _either_ because no remote command has been provided
375 * _or_ because the application is GUI and can't run non-
378 * These flags describe the type of _application_ - they wouldn't
379 * vary between individual sessions - and so it's OK to have this
380 * variable be GLOBAL.
382 #define FLAG_VERBOSE 0x0001
383 #define FLAG_STDERR 0x0002
384 #define FLAG_INTERACTIVE 0x0004
388 * Likewise, these two variables are set up when the application
389 * initialises, and inform all default-settings accesses after
392 GLOBAL int default_protocol;
393 GLOBAL int default_port;
395 /* This variable, OTOH, needs to be made non-global ASAP. FIXME. */
398 struct RSAKey; /* be a little careful of scope */
401 * Exports from window.c.
403 void request_resize(void *frontend, int, int);
404 void do_text(Context, int, int, char *, int, unsigned long, int);
405 void do_cursor(Context, int, int, char *, int, unsigned long, int);
406 int char_width(Context ctx, int uc);
407 void set_title(void *frontend, char *);
408 void set_icon(void *frontend, char *);
409 void set_sbar(void *frontend, int, int, int);
410 Context get_ctx(void *frontend);
411 void free_ctx(Context);
412 void palette_set(void *frontend, int, int, int, int);
413 void palette_reset(void *frontend);
414 void write_aclip(void *frontend, char *, int, int);
415 void write_clip(void *frontend, wchar_t *, int, int);
416 void get_clip(void *frontend, wchar_t **, int *);
417 void optimised_move(void *frontend, int, int, int);
418 void set_raw_mouse_mode(void *frontend, int);
419 Mouse_Button translate_button(void *frontend, Mouse_Button b);
420 void connection_fatal(void *frontend, char *, ...);
421 void fatalbox(char *, ...);
422 void modalfatalbox(char *, ...);
423 void beep(void *frontend, int);
424 void begin_session(void *frontend);
425 void sys_cursor(void *frontend, int x, int y);
426 void request_paste(void *frontend);
427 void frontend_keypress(void *frontend);
428 void ldisc_update(void *frontend, int echo, int edit);
429 #define OPTIMISE_IS_SCROLL 1
431 void set_iconic(void *frontend, int iconic);
432 void move_window(void *frontend, int x, int y);
433 void set_zorder(void *frontend, int top);
434 void refresh_window(void *frontend);
435 void set_zoomed(void *frontend, int zoomed);
436 int is_iconic(void *frontend);
437 void get_window_pos(void *frontend, int *x, int *y);
438 void get_window_pixels(void *frontend, int *x, int *y);
439 char *get_window_title(void *frontend, int icon);
441 void cleanup_exit(int);
444 * Exports from noise.c.
446 void noise_get_heavy(void (*func) (void *, int));
447 void noise_get_light(void (*func) (void *, int));
448 void noise_regular(void);
449 void noise_ultralight(unsigned long data);
450 void random_save_seed(void);
451 void random_destroy_seed(void);
454 * Exports from settings.c.
456 void save_settings(char *section, int do_host, Config * cfg);
457 void load_settings(char *section, int do_host, Config * cfg);
458 void get_sesslist(struct sesslist *, int allocate);
459 void do_defaults(char *, Config *);
460 void registry_cleanup(void);
463 * Exports from terminal.c.
466 Terminal *term_init(void *frontend);
467 void term_size(Terminal *, int, int, int);
468 void term_out(Terminal *);
469 void term_paint(Terminal *, Context, int, int, int, int, int);
470 void term_scroll(Terminal *, int, int);
471 void term_pwron(Terminal *);
472 void term_clrsb(Terminal *);
473 void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
474 void term_deselect(Terminal *);
475 void term_update(Terminal *);
476 void term_invalidate(Terminal *);
477 void term_blink(Terminal *, int set_cursor);
478 void term_do_paste(Terminal *);
479 int term_paste_pending(Terminal *);
480 void term_paste(Terminal *);
481 void term_nopaste(Terminal *);
482 int term_ldisc(Terminal *, int option);
483 void term_copyall(Terminal *);
484 void term_reconfig(Terminal *);
485 void term_seen_key_event(Terminal *);
486 int from_backend(void *, int is_stderr, char *data, int len);
487 void term_provide_resize_fn(Terminal *term,
488 void (*resize_fn)(void *, int, int),
490 void term_provide_logctx(Terminal *term, void *logctx);
493 * Exports from logging.c.
495 void *log_init(void *frontend);
496 void logfopen(void *logctx);
497 void logfclose(void *logctx);
498 void logtraffic(void *logctx, unsigned char c, int logmode);
499 void log_eventlog(void *logctx, char *string);
500 enum { PKT_INCOMING, PKT_OUTGOING };
501 void log_packet(void *logctx, int direction, int type,
502 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.
536 void *ldisc_create(Terminal *, Backend *, void *, void *);
537 void ldisc_send(void *handle, char *buf, int len, int interactive);
540 * Exports from ldiscucs.c.
542 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
543 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
546 * Exports from sshrand.c.
549 void random_add_noise(void *noise, int length);
550 void random_init(void);
551 int random_byte(void);
552 void random_get_savedata(void **data, int *len);
553 extern int random_active;
556 * Exports from misc.c.
562 * Exports from version.c.
567 * Exports from unicode.c.
570 #define CP_UTF8 65001
573 int is_dbcs_leadbyte(int codepage, char byte);
574 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
575 wchar_t *wcstr, int wclen);
576 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
577 char *mbstr, int mblen, char *defchr, int *defused);
578 wchar_t xlat_uskbd2cyrllic(int ch);
579 int check_compose(int first, int second);
580 int decode_codepage(char *cp_name);
581 char *cp_enumerate (int index);
582 char *cp_name(int codepage);
583 void get_unitab(int codepage, wchar_t * unitab, int ftype);
586 * Exports from mscrypto.c
589 int crypto_startup();
590 void crypto_wrapup();
594 * Exports from pageantc.c
596 void agent_query(void *in, int inlen, void **out, int *outlen);
597 int agent_exists(void);
600 * Exports from wildcard.c
602 const char *wc_error(int value);
603 int wc_match(const char *wildcard, const char *target);
604 int wc_unescape(char *output, const char *wildcard);
607 * Exports from windlg.c
609 void logevent(void *frontend, char *);
610 void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
611 char *keystr, char *fingerprint);
612 void askcipher(void *frontend, char *ciphername, int cs);
613 int askappend(void *frontend, char *filename);
616 * Exports from console.c (that aren't equivalents to things in
619 extern int console_batch_mode;
620 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
623 * Exports from printing.c.
625 typedef struct printer_enum_tag printer_enum;
626 typedef struct printer_job_tag printer_job;
627 printer_enum *printer_start_enum(int *nprinters);
628 char *printer_get_name(printer_enum *, int);
629 void printer_finish_enum(printer_enum *);
630 printer_job *printer_start_job(char *printer);
631 void printer_job_data(printer_job *, void *, int);
632 void printer_finish_job(printer_job *);
635 * Exports from cmdline.c (and also cmdline_error(), which is
636 * defined differently in various places and required _by_
639 int cmdline_process_param(char *, char *, int);
640 void cmdline_run_saved(void);
641 extern char *cmdline_password;
642 #define TOOLTYPE_FILETRANSFER 1
643 extern int cmdline_tooltype;
645 void cmdline_error(char *, ...);