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