Turned the old `Telnet Command' System-submenu into a more general
[u/mdw/putty] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include <stddef.h> /* for wchar_t */
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 #ifndef DONE_TYPEDEFS
20 #define DONE_TYPEDEFS
21 typedef struct config_tag Config;
22 typedef struct backend_tag Backend;
23 typedef struct terminal_tag Terminal;
24 #endif
25
26 #include "puttyps.h"
27 #include "network.h"
28 #include "misc.h"
29
30 /* Three attribute types:
31 * The ATTRs (normal attributes) are stored with the characters in
32 * the main display arrays
33 *
34 * The TATTRs (temporary attributes) are generated on the fly, they
35 * can overlap with characters but not with normal attributes.
36 *
37 * The LATTRs (line attributes) are an entirely disjoint space of
38 * flags.
39 *
40 * ATTR_INVALID is an illegal colour combination.
41 */
42
43 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
44 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
45 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
46
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
53 #define LATTR_WRAPPED2 0x20000000UL
54
55 #define ATTR_INVALID 0x03FF0000UL
56
57 /* Like Linux use the F000 page for direct to font. */
58 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
59 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
60
61 /* These are internal use overlapping with the UTF-16 surrogates */
62 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
63 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
64 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
65 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
66 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
67
68 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
69 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
70
71 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
72 /*
73 * UCSWIDE is a special value used in the terminal data to signify
74 * the character cell containing the right-hand half of a CJK wide
75 * character. We use 0xDFFF because it's part of the surrogate
76 * range and hence won't be used for anything else (it's impossible
77 * to input it via UTF-8 because our UTF-8 decoder correctly
78 * rejects surrogates).
79 */
80 #define UCSWIDE 0xDFFF
81
82 #define ATTR_NARROW 0x80000000UL
83 #define ATTR_WIDE 0x40000000UL
84 #define ATTR_BOLD 0x04000000UL
85 #define ATTR_UNDER 0x08000000UL
86 #define ATTR_REVERSE 0x10000000UL
87 #define ATTR_BLINK 0x20000000UL
88 #define ATTR_FGMASK 0x001F0000UL
89 #define ATTR_BGMASK 0x03E00000UL
90 #define ATTR_COLOURS 0x03FF0000UL
91 #define ATTR_FGSHIFT 16
92 #define ATTR_BGSHIFT 21
93
94 #define ATTR_DEFAULT 0x01280000UL /* bg 9, fg 8 */
95 #define ATTR_DEFFG 0x00080000UL
96 #define ATTR_DEFBG 0x01200000UL
97 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
98 #define ATTR_MASK 0xFFFFFF00UL
99 #define CHAR_MASK 0x000000FFUL
100
101 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
102 #define ATTR_CUR_XOR 0x016A0000UL
103
104 struct sesslist {
105 int nsessions;
106 char **sessions;
107 char *buffer; /* so memory can be freed later */
108 };
109
110 struct unicode_data {
111 char **uni_tbl;
112 int dbcs_screenfont;
113 int font_codepage;
114 int line_codepage;
115 wchar_t unitab_scoacs[256];
116 wchar_t unitab_line[256];
117 wchar_t unitab_font[256];
118 wchar_t unitab_xterm[256];
119 wchar_t unitab_oemcp[256];
120 unsigned char unitab_ctrl[256];
121 };
122
123 #define LGXF_OVR 1 /* existing logfile overwrite */
124 #define LGXF_APN 0 /* existing logfile append */
125 #define LGXF_ASK -1 /* existing logfile ask */
126 #define LGTYP_NONE 0 /* logmode: no logging */
127 #define LGTYP_ASCII 1 /* logmode: pure ascii */
128 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
129 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
130
131 typedef enum {
132 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
133 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
134 TS_EOL
135 } Telnet_Special;
136
137 struct telnet_special {
138 const char *name; /* NULL==end, ""==separator */
139 int code;
140 };
141
142 typedef enum {
143 MBT_NOTHING,
144 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
145 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
146 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
147 } Mouse_Button;
148
149 typedef enum {
150 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
151 } Mouse_Action;
152
153 /* Keyboard modifiers -- keys the user is actually holding down */
154
155 #define PKM_SHIFT 0x01
156 #define PKM_CONTROL 0x02
157 #define PKM_META 0x04
158 #define PKM_ALT 0x08
159
160 /* Keyboard flags that aren't really modifiers */
161 #define PKF_CAPSLOCK 0x10
162 #define PKF_NUMLOCK 0x20
163 #define PKF_REPEAT 0x40
164
165 /* Stand-alone keysyms for function keys */
166
167 typedef enum {
168 PK_NULL, /* No symbol for this key */
169 /* Main keypad keys */
170 PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
171 /* Editing keys */
172 PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
173 /* Cursor keys */
174 PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
175 /* Numeric keypad */ /* Real one looks like: */
176 PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */
177 PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */
178 PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */
179 PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */
180 PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */
181 /* Top row */
182 PK_F1, PK_F2, PK_F3, PK_F4, PK_F5,
183 PK_F6, PK_F7, PK_F8, PK_F9, PK_F10,
184 PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
185 PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
186 PK_PAUSE
187 } Key_Sym;
188
189 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
190 #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST)
191 #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER)
192 #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20)
193
194 enum {
195 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
196 };
197
198 enum {
199 /*
200 * SSH ciphers (both SSH1 and SSH2)
201 */
202 CIPHER_WARN, /* pseudo 'cipher' */
203 CIPHER_3DES,
204 CIPHER_BLOWFISH,
205 CIPHER_AES, /* (SSH 2 only) */
206 CIPHER_DES,
207 CIPHER_MAX /* no. ciphers (inc warn) */
208 };
209
210 enum {
211 /*
212 * Several different bits of the PuTTY configuration seem to be
213 * three-way settings whose values are `always yes', `always
214 * no', and `decide by some more complex automated means'. This
215 * is true of line discipline options (local echo and line
216 * editing), proxy DNS, Close On Exit, and SSH server bug
217 * workarounds. Accordingly I supply a single enum here to deal
218 * with them all.
219 */
220 FORCE_ON, FORCE_OFF, AUTO
221 };
222
223 enum {
224 /*
225 * Proxy types.
226 */
227 PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET
228 };
229
230 enum {
231 /*
232 * Line discipline options which the backend might try to control.
233 */
234 LD_EDIT, /* local line editing */
235 LD_ECHO /* local echo */
236 };
237
238 enum {
239 /* Protocol back ends. (cfg.protocol) */
240 PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
241 };
242
243 enum {
244 /* Bell settings (cfg.beep) */
245 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
246 };
247
248 enum {
249 /* Taskbar flashing indication on bell (cfg.beep_ind) */
250 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
251 };
252
253 enum {
254 /* Resize actions (cfg.resize_action) */
255 RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
256 };
257
258 enum {
259 /* Function key types (cfg.funky_type) */
260 FUNKY_TILDE,
261 FUNKY_LINUX,
262 FUNKY_XTERM,
263 FUNKY_VT400,
264 FUNKY_VT100P,
265 FUNKY_SCO
266 };
267
268 struct backend_tag {
269 char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg,
270 char *host, int port, char **realhost, int nodelay);
271 void (*free) (void *handle);
272 /* back->reconfig() passes in a replacement configuration. */
273 void (*reconfig) (void *handle, Config *cfg);
274 /* back->send() returns the current amount of buffered data. */
275 int (*send) (void *handle, char *buf, int len);
276 /* back->sendbuffer() does the same thing but without attempting a send */
277 int (*sendbuffer) (void *handle);
278 void (*size) (void *handle, int width, int height);
279 void (*special) (void *handle, Telnet_Special code);
280 const struct telnet_special *(*get_specials) (void *handle);
281 Socket(*socket) (void *handle);
282 int (*exitcode) (void *handle);
283 int (*sendok) (void *handle);
284 int (*ldisc) (void *handle, int);
285 void (*provide_ldisc) (void *handle, void *ldisc);
286 void (*provide_logctx) (void *handle, void *logctx);
287 /*
288 * back->unthrottle() tells the back end that the front end
289 * buffer is clearing.
290 */
291 void (*unthrottle) (void *handle, int);
292 int default_port;
293 };
294
295 extern struct backend_list {
296 int protocol;
297 char *name;
298 Backend *backend;
299 } backends[];
300
301 /*
302 * Suggested default protocol provided by the backend link module.
303 * The application is free to ignore this.
304 */
305 extern const int be_default_protocol;
306
307 /*
308 * IMPORTANT POLICY POINT: everything in this structure which wants
309 * to be treated like an integer must be an actual, honest-to-
310 * goodness `int'. No enum-typed variables. This is because parts
311 * of the code will want to pass around `int *' pointers to them
312 * and we can't run the risk of porting to some system on which the
313 * enum comes out as a different size from int.
314 */
315 struct config_tag {
316 /* Basic options */
317 char host[512];
318 int port;
319 int protocol;
320 int close_on_exit;
321 int warn_on_close;
322 int ping_interval; /* in seconds */
323 int tcp_nodelay;
324 /* Proxy options */
325 char proxy_exclude_list[512];
326 int proxy_dns;
327 int even_proxy_localhost;
328 int proxy_type;
329 char proxy_host[512];
330 int proxy_port;
331 char proxy_username[32];
332 char proxy_password[32];
333 char proxy_telnet_command[512];
334 int proxy_socks_version;
335 /* SSH options */
336 char remote_cmd[512];
337 char remote_cmd2[512]; /* fallback if the first fails
338 * (used internally for scp) */
339 char *remote_cmd_ptr; /* might point to a larger command
340 * but never for loading/saving */
341 char *remote_cmd_ptr2; /* might point to a larger command
342 * but never for loading/saving */
343 int nopty;
344 int compression;
345 int agentfwd;
346 int change_username; /* allow username switching in SSH2 */
347 int ssh_cipherlist[CIPHER_MAX];
348 Filename keyfile;
349 int sshprot; /* use v1 or v2 when both available */
350 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
351 int try_tis_auth;
352 int try_ki_auth;
353 int ssh_subsys; /* run a subsystem rather than a command */
354 int ssh_subsys2; /* fallback to go with remote_cmd2 */
355 /* Telnet options */
356 char termtype[32];
357 char termspeed[32];
358 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
359 char username[100];
360 char localusername[100];
361 int rfc_environ;
362 int passive_telnet;
363 /* Keyboard options */
364 int bksp_is_delete;
365 int rxvt_homeend;
366 int funky_type;
367 int no_applic_c; /* totally disable app cursor keys */
368 int no_applic_k; /* totally disable app keypad */
369 int no_mouse_rep; /* totally disable mouse reporting */
370 int no_remote_resize; /* disable remote resizing */
371 int no_alt_screen; /* disable alternate screen */
372 int no_remote_wintitle; /* disable remote retitling */
373 int no_dbackspace; /* disable destructive backspace */
374 int no_remote_charset; /* disable remote charset config */
375 int app_cursor;
376 int app_keypad;
377 int nethack_keypad;
378 int telnet_keyboard;
379 int telnet_newline;
380 int alt_f4; /* is it special? */
381 int alt_space; /* is it special? */
382 int alt_only; /* is it special? */
383 int localecho;
384 int localedit;
385 int alwaysontop;
386 int fullscreenonaltenter;
387 int scroll_on_key;
388 int scroll_on_disp;
389 int erase_to_scrollback;
390 int compose_key;
391 int ctrlaltkeys;
392 char wintitle[256]; /* initial window title */
393 /* Terminal options */
394 int savelines;
395 int dec_om;
396 int wrap_mode;
397 int lfhascr;
398 int cursor_type; /* 0=block 1=underline 2=vertical */
399 int blink_cur;
400 int beep;
401 int beep_ind;
402 int bellovl; /* bell overload protection active? */
403 int bellovl_n; /* number of bells to cause overload */
404 int bellovl_t; /* time interval for overload (seconds) */
405 int bellovl_s; /* period of silence to re-enable bell (s) */
406 Filename bell_wavefile;
407 int scrollbar;
408 int scrollbar_in_fullscreen;
409 int resize_action;
410 int bce;
411 int blinktext;
412 int win_name_always;
413 int width, height;
414 FontSpec font;
415 Filename logfilename;
416 int logtype;
417 int logxfovr;
418 int hide_mouseptr;
419 int sunken_edge;
420 int window_border;
421 char answerback[256];
422 char printer[128];
423 /* Colour options */
424 int try_palette;
425 int bold_colour;
426 unsigned char colours[22][3];
427 /* Selection options */
428 int mouse_is_xterm;
429 int rect_select;
430 int rawcnp;
431 int rtf_paste;
432 int mouse_override;
433 short wordness[256];
434 /* translations */
435 int vtmode;
436 char line_codepage[128];
437 int xlat_capslockcyr;
438 /* X11 forwarding */
439 int x11_forward;
440 char x11_display[128];
441 int x11_auth;
442 /* port forwarding */
443 int lport_acceptall; /* accept conns from hosts other than localhost */
444 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
445 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
446 /* SSH bug compatibility modes */
447 int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
448 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
449 sshbug_dhgex2, sshbug_pksessid2;
450 /* Options for pterm. Should split out into platform-dependent part. */
451 int stamp_utmp;
452 int login_shell;
453 int scrollbar_on_left;
454 FontSpec boldfont;
455 FontSpec widefont;
456 FontSpec wideboldfont;
457 int shadowboldoffset;
458 };
459
460 /*
461 * Some global flags denoting the type of application.
462 *
463 * FLAG_VERBOSE is set when the user requests verbose details.
464 *
465 * FLAG_STDERR is set in command-line applications (which have a
466 * functioning stderr that it makes sense to write to) and not in
467 * GUI applications (which don't).
468 *
469 * FLAG_INTERACTIVE is set when a full interactive shell session is
470 * being run, _either_ because no remote command has been provided
471 * _or_ because the application is GUI and can't run non-
472 * interactively.
473 *
474 * These flags describe the type of _application_ - they wouldn't
475 * vary between individual sessions - and so it's OK to have this
476 * variable be GLOBAL.
477 */
478 #define FLAG_VERBOSE 0x0001
479 #define FLAG_STDERR 0x0002
480 #define FLAG_INTERACTIVE 0x0004
481 GLOBAL int flags;
482
483 /*
484 * Likewise, these two variables are set up when the application
485 * initialises, and inform all default-settings accesses after
486 * that.
487 */
488 GLOBAL int default_protocol;
489 GLOBAL int default_port;
490
491 struct RSAKey; /* be a little careful of scope */
492
493 /*
494 * Exports from window.c.
495 */
496 void request_resize(void *frontend, int, int);
497 void do_text(Context, int, int, char *, int, unsigned long, int);
498 void do_cursor(Context, int, int, char *, int, unsigned long, int);
499 int char_width(Context ctx, int uc);
500 #ifdef OPTIMISE_SCROLL
501 void do_scroll(Context, int, int, int);
502 #endif
503 void set_title(void *frontend, char *);
504 void set_icon(void *frontend, char *);
505 void set_sbar(void *frontend, int, int, int);
506 Context get_ctx(void *frontend);
507 void free_ctx(Context);
508 void palette_set(void *frontend, int, int, int, int);
509 void palette_reset(void *frontend);
510 void write_aclip(void *frontend, char *, int, int);
511 void write_clip(void *frontend, wchar_t *, int, int);
512 void get_clip(void *frontend, wchar_t **, int *);
513 void optimised_move(void *frontend, int, int, int);
514 void set_raw_mouse_mode(void *frontend, int);
515 void connection_fatal(void *frontend, char *, ...);
516 void fatalbox(char *, ...);
517 void modalfatalbox(char *, ...);
518 #ifdef macintosh
519 #pragma noreturn(fatalbox)
520 #pragma noreturn(modalfatalbox)
521 #endif
522 void beep(void *frontend, int);
523 void begin_session(void *frontend);
524 void sys_cursor(void *frontend, int x, int y);
525 void request_paste(void *frontend);
526 void frontend_keypress(void *frontend);
527 void ldisc_update(void *frontend, int echo, int edit);
528 void update_specials_menu(void *frontend);
529 #define OPTIMISE_IS_SCROLL 1
530
531 void set_iconic(void *frontend, int iconic);
532 void move_window(void *frontend, int x, int y);
533 void set_zorder(void *frontend, int top);
534 void refresh_window(void *frontend);
535 void set_zoomed(void *frontend, int zoomed);
536 int is_iconic(void *frontend);
537 void get_window_pos(void *frontend, int *x, int *y);
538 void get_window_pixels(void *frontend, int *x, int *y);
539 char *get_window_title(void *frontend, int icon);
540
541 void cleanup_exit(int);
542
543 /*
544 * Exports from noise.c.
545 */
546 void noise_get_heavy(void (*func) (void *, int));
547 void noise_get_light(void (*func) (void *, int));
548 void noise_regular(void);
549 void noise_ultralight(unsigned long data);
550 void random_save_seed(void);
551 void random_destroy_seed(void);
552
553 /*
554 * Exports from settings.c.
555 */
556 char *save_settings(char *section, int do_host, Config * cfg);
557 void save_open_settings(void *sesskey, int do_host, Config *cfg);
558 void load_settings(char *section, int do_host, Config * cfg);
559 void load_open_settings(void *sesskey, int do_host, Config *cfg);
560 void get_sesslist(struct sesslist *, int allocate);
561 void do_defaults(char *, Config *);
562 void registry_cleanup(void);
563
564 /*
565 * Functions used by settings.c to provide platform-specific
566 * default settings.
567 *
568 * (The integer one is expected to return `def' if it has no clear
569 * opinion of its own. This is because there's no integer value
570 * which I can reliably set aside to indicate `nil'. The string
571 * function is perfectly all right returning NULL, of course. The
572 * Filename and FontSpec functions are _not allowed_ to fail to
573 * return, since these defaults _must_ be per-platform.)
574 */
575 char *platform_default_s(const char *name);
576 int platform_default_i(const char *name, int def);
577 Filename platform_default_filename(const char *name);
578 FontSpec platform_default_fontspec(const char *name);
579
580 /*
581 * Exports from terminal.c.
582 */
583
584 Terminal *term_init(Config *, struct unicode_data *, void *);
585 void term_free(Terminal *);
586 void term_size(Terminal *, int, int, int);
587 void term_out(Terminal *);
588 void term_paint(Terminal *, Context, int, int, int, int, int);
589 void term_scroll(Terminal *, int, int);
590 void term_pwron(Terminal *);
591 void term_clrsb(Terminal *);
592 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
593 int,int,int,int,int);
594 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
595 unsigned int);
596 void term_deselect(Terminal *);
597 void term_update(Terminal *);
598 void term_invalidate(Terminal *);
599 void term_blink(Terminal *, int set_cursor);
600 void term_do_paste(Terminal *);
601 int term_paste_pending(Terminal *);
602 void term_paste(Terminal *);
603 void term_nopaste(Terminal *);
604 int term_ldisc(Terminal *, int option);
605 void term_copyall(Terminal *);
606 void term_reconfig(Terminal *, Config *);
607 void term_seen_key_event(Terminal *);
608 int from_backend(void *, int is_stderr, const char *data, int len);
609 void term_provide_resize_fn(Terminal *term,
610 void (*resize_fn)(void *, int, int),
611 void *resize_ctx);
612 void term_provide_logctx(Terminal *term, void *logctx);
613
614 /*
615 * Exports from logging.c.
616 */
617 void *log_init(void *frontend, Config *cfg);
618 void log_free(void *logctx);
619 void log_reconfig(void *logctx, Config *cfg);
620 void logfopen(void *logctx);
621 void logfclose(void *logctx);
622 void logtraffic(void *logctx, unsigned char c, int logmode);
623 void log_eventlog(void *logctx, char *string);
624 enum { PKT_INCOMING, PKT_OUTGOING };
625 void log_packet(void *logctx, int direction, int type,
626 char *texttype, void *data, int len);
627
628 /*
629 * Exports from testback.c
630 */
631
632 extern Backend null_backend;
633 extern Backend loop_backend;
634
635 /*
636 * Exports from raw.c.
637 */
638
639 extern Backend raw_backend;
640
641 /*
642 * Exports from rlogin.c.
643 */
644
645 extern Backend rlogin_backend;
646
647 /*
648 * Exports from telnet.c.
649 */
650
651 extern Backend telnet_backend;
652
653 /*
654 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
655 * so that PuTTYtel will still compile - otherwise it would depend
656 * on ssh.c.)
657 */
658
659 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
660 int is_pw);
661 GLOBAL int ssh_getline_pw_only;
662 extern Backend ssh_backend;
663
664 /*
665 * Exports from ldisc.c.
666 */
667 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
668 void ldisc_free(void *);
669 void ldisc_send(void *handle, char *buf, int len, int interactive);
670
671 /*
672 * Exports from ldiscucs.c.
673 */
674 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
675 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
676
677 /*
678 * Exports from sshrand.c.
679 */
680
681 void random_add_noise(void *noise, int length);
682 void random_init(void);
683 int random_byte(void);
684 void random_get_savedata(void **data, int *len);
685 extern int random_active;
686
687 /*
688 * Exports from misc.c.
689 */
690
691 #include "misc.h"
692
693 /*
694 * Exports from version.c.
695 */
696 extern char ver[];
697
698 /*
699 * Exports from unicode.c.
700 */
701 #ifndef CP_UTF8
702 #define CP_UTF8 65001
703 #endif
704 /* void init_ucs(void); -- this is now in platform-specific headers */
705 int is_dbcs_leadbyte(int codepage, char byte);
706 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
707 wchar_t *wcstr, int wclen);
708 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
709 char *mbstr, int mblen, char *defchr, int *defused,
710 struct unicode_data *ucsdata);
711 wchar_t xlat_uskbd2cyrllic(int ch);
712 int check_compose(int first, int second);
713 int decode_codepage(char *cp_name);
714 char *cp_enumerate (int index);
715 char *cp_name(int codepage);
716 void get_unitab(int codepage, wchar_t * unitab, int ftype);
717
718 /*
719 * Exports from wcwidth.c
720 */
721 int wcwidth(wchar_t ucs);
722 int wcswidth(const wchar_t *pwcs, size_t n);
723
724 /*
725 * Exports from mscrypto.c
726 */
727 #ifdef MSCRYPTOAPI
728 int crypto_startup();
729 void crypto_wrapup();
730 #endif
731
732 /*
733 * Exports from pageantc.c
734 */
735 void agent_query(void *in, int inlen, void **out, int *outlen);
736 int agent_exists(void);
737
738 /*
739 * Exports from wildcard.c
740 */
741 const char *wc_error(int value);
742 int wc_match(const char *wildcard, const char *target);
743 int wc_unescape(char *output, const char *wildcard);
744
745 /*
746 * Exports from windlg.c
747 */
748 void logevent(void *frontend, char *);
749 void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
750 char *keystr, char *fingerprint);
751 void askcipher(void *frontend, char *ciphername, int cs);
752 int askappend(void *frontend, Filename filename);
753
754 /*
755 * Exports from console.c (that aren't equivalents to things in
756 * windlg.c).
757 */
758 extern int console_batch_mode;
759 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
760 void console_provide_logctx(void *logctx);
761
762 /*
763 * Exports from printing.c.
764 */
765 typedef struct printer_enum_tag printer_enum;
766 typedef struct printer_job_tag printer_job;
767 printer_enum *printer_start_enum(int *nprinters);
768 char *printer_get_name(printer_enum *, int);
769 void printer_finish_enum(printer_enum *);
770 printer_job *printer_start_job(char *printer);
771 void printer_job_data(printer_job *, void *, int);
772 void printer_finish_job(printer_job *);
773
774 /*
775 * Exports from cmdline.c (and also cmdline_error(), which is
776 * defined differently in various places and required _by_
777 * cmdline.c).
778 */
779 int cmdline_process_param(char *, char *, int, Config *);
780 void cmdline_run_saved(Config *);
781 extern char *cmdline_password;
782 #define TOOLTYPE_FILETRANSFER 1
783 #define TOOLTYPE_NONNETWORK 2
784 extern int cmdline_tooltype;
785
786 void cmdline_error(char *, ...);
787
788 /*
789 * Exports from config.c.
790 */
791 struct controlbox;
792 void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
793 int midsession, int protocol);
794
795 /*
796 * X11 auth mechanisms we know about.
797 */
798 enum {
799 X11_NO_AUTH,
800 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
801 X11_XDM, /* XDM-AUTHORIZATION-1 */
802 X11_NAUTHS
803 };
804 extern const char *const x11_authnames[]; /* declared in x11fwd.c */
805
806 /*
807 * Miscellaneous exports from the platform-specific code.
808 */
809 Filename filename_from_str(const char *string);
810 const char *filename_to_str(const Filename *fn);
811 int filename_equal(Filename f1, Filename f2);
812 int filename_is_null(Filename fn);
813
814 #endif