4b151defc898d30fd987d966bc03fab7945bd261
[u/mdw/putty] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include <stdio.h> /* for FILENAME_MAX */
5
6 /*
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.
10 */
11 #ifndef GLOBAL
12 #ifdef PUTTY_DO_GLOBALS
13 #define GLOBAL
14 #else
15 #define GLOBAL extern
16 #endif
17 #endif
18
19 typedef struct config_tag Config;
20 typedef struct backend_tag Backend;
21
22 #include "puttyps.h"
23 #include "network.h"
24
25 /*
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.
29 */
30 #ifdef PUTTY_DO_GLOBALS
31 #define GLOBAL
32 #else
33 #define GLOBAL extern
34 #endif
35
36 /* Three attribute types:
37 * The ATTRs (normal attributes) are stored with the characters in the main
38 * display arrays
39 *
40 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
41 * with characters but not with normal attributes.
42 *
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')
46 *
47 * ATTR_INVALID is an illegal colour combination.
48 */
49
50 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
51 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
52 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
53
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
60
61 #define ATTR_INVALID 0x00FF0000UL
62
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 */
66
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 */
73
74 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
75 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
76
77 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
78 #define UCSWIDE 0x303F
79
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
91
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
98
99 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
100 #define ATTR_CUR_XOR 0x00BA0000UL
101
102 GLOBAL int rows, cols, savelines;
103
104 GLOBAL int has_focus;
105
106 GLOBAL int in_vbell;
107 GLOBAL unsigned long vbell_startpoint;
108
109 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
110 GLOBAL int repeat_off, cr_lf_return;
111
112 GLOBAL int seen_disp_event;
113 GLOBAL int alt_pressed;
114
115 GLOBAL int session_closed;
116
117 GLOBAL int big_cursor;
118
119 GLOBAL char *help_path;
120 GLOBAL int help_has_contents;
121
122 GLOBAL int nsessions;
123 GLOBAL char **sessions;
124
125 GLOBAL int utf;
126 GLOBAL int dbcs_screenfont;
127 GLOBAL int font_codepage;
128 GLOBAL int kbd_codepage;
129 GLOBAL int line_codepage;
130 GLOBAL wchar_t unitab_scoacs[256];
131 GLOBAL wchar_t unitab_line[256];
132 GLOBAL wchar_t unitab_font[256];
133 GLOBAL wchar_t unitab_xterm[256];
134 GLOBAL wchar_t unitab_oemcp[256];
135 GLOBAL unsigned char unitab_ctrl[256];
136 #define in_utf (utf || line_codepage==CP_UTF8)
137
138 #define LGXF_OVR 1 /* existing logfile overwrite */
139 #define LGXF_APN 0 /* existing logfile append */
140 #define LGXF_ASK -1 /* existing logfile ask */
141 #define LGTYP_NONE 0 /* logmode: no logging */
142 #define LGTYP_ASCII 1 /* logmode: pure ascii */
143 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
144 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
145
146 typedef enum {
147 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
148 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
149 TS_EOL
150 } Telnet_Special;
151
152 typedef enum {
153 MBT_NOTHING,
154 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
155 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
156 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
157 } Mouse_Button;
158
159 typedef enum {
160 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
161 } Mouse_Action;
162
163 typedef enum {
164 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
165 } VT_Mode;
166
167 enum {
168 /*
169 * SSH ciphers (both SSH1 and SSH2)
170 */
171 CIPHER_WARN, /* pseudo 'cipher' */
172 CIPHER_3DES,
173 CIPHER_BLOWFISH,
174 CIPHER_AES, /* (SSH 2 only) */
175 CIPHER_DES,
176 CIPHER_MAX /* no. ciphers (inc warn) */
177 };
178
179 enum {
180 /*
181 * Line discipline option states: off, on, up to the backend.
182 */
183 LD_YES, LD_NO, LD_BACKEND
184 };
185
186 enum {
187 /*
188 * Line discipline options which the backend might try to control.
189 */
190 LD_EDIT, /* local line editing */
191 LD_ECHO /* local echo */
192 };
193
194 enum {
195 /*
196 * Close On Exit behaviours. (cfg.close_on_exit)
197 */
198 COE_NEVER, /* Never close the window */
199 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
200 COE_ALWAYS /* Always close the window */
201 };
202
203 struct backend_tag {
204 char *(*init) (char *host, int port, char **realhost, int nodelay);
205 /* back->send() returns the current amount of buffered data. */
206 int (*send) (char *buf, int len);
207 /* back->sendbuffer() does the same thing but without attempting a send */
208 int (*sendbuffer) (void);
209 void (*size) (void);
210 void (*special) (Telnet_Special code);
211 Socket(*socket) (void);
212 int (*exitcode) (void);
213 int (*sendok) (void);
214 int (*ldisc) (int);
215 /*
216 * back->unthrottle() tells the back end that the front end
217 * buffer is clearing.
218 */
219 void (*unthrottle) (int);
220 int default_port;
221 };
222
223 GLOBAL Backend *back;
224
225 extern struct backend_list {
226 int protocol;
227 char *name;
228 Backend *backend;
229 } backends[];
230
231 struct config_tag {
232 /* Basic options */
233 char host[512];
234 int port;
235 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
236 int close_on_exit;
237 int warn_on_close;
238 int ping_interval; /* in seconds */
239 int tcp_nodelay;
240 /* Proxy options */
241 char proxy_exclude_list[512];
242 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
243 char proxy_host[512];
244 int proxy_port;
245 char proxy_username[32];
246 char proxy_password[32];
247 char proxy_telnet_command[512];
248 int proxy_socks_version;
249 /* SSH options */
250 char remote_cmd[512];
251 char remote_cmd2[512]; /* fallback if the first fails
252 * (used internally for scp) */
253 char *remote_cmd_ptr; /* might point to a larger command
254 * but never for loading/saving */
255 char *remote_cmd_ptr2; /* might point to a larger command
256 * but never for loading/saving */
257 int nopty;
258 int compression;
259 int agentfwd;
260 int change_username; /* allow username switching in SSH2 */
261 int ssh_cipherlist[CIPHER_MAX];
262 char keyfile[FILENAME_MAX];
263 int sshprot; /* use v1 or v2 when both available */
264 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
265 int try_tis_auth;
266 int try_ki_auth;
267 int ssh_subsys; /* run a subsystem rather than a command */
268 int ssh_subsys2; /* fallback to go with remote_cmd2 */
269 /* Telnet options */
270 char termtype[32];
271 char termspeed[32];
272 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
273 char username[100];
274 char localusername[100];
275 int rfc_environ;
276 int passive_telnet;
277 /* Keyboard options */
278 int bksp_is_delete;
279 int rxvt_homeend;
280 int funky_type;
281 int no_applic_c; /* totally disable app cursor keys */
282 int no_applic_k; /* totally disable app keypad */
283 int no_mouse_rep; /* totally disable mouse reporting */
284 int no_remote_resize; /* disable remote resizing */
285 int no_alt_screen; /* disable alternate screen */
286 int no_remote_wintitle; /* disable remote retitling */
287 int no_dbackspace; /* disable destructive backspace */
288 int no_remote_charset; /* disable remote charset config */
289 int app_cursor;
290 int app_keypad;
291 int nethack_keypad;
292 int telnet_keyboard;
293 int telnet_newline;
294 int alt_f4; /* is it special? */
295 int alt_space; /* is it special? */
296 int alt_only; /* is it special? */
297 int localecho;
298 int localedit;
299 int alwaysontop;
300 int fullscreenonaltenter;
301 int scroll_on_key;
302 int scroll_on_disp;
303 int compose_key;
304 int ctrlaltkeys;
305 char wintitle[256]; /* initial window title */
306 /* Terminal options */
307 int savelines;
308 int dec_om;
309 int wrap_mode;
310 int lfhascr;
311 int cursor_type; /* 0=block 1=underline 2=vertical */
312 int blink_cur;
313 enum {
314 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
315 } beep;
316 enum {
317 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
318 } beep_ind;
319 int bellovl; /* bell overload protection active? */
320 int bellovl_n; /* number of bells to cause overload */
321 int bellovl_t; /* time interval for overload (seconds) */
322 int bellovl_s; /* period of silence to re-enable bell (s) */
323 char bell_wavefile[FILENAME_MAX];
324 int scrollbar;
325 int scrollbar_in_fullscreen;
326 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
327 int bce;
328 int blinktext;
329 int win_name_always;
330 int width, height;
331 char font[64];
332 int fontisbold;
333 int fontheight;
334 int fontcharset;
335 char logfilename[FILENAME_MAX];
336 int logtype;
337 int logxfovr;
338 int hide_mouseptr;
339 int sunken_edge;
340 int window_border;
341 char answerback[256];
342 char printer[128];
343 /* Colour options */
344 int try_palette;
345 int bold_colour;
346 unsigned char colours[22][3];
347 /* Selection options */
348 int mouse_is_xterm;
349 int rect_select;
350 int rawcnp;
351 int rtf_paste;
352 int mouse_override;
353 short wordness[256];
354 /* translations */
355 VT_Mode vtmode;
356 char line_codepage[128];
357 int xlat_capslockcyr;
358 /* X11 forwarding */
359 int x11_forward;
360 char x11_display[128];
361 /* port forwarding */
362 int lport_acceptall; /* accept conns from hosts other than localhost */
363 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
364 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
365 /* SSH bug compatibility modes */
366 enum {
367 BUG_AUTO, BUG_OFF, BUG_ON
368 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
369 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
370 sshbug_dhgex2;
371 /* Options for pterm. Should split out into platform-dependent part. */
372 int stamp_utmp;
373 int login_shell;
374 int scrollbar_on_left;
375 char boldfont[64];
376 int shadowboldoffset;
377 };
378
379 /*
380 * You can compile with -DSSH_DEFAULT to have ssh by default.
381 */
382 #ifndef SSH_DEFAULT
383 #define DEFAULT_PROTOCOL PROT_TELNET
384 #define DEFAULT_PORT 23
385 #else
386 #define DEFAULT_PROTOCOL PROT_SSH
387 #define DEFAULT_PORT 22
388 #endif
389
390 /*
391 * Some global flags denoting the type of application.
392 *
393 * FLAG_VERBOSE is set when the user requests verbose details.
394 *
395 * FLAG_STDERR is set in command-line applications (which have a
396 * functioning stderr that it makes sense to write to) and not in
397 * GUI applications (which don't).
398 *
399 * FLAG_INTERACTIVE is set when a full interactive shell session is
400 * being run, _either_ because no remote command has been provided
401 * _or_ because the application is GUI and can't run non-
402 * interactively.
403 */
404 #define FLAG_VERBOSE 0x0001
405 #define FLAG_STDERR 0x0002
406 #define FLAG_INTERACTIVE 0x0004
407 GLOBAL int flags;
408
409 GLOBAL Config cfg;
410 GLOBAL int default_protocol;
411 GLOBAL int default_port;
412
413 struct RSAKey; /* be a little careful of scope */
414
415 /*
416 * Exports from window.c.
417 */
418 void request_resize(int, int);
419 void do_text(Context, int, int, char *, int, unsigned long, int);
420 void do_cursor(Context, int, int, char *, int, unsigned long, int);
421 int CharWidth(Context ctx, int uc);
422 void set_title(char *);
423 void set_icon(char *);
424 void set_sbar(int, int, int);
425 Context get_ctx(void);
426 void free_ctx(Context);
427 void palette_set(int, int, int, int);
428 void palette_reset(void);
429 void write_aclip(char *, int, int);
430 void write_clip(wchar_t *, int, int);
431 void get_clip(wchar_t **, int *);
432 void optimised_move(int, int, int);
433 void set_raw_mouse_mode(int);
434 Mouse_Button translate_button(Mouse_Button b);
435 void connection_fatal(char *, ...);
436 void fatalbox(char *, ...);
437 void modalfatalbox(char *, ...);
438 void beep(int);
439 void begin_session(void);
440 void sys_cursor(int x, int y);
441 void request_paste(void);
442 #define OPTIMISE_IS_SCROLL 1
443
444 void set_iconic(int iconic);
445 void move_window(int x, int y);
446 void set_zorder(int top);
447 void refresh_window(void);
448 void set_zoomed(int zoomed);
449 int is_iconic(void);
450 void get_window_pos(int *x, int *y);
451 void get_window_pixels(int *x, int *y);
452 char *get_window_title(int icon);
453
454 void cleanup_exit(int);
455
456 /*
457 * Exports from noise.c.
458 */
459 void noise_get_heavy(void (*func) (void *, int));
460 void noise_get_light(void (*func) (void *, int));
461 void noise_regular(void);
462 void noise_ultralight(unsigned long data);
463 void random_save_seed(void);
464 void random_destroy_seed(void);
465
466 /*
467 * Exports from settings.c.
468 */
469 void save_settings(char *section, int do_host, Config * cfg);
470 void load_settings(char *section, int do_host, Config * cfg);
471 void get_sesslist(int allocate);
472 void do_defaults(char *, Config *);
473 void registry_cleanup(void);
474
475 /*
476 * Exports from terminal.c.
477 */
478
479 void term_init(void);
480 void term_size(int, int, int);
481 void term_out(void);
482 void term_paint(Context, int, int, int, int);
483 void term_scroll(int, int);
484 void term_pwron(void);
485 void term_clrsb(void);
486 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
487 void term_deselect(void);
488 void term_update(void);
489 void term_invalidate(void);
490 void term_blink(int set_cursor);
491 void term_do_paste(void);
492 int term_paste_pending(void);
493 void term_paste(void);
494 void term_nopaste(void);
495 int term_ldisc(int option);
496 int from_backend(int is_stderr, char *data, int len);
497 void logfopen(void);
498 void logfclose(void);
499 void term_copyall(void);
500 void term_reconfig(void);
501 void term_seen_key_event(void);
502
503 /*
504 * Exports from logging.c.
505 */
506 void logtraffic(unsigned char c, int logmode);
507 enum { PKT_INCOMING, PKT_OUTGOING };
508 void log_eventlog(char *string);
509 void log_packet(int direction, int type, char *texttype, void *data, int len);
510
511 /*
512 * Exports from raw.c.
513 */
514
515 extern Backend raw_backend;
516
517 /*
518 * Exports from rlogin.c.
519 */
520
521 extern Backend rlogin_backend;
522
523 /*
524 * Exports from telnet.c.
525 */
526
527 extern Backend telnet_backend;
528
529 /*
530 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
531 * so that PuTTYtel will still compile - otherwise it would depend
532 * on ssh.c.)
533 */
534
535 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
536 int is_pw);
537 GLOBAL int ssh_getline_pw_only;
538 extern Backend ssh_backend;
539
540 /*
541 * Exports from ldisc.c.
542 */
543
544 extern void ldisc_send(char *buf, int len, int interactive);
545
546 /*
547 * Exports from sshrand.c.
548 */
549
550 void random_add_noise(void *noise, int length);
551 void random_init(void);
552 int random_byte(void);
553 void random_get_savedata(void **data, int *len);
554 extern int random_active;
555
556 /*
557 * Exports from misc.c.
558 */
559
560 #include "misc.h"
561
562 /*
563 * Exports from version.c.
564 */
565 extern char ver[];
566
567 /*
568 * Exports from unicode.c.
569 */
570 #ifndef CP_UTF8
571 #define CP_UTF8 65001
572 #endif
573 void init_ucs_tables(void);
574 void lpage_send(int codepage, char *buf, int len, int interactive);
575 void luni_send(wchar_t * widebuf, int len, int interactive);
576 wchar_t xlat_uskbd2cyrllic(int ch);
577 int check_compose(int first, int second);
578 int decode_codepage(char *cp_name);
579 char *cp_enumerate (int index);
580 char *cp_name(int codepage);
581 void get_unitab(int codepage, wchar_t * unitab, int ftype);
582
583 /*
584 * Exports from mscrypto.c
585 */
586 #ifdef MSCRYPTOAPI
587 int crypto_startup();
588 void crypto_wrapup();
589 #endif
590
591 /*
592 * Exports from pageantc.c
593 */
594 void agent_query(void *in, int inlen, void **out, int *outlen);
595 int agent_exists(void);
596
597 /*
598 * Exports from wildcard.c
599 */
600 const char *wc_error(int value);
601 int wc_match(const char *wildcard, const char *target);
602 int wc_unescape(char *output, const char *wildcard);
603
604 /*
605 * Exports from windlg.c
606 */
607 void logevent(char *);
608 void verify_ssh_host_key(char *host, int port, char *keytype,
609 char *keystr, char *fingerprint);
610 void askcipher(char *ciphername, int cs);
611 int askappend(char *filename);
612
613 /*
614 * Exports from console.c (that aren't equivalents to things in
615 * windlg.c).
616 */
617 extern int console_batch_mode;
618 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
619
620 /*
621 * Exports from printing.c.
622 */
623 typedef struct printer_enum_tag printer_enum;
624 typedef struct printer_job_tag printer_job;
625 printer_enum *printer_start_enum(int *nprinters);
626 char *printer_get_name(printer_enum *, int);
627 void printer_finish_enum(printer_enum *);
628 printer_job *printer_start_job(char *printer);
629 void printer_job_data(printer_job *, void *, int);
630 void printer_finish_job(printer_job *);
631
632 /*
633 * Exports from cmdline.c (and also cmdline_error(), which is
634 * defined differently in various places and required _by_
635 * cmdline.c).
636 */
637 int cmdline_process_param(char *, char *, int);
638 void cmdline_run_saved(void);
639 extern char *cmdline_password;
640 #define TOOLTYPE_FILETRANSFER 1
641 extern int cmdline_tooltype;
642
643 void cmdline_error(char *, ...);
644
645 #endif