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