Turned the old `Telnet Command' System-submenu into a more general
[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
125105d1 137struct telnet_special {
138 const char *name; /* NULL==end, ""==separator */
139 int code;
140};
141
374330e2 142typedef enum {
01c034ad 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 */
374330e2 147} Mouse_Button;
148
149typedef enum {
150 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
151} Mouse_Action;
152
6c50d421 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
167typedef 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
5ecd7ad0 194enum {
4eeb7d09 195 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
5ecd7ad0 196};
374330e2 197
0965bee0 198enum {
199 /*
ca20bfcf 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) */
7f1ae1d2 206 CIPHER_DES,
ca20bfcf 207 CIPHER_MAX /* no. ciphers (inc warn) */
208};
209
210enum {
211 /*
5ecd7ad0 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.
0965bee0 219 */
5ecd7ad0 220 FORCE_ON, FORCE_OFF, AUTO
221};
222
223enum {
224 /*
225 * Proxy types.
226 */
227 PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET
0965bee0 228};
229
230enum {
231 /*
232 * Line discipline options which the backend might try to control.
233 */
32874aea 234 LD_EDIT, /* local line editing */
235 LD_ECHO /* local echo */
0965bee0 236};
237
b41069ff 238enum {
5ecd7ad0 239 /* Protocol back ends. (cfg.protocol) */
240 PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
241};
242
243enum {
244 /* Bell settings (cfg.beep) */
245 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
246};
247
248enum {
249 /* Taskbar flashing indication on bell (cfg.beep_ind) */
250 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
251};
252
253enum {
254 /* Resize actions (cfg.resize_action) */
255 RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
b41069ff 256};
257
6c50d421 258enum {
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
1709795f 268struct backend_tag {
86916870 269 char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg,
887035a5 270 char *host, int port, char **realhost, int nodelay);
fabd1805 271 void (*free) (void *handle);
86916870 272 /* back->reconfig() passes in a replacement configuration. */
273 void (*reconfig) (void *handle, Config *cfg);
5471d09a 274 /* back->send() returns the current amount of buffered data. */
51470298 275 int (*send) (void *handle, char *buf, int len);
5471d09a 276 /* back->sendbuffer() does the same thing but without attempting a send */
51470298 277 int (*sendbuffer) (void *handle);
278 void (*size) (void *handle, int width, int height);
279 void (*special) (void *handle, Telnet_Special code);
125105d1 280 const struct telnet_special *(*get_specials) (void *handle);
51470298 281 Socket(*socket) (void *handle);
282 int (*exitcode) (void *handle);
283 int (*sendok) (void *handle);
284 int (*ldisc) (void *handle, int);
b9d7bcad 285 void (*provide_ldisc) (void *handle, void *ldisc);
a8327734 286 void (*provide_logctx) (void *handle, void *logctx);
5471d09a 287 /*
288 * back->unthrottle() tells the back end that the front end
289 * buffer is clearing.
290 */
51470298 291 void (*unthrottle) (void *handle, int);
97db3be4 292 int default_port;
1709795f 293};
374330e2 294
297d398b 295extern struct backend_list {
89ee5268 296 int protocol;
297 char *name;
298 Backend *backend;
299} backends[];
300
ffa79828 301/*
302 * Suggested default protocol provided by the backend link module.
303 * The application is free to ignore this.
304 */
305extern const int be_default_protocol;
306
5ecd7ad0 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 */
f7f27309 315struct config_tag {
374330e2 316 /* Basic options */
317 char host[512];
318 int port;
5ecd7ad0 319 int protocol;
374330e2 320 int close_on_exit;
9ef49106 321 int warn_on_close;
32874aea 322 int ping_interval; /* in seconds */
2184a5d9 323 int tcp_nodelay;
8eebd221 324 /* Proxy options */
325 char proxy_exclude_list[512];
5ecd7ad0 326 int proxy_dns;
b804e1e5 327 int even_proxy_localhost;
5ecd7ad0 328 int proxy_type;
8eebd221 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;
fef97f43 335 /* SSH options */
6abbf9e3 336 char remote_cmd[512];
fd5e5847 337 char remote_cmd2[512]; /* fallback if the first fails
338 * (used internally for scp) */
32874aea 339 char *remote_cmd_ptr; /* might point to a larger command
340 * but never for loading/saving */
fd5e5847 341 char *remote_cmd_ptr2; /* might point to a larger command
342 * but never for loading/saving */
fef97f43 343 int nopty;
4ba9b64b 344 int compression;
979310f1 345 int agentfwd;
5bb641e1 346 int change_username; /* allow username switching in SSH2 */
ca20bfcf 347 int ssh_cipherlist[CIPHER_MAX];
9a30e26b 348 Filename keyfile;
32874aea 349 int sshprot; /* use v1 or v2 when both available */
cb4d4768 350 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
ccbfb941 351 int try_tis_auth;
f091e308 352 int try_ki_auth;
4a8fc3c4 353 int ssh_subsys; /* run a subsystem rather than a command */
fd5e5847 354 int ssh_subsys2; /* fallback to go with remote_cmd2 */
374330e2 355 /* Telnet options */
356 char termtype[32];
357 char termspeed[32];
32874aea 358 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
277fc55e 359 char username[100];
360 char localusername[100];
374330e2 361 int rfc_environ;
8faa456c 362 int passive_telnet;
374330e2 363 /* Keyboard options */
364 int bksp_is_delete;
365 int rxvt_homeend;
c9def1b8 366 int funky_type;
32874aea 367 int no_applic_c; /* totally disable app cursor keys */
368 int no_applic_k; /* totally disable app keypad */
c0d36a72 369 int no_mouse_rep; /* totally disable mouse reporting */
0d2086c5 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 */
374330e2 375 int app_cursor;
376 int app_keypad;
c5e9c988 377 int nethack_keypad;
a5f3e637 378 int telnet_keyboard;
eee63b77 379 int telnet_newline;
c5e9c988 380 int alt_f4; /* is it special? */
381 int alt_space; /* is it special? */
a094ae43 382 int alt_only; /* is it special? */
0965bee0 383 int localecho;
384 int localedit;
e95edc00 385 int alwaysontop;
8f57d753 386 int fullscreenonaltenter;
c9def1b8 387 int scroll_on_key;
a094ae43 388 int scroll_on_disp;
876e5d5e 389 int erase_to_scrollback;
a094ae43 390 int compose_key;
95bbe1ae 391 int ctrlaltkeys;
32874aea 392 char wintitle[256]; /* initial window title */
374330e2 393 /* Terminal options */
394 int savelines;
395 int dec_om;
396 int wrap_mode;
fef97f43 397 int lfhascr;
4e30ff69 398 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 399 int blink_cur;
5ecd7ad0 400 int beep;
401 int beep_ind;
156686ef 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) */
9a30e26b 406 Filename bell_wavefile;
c9def1b8 407 int scrollbar;
a401e5f3 408 int scrollbar_in_fullscreen;
5ecd7ad0 409 int resize_action;
c9def1b8 410 int bce;
411 int blinktext;
374330e2 412 int win_name_always;
413 int width, height;
9a30e26b 414 FontSpec font;
415 Filename logfilename;
e1c8e0ed 416 int logtype;
9f89f96e 417 int logxfovr;
554c540d 418 int hide_mouseptr;
57d08f2f 419 int sunken_edge;
5a73255e 420 int window_border;
e7fbcdd8 421 char answerback[256];
b44b307a 422 char printer[128];
374330e2 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;
6908fed7 429 int rect_select;
d3a22f79 430 int rawcnp;
a7419ea4 431 int rtf_paste;
b90840c3 432 int mouse_override;
374330e2 433 short wordness[256];
c9def1b8 434 /* translations */
5ecd7ad0 435 int vtmode;
8bb92a1c 436 char line_codepage[128];
a9c02454 437 int xlat_capslockcyr;
9c964e85 438 /* X11 forwarding */
439 int x11_forward;
440 char x11_display[128];
b3ebaa28 441 int x11_auth;
d74d141c 442 /* port forwarding */
beefa433 443 int lport_acceptall; /* accept conns from hosts other than localhost */
444 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
d74d141c 445 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
2c9c6388 446 /* SSH bug compatibility modes */
5ecd7ad0 447 int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
8e975795 448 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
dda87a28 449 sshbug_dhgex2, sshbug_pksessid2;
c8ee61b9 450 /* Options for pterm. Should split out into platform-dependent part. */
451 int stamp_utmp;
452 int login_shell;
239b3b36 453 int scrollbar_on_left;
9a30e26b 454 FontSpec boldfont;
455 FontSpec widefont;
456 FontSpec wideboldfont;
12994a99 457 int shadowboldoffset;
f7f27309 458};
374330e2 459
e277c42d 460/*
4017be6d 461 * Some global flags denoting the type of application.
67779be7 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.
0b4f0bc0 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.
4017be6d 477 */
67779be7 478#define FLAG_VERBOSE 0x0001
479#define FLAG_STDERR 0x0002
480#define FLAG_INTERACTIVE 0x0004
4017be6d 481GLOBAL int flags;
482
0b4f0bc0 483/*
484 * Likewise, these two variables are set up when the application
485 * initialises, and inform all default-settings accesses after
486 * that.
487 */
e277c42d 488GLOBAL int default_protocol;
489GLOBAL int default_port;
374330e2 490
4e23b276 491struct RSAKey; /* be a little careful of scope */
492
374330e2 493/*
494 * Exports from window.c.
495 */
a8327734 496void request_resize(void *frontend, int, int);
32874aea 497void do_text(Context, int, int, char *, int, unsigned long, int);
4eeb7d09 498void do_cursor(Context, int, int, char *, int, unsigned long, int);
2102eb8a 499int char_width(Context ctx, int uc);
37d2a505 500#ifdef OPTIMISE_SCROLL
341eb978 501void do_scroll(Context, int, int, int);
37d2a505 502#endif
a8327734 503void set_title(void *frontend, char *);
504void set_icon(void *frontend, char *);
505void set_sbar(void *frontend, int, int, int);
506Context get_ctx(void *frontend);
32874aea 507void free_ctx(Context);
a8327734 508void palette_set(void *frontend, int, int, int, int);
509void palette_reset(void *frontend);
510void write_aclip(void *frontend, char *, int, int);
511void write_clip(void *frontend, wchar_t *, int, int);
512void get_clip(void *frontend, wchar_t **, int *);
513void optimised_move(void *frontend, int, int, int);
514void set_raw_mouse_mode(void *frontend, int);
a8327734 515void connection_fatal(void *frontend, char *, ...);
32874aea 516void fatalbox(char *, ...);
1709795f 517void modalfatalbox(char *, ...);
4b599b6d 518#ifdef macintosh
519#pragma noreturn(fatalbox)
520#pragma noreturn(modalfatalbox)
521#endif
a8327734 522void beep(void *frontend, int);
523void begin_session(void *frontend);
524void sys_cursor(void *frontend, int x, int y);
525void request_paste(void *frontend);
b9d7bcad 526void frontend_keypress(void *frontend);
527void ldisc_update(void *frontend, int echo, int edit);
125105d1 528void update_specials_menu(void *frontend);
374330e2 529#define OPTIMISE_IS_SCROLL 1
530
a8327734 531void set_iconic(void *frontend, int iconic);
532void move_window(void *frontend, int x, int y);
533void set_zorder(void *frontend, int top);
534void refresh_window(void *frontend);
535void set_zoomed(void *frontend, int zoomed);
536int is_iconic(void *frontend);
537void get_window_pos(void *frontend, int *x, int *y);
538void get_window_pixels(void *frontend, int *x, int *y);
539char *get_window_title(void *frontend, int icon);
68f9b3d9 540
93b581bd 541void cleanup_exit(int);
542
374330e2 543/*
544 * Exports from noise.c.
545 */
32874aea 546void noise_get_heavy(void (*func) (void *, int));
547void noise_get_light(void (*func) (void *, int));
7d6ee6ff 548void noise_regular(void);
f7f27309 549void noise_ultralight(unsigned long data);
374330e2 550void random_save_seed(void);
de3df031 551void random_destroy_seed(void);
374330e2 552
553/*
a9422f39 554 * Exports from settings.c.
555 */
3f935d5b 556char *save_settings(char *section, int do_host, Config * cfg);
b537dd42 557void save_open_settings(void *sesskey, int do_host, Config *cfg);
32874aea 558void load_settings(char *section, int do_host, Config * cfg);
ce283213 559void load_open_settings(void *sesskey, int do_host, Config *cfg);
0b4f0bc0 560void get_sesslist(struct sesslist *, int allocate);
1709795f 561void do_defaults(char *, Config *);
562void registry_cleanup(void);
a9422f39 563
564/*
5a9eb105 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
9a30e26b 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.)
5a9eb105 574 */
c85623f9 575char *platform_default_s(const char *name);
576int platform_default_i(const char *name, int def);
9a30e26b 577Filename platform_default_filename(const char *name);
578FontSpec platform_default_fontspec(const char *name);
5a9eb105 579
580/*
374330e2 581 * Exports from terminal.c.
582 */
583
21d2b241 584Terminal *term_init(Config *, struct unicode_data *, void *);
fabd1805 585void term_free(Terminal *);
887035a5 586void term_size(Terminal *, int, int, int);
587void term_out(Terminal *);
c1b55581 588void term_paint(Terminal *, Context, int, int, int, int, int);
887035a5 589void term_scroll(Terminal *, int, int);
590void term_pwron(Terminal *);
591void term_clrsb(Terminal *);
fc5b0934 592void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
593 int,int,int,int,int);
6c50d421 594void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
595 unsigned int);
887035a5 596void term_deselect(Terminal *);
597void term_update(Terminal *);
598void term_invalidate(Terminal *);
599void term_blink(Terminal *, int set_cursor);
600void term_do_paste(Terminal *);
601int term_paste_pending(Terminal *);
602void term_paste(Terminal *);
603void term_nopaste(Terminal *);
604int term_ldisc(Terminal *, int option);
605void term_copyall(Terminal *);
64734920 606void term_reconfig(Terminal *, Config *);
887035a5 607void term_seen_key_event(Terminal *);
9fab77dc 608int from_backend(void *, int is_stderr, const char *data, int len);
51470298 609void term_provide_resize_fn(Terminal *term,
610 void (*resize_fn)(void *, int, int),
611 void *resize_ctx);
a8327734 612void term_provide_logctx(Terminal *term, void *logctx);
374330e2 613
614/*
00db133f 615 * Exports from logging.c.
616 */
c229ef97 617void *log_init(void *frontend, Config *cfg);
fabd1805 618void log_free(void *logctx);
c229ef97 619void log_reconfig(void *logctx, Config *cfg);
a8327734 620void logfopen(void *logctx);
621void logfclose(void *logctx);
622void logtraffic(void *logctx, unsigned char c, int logmode);
623void log_eventlog(void *logctx, char *string);
00db133f 624enum { PKT_INCOMING, PKT_OUTGOING };
a8327734 625void log_packet(void *logctx, int direction, int type,
626 char *texttype, void *data, int len);
00db133f 627
628/*
d082ac49 629 * Exports from testback.c
630 */
631
632extern Backend null_backend;
633extern Backend loop_backend;
634
635/*
5e1a8e27 636 * Exports from raw.c.
637 */
638
3d9a14c9 639extern Backend raw_backend;
5e1a8e27 640
641/*
c91409da 642 * Exports from rlogin.c.
643 */
644
645extern Backend rlogin_backend;
646
647/*
374330e2 648 * Exports from telnet.c.
649 */
650
c14776e8 651extern Backend telnet_backend;
374330e2 652
653/*
c0a81592 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.)
374330e2 657 */
658
c0a81592 659GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
32874aea 660 int is_pw);
c0a81592 661GLOBAL int ssh_getline_pw_only;
c14776e8 662extern Backend ssh_backend;
374330e2 663
664/*
5bc238bb 665 * Exports from ldisc.c.
666 */
fe5634f6 667void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
fabd1805 668void ldisc_free(void *);
b9d7bcad 669void ldisc_send(void *handle, char *buf, int len, int interactive);
5bc238bb 670
671/*
5def7522 672 * Exports from ldiscucs.c.
673 */
674void lpage_send(void *, int codepage, char *buf, int len, int interactive);
675void luni_send(void *, wchar_t * widebuf, int len, int interactive);
676
677/*
374330e2 678 * Exports from sshrand.c.
679 */
680
681void random_add_noise(void *noise, int length);
682void random_init(void);
683int random_byte(void);
684void random_get_savedata(void **data, int *len);
93b581bd 685extern int random_active;
374330e2 686
687/*
688 * Exports from misc.c.
689 */
690
db9c0f86 691#include "misc.h"
374330e2 692
693/*
067a15ea 694 * Exports from version.c.
695 */
696extern char ver[];
697
698/*
4eeb7d09 699 * Exports from unicode.c.
14963b8f 700 */
4eeb7d09 701#ifndef CP_UTF8
702#define CP_UTF8 65001
703#endif
facd762c 704/* void init_ucs(void); -- this is now in platform-specific headers */
5def7522 705int is_dbcs_leadbyte(int codepage, char byte);
706int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
707 wchar_t *wcstr, int wclen);
708int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
21d2b241 709 char *mbstr, int mblen, char *defchr, int *defused,
710 struct unicode_data *ucsdata);
a9c02454 711wchar_t xlat_uskbd2cyrllic(int ch);
4eeb7d09 712int check_compose(int first, int second);
713int decode_codepage(char *cp_name);
875b193f 714char *cp_enumerate (int index);
4eeb7d09 715char *cp_name(int codepage);
a7419ea4 716void get_unitab(int codepage, wchar_t * unitab, int ftype);
14963b8f 717
718/*
5f6fe27e 719 * Exports from wcwidth.c
720 */
721int wcwidth(wchar_t ucs);
722int wcswidth(const wchar_t *pwcs, size_t n);
723
724/*
8f203108 725 * Exports from mscrypto.c
726 */
727#ifdef MSCRYPTOAPI
728int crypto_startup();
729void crypto_wrapup();
730#endif
731
732/*
5c58ad2d 733 * Exports from pageantc.c
734 */
735void agent_query(void *in, int inlen, void **out, int *outlen);
736int agent_exists(void);
737
4eb24e3a 738/*
739 * Exports from wildcard.c
740 */
741const char *wc_error(int value);
742int wc_match(const char *wildcard, const char *target);
743int wc_unescape(char *output, const char *wildcard);
374330e2 744
ff2ae367 745/*
1709795f 746 * Exports from windlg.c
747 */
a8327734 748void logevent(void *frontend, char *);
749void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
1709795f 750 char *keystr, char *fingerprint);
a8327734 751void askcipher(void *frontend, char *ciphername, int cs);
9a30e26b 752int askappend(void *frontend, Filename filename);
1709795f 753
754/*
ff2ae367 755 * Exports from console.c (that aren't equivalents to things in
756 * windlg.c).
757 */
758extern int console_batch_mode;
ff2ae367 759int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
d3fef4a5 760void console_provide_logctx(void *logctx);
ff2ae367 761
b44b307a 762/*
763 * Exports from printing.c.
764 */
765typedef struct printer_enum_tag printer_enum;
766typedef struct printer_job_tag printer_job;
767printer_enum *printer_start_enum(int *nprinters);
768char *printer_get_name(printer_enum *, int);
769void printer_finish_enum(printer_enum *);
770printer_job *printer_start_job(char *printer);
771void printer_job_data(printer_job *, void *, int);
772void printer_finish_job(printer_job *);
773
c0a81592 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 */
5555d393 779int cmdline_process_param(char *, char *, int, Config *);
780void cmdline_run_saved(Config *);
c0a81592 781extern char *cmdline_password;
782#define TOOLTYPE_FILETRANSFER 1
46a3419b 783#define TOOLTYPE_NONNETWORK 2
c0a81592 784extern int cmdline_tooltype;
785
786void cmdline_error(char *, ...);
787
e0e7dff8 788/*
d1582b2e 789 * Exports from config.c.
790 */
1a602f03 791struct controlbox;
d1582b2e 792void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
793 int midsession, int protocol);
794
795/*
e0e7dff8 796 * X11 auth mechanisms we know about.
797 */
798enum {
799 X11_NO_AUTH,
800 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
2f92b717 801 X11_XDM, /* XDM-AUTHORIZATION-1 */
e0e7dff8 802 X11_NAUTHS
803};
804extern const char *const x11_authnames[]; /* declared in x11fwd.c */
805
9a30e26b 806/*
807 * Miscellaneous exports from the platform-specific code.
808 */
9fab77dc 809Filename filename_from_str(const char *string);
810const char *filename_to_str(const Filename *fn);
9a30e26b 811int filename_equal(Filename f1, Filename f2);
812int filename_is_null(Filename fn);
813
374330e2 814#endif