Blinking text was broken on pterm. This should fix it.
[sgt/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
5a73255e 83#define ATTR_NARROW 0x20000000UL
4eeb7d09 84#define ATTR_WIDE 0x10000000UL
85#define ATTR_BOLD 0x01000000UL
86#define ATTR_UNDER 0x02000000UL
87#define ATTR_REVERSE 0x04000000UL
88#define ATTR_BLINK 0x08000000UL
89#define ATTR_FGMASK 0x000F0000UL
90#define ATTR_BGMASK 0x00F00000UL
91#define ATTR_COLOURS 0x00FF0000UL
92#define ATTR_FGSHIFT 16
93#define ATTR_BGSHIFT 20
94
95#define ATTR_DEFAULT 0x00980000UL
96#define ATTR_DEFFG 0x00080000UL
97#define ATTR_DEFBG 0x00900000UL
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))
103#define ATTR_CUR_XOR 0x00BA0000UL
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
374330e2 190typedef enum {
4eeb7d09 191 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
374330e2 192} VT_Mode;
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 /*
0965bee0 208 * Line discipline option states: off, on, up to the backend.
209 */
210 LD_YES, LD_NO, LD_BACKEND
211};
212
213enum {
214 /*
215 * Line discipline options which the backend might try to control.
216 */
32874aea 217 LD_EDIT, /* local line editing */
218 LD_ECHO /* local echo */
0965bee0 219};
220
b41069ff 221enum {
222 /*
223 * Close On Exit behaviours. (cfg.close_on_exit)
224 */
32874aea 225 COE_NEVER, /* Never close the window */
226 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
227 COE_ALWAYS /* Always close the window */
b41069ff 228};
229
6c50d421 230enum {
231 /* Function key types (cfg.funky_type) */
232 FUNKY_TILDE,
233 FUNKY_LINUX,
234 FUNKY_XTERM,
235 FUNKY_VT400,
236 FUNKY_VT100P,
237 FUNKY_SCO
238};
239
1709795f 240struct backend_tag {
86916870 241 char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg,
887035a5 242 char *host, int port, char **realhost, int nodelay);
fabd1805 243 void (*free) (void *handle);
86916870 244 /* back->reconfig() passes in a replacement configuration. */
245 void (*reconfig) (void *handle, Config *cfg);
5471d09a 246 /* back->send() returns the current amount of buffered data. */
51470298 247 int (*send) (void *handle, char *buf, int len);
5471d09a 248 /* back->sendbuffer() does the same thing but without attempting a send */
51470298 249 int (*sendbuffer) (void *handle);
250 void (*size) (void *handle, int width, int height);
251 void (*special) (void *handle, Telnet_Special code);
252 Socket(*socket) (void *handle);
253 int (*exitcode) (void *handle);
254 int (*sendok) (void *handle);
255 int (*ldisc) (void *handle, int);
b9d7bcad 256 void (*provide_ldisc) (void *handle, void *ldisc);
a8327734 257 void (*provide_logctx) (void *handle, void *logctx);
5471d09a 258 /*
259 * back->unthrottle() tells the back end that the front end
260 * buffer is clearing.
261 */
51470298 262 void (*unthrottle) (void *handle, int);
97db3be4 263 int default_port;
1709795f 264};
374330e2 265
297d398b 266extern struct backend_list {
89ee5268 267 int protocol;
268 char *name;
269 Backend *backend;
270} backends[];
271
ffa79828 272/*
273 * Suggested default protocol provided by the backend link module.
274 * The application is free to ignore this.
275 */
276extern const int be_default_protocol;
277
f7f27309 278struct config_tag {
374330e2 279 /* Basic options */
280 char host[512];
281 int port;
c91409da 282 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 283 int close_on_exit;
9ef49106 284 int warn_on_close;
32874aea 285 int ping_interval; /* in seconds */
2184a5d9 286 int tcp_nodelay;
8eebd221 287 /* Proxy options */
288 char proxy_exclude_list[512];
b7a189f3 289 enum { PROXYDNS_NO, PROXYDNS_AUTO, PROXYDNS_YES } proxy_dns;
b804e1e5 290 int even_proxy_localhost;
8eebd221 291 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
292 char proxy_host[512];
293 int proxy_port;
294 char proxy_username[32];
295 char proxy_password[32];
296 char proxy_telnet_command[512];
297 int proxy_socks_version;
fef97f43 298 /* SSH options */
6abbf9e3 299 char remote_cmd[512];
fd5e5847 300 char remote_cmd2[512]; /* fallback if the first fails
301 * (used internally for scp) */
32874aea 302 char *remote_cmd_ptr; /* might point to a larger command
303 * but never for loading/saving */
fd5e5847 304 char *remote_cmd_ptr2; /* might point to a larger command
305 * but never for loading/saving */
fef97f43 306 int nopty;
4ba9b64b 307 int compression;
979310f1 308 int agentfwd;
5bb641e1 309 int change_username; /* allow username switching in SSH2 */
ca20bfcf 310 int ssh_cipherlist[CIPHER_MAX];
7cca0d81 311 char keyfile[FILENAME_MAX];
32874aea 312 int sshprot; /* use v1 or v2 when both available */
cb4d4768 313 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
ccbfb941 314 int try_tis_auth;
f091e308 315 int try_ki_auth;
4a8fc3c4 316 int ssh_subsys; /* run a subsystem rather than a command */
fd5e5847 317 int ssh_subsys2; /* fallback to go with remote_cmd2 */
374330e2 318 /* Telnet options */
319 char termtype[32];
320 char termspeed[32];
32874aea 321 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
277fc55e 322 char username[100];
323 char localusername[100];
374330e2 324 int rfc_environ;
8faa456c 325 int passive_telnet;
374330e2 326 /* Keyboard options */
327 int bksp_is_delete;
328 int rxvt_homeend;
c9def1b8 329 int funky_type;
32874aea 330 int no_applic_c; /* totally disable app cursor keys */
331 int no_applic_k; /* totally disable app keypad */
c0d36a72 332 int no_mouse_rep; /* totally disable mouse reporting */
0d2086c5 333 int no_remote_resize; /* disable remote resizing */
334 int no_alt_screen; /* disable alternate screen */
335 int no_remote_wintitle; /* disable remote retitling */
336 int no_dbackspace; /* disable destructive backspace */
337 int no_remote_charset; /* disable remote charset config */
374330e2 338 int app_cursor;
339 int app_keypad;
c5e9c988 340 int nethack_keypad;
a5f3e637 341 int telnet_keyboard;
eee63b77 342 int telnet_newline;
c5e9c988 343 int alt_f4; /* is it special? */
344 int alt_space; /* is it special? */
a094ae43 345 int alt_only; /* is it special? */
0965bee0 346 int localecho;
347 int localedit;
e95edc00 348 int alwaysontop;
8f57d753 349 int fullscreenonaltenter;
c9def1b8 350 int scroll_on_key;
a094ae43 351 int scroll_on_disp;
352 int compose_key;
95bbe1ae 353 int ctrlaltkeys;
32874aea 354 char wintitle[256]; /* initial window title */
374330e2 355 /* Terminal options */
356 int savelines;
357 int dec_om;
358 int wrap_mode;
fef97f43 359 int lfhascr;
4e30ff69 360 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 361 int blink_cur;
03169ad0 362 enum {
363 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
364 } beep;
f8a28d1f 365 enum {
366 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
367 } beep_ind;
156686ef 368 int bellovl; /* bell overload protection active? */
369 int bellovl_n; /* number of bells to cause overload */
370 int bellovl_t; /* time interval for overload (seconds) */
371 int bellovl_s; /* period of silence to re-enable bell (s) */
03169ad0 372 char bell_wavefile[FILENAME_MAX];
c9def1b8 373 int scrollbar;
a401e5f3 374 int scrollbar_in_fullscreen;
0ed2f48e 375 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
c9def1b8 376 int bce;
377 int blinktext;
374330e2 378 int win_name_always;
379 int width, height;
d2060a26 380 char font[256];
374330e2 381 int fontisbold;
382 int fontheight;
14963b8f 383 int fontcharset;
e1c8e0ed 384 char logfilename[FILENAME_MAX];
385 int logtype;
9f89f96e 386 int logxfovr;
554c540d 387 int hide_mouseptr;
57d08f2f 388 int sunken_edge;
5a73255e 389 int window_border;
e7fbcdd8 390 char answerback[256];
b44b307a 391 char printer[128];
374330e2 392 /* Colour options */
393 int try_palette;
394 int bold_colour;
395 unsigned char colours[22][3];
396 /* Selection options */
397 int mouse_is_xterm;
6908fed7 398 int rect_select;
d3a22f79 399 int rawcnp;
a7419ea4 400 int rtf_paste;
b90840c3 401 int mouse_override;
374330e2 402 short wordness[256];
c9def1b8 403 /* translations */
404 VT_Mode vtmode;
8bb92a1c 405 char line_codepage[128];
a9c02454 406 int xlat_capslockcyr;
9c964e85 407 /* X11 forwarding */
408 int x11_forward;
409 char x11_display[128];
b3ebaa28 410 int x11_auth;
d74d141c 411 /* port forwarding */
beefa433 412 int lport_acceptall; /* accept conns from hosts other than localhost */
413 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
d74d141c 414 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
2c9c6388 415 /* SSH bug compatibility modes */
416 enum {
417 BUG_AUTO, BUG_OFF, BUG_ON
418 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
8e975795 419 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
420 sshbug_dhgex2;
c8ee61b9 421 /* Options for pterm. Should split out into platform-dependent part. */
422 int stamp_utmp;
423 int login_shell;
239b3b36 424 int scrollbar_on_left;
006238cb 425 char boldfont[256];
426 char widefont[256];
427 char wideboldfont[256];
12994a99 428 int shadowboldoffset;
f7f27309 429};
374330e2 430
e277c42d 431/*
4017be6d 432 * Some global flags denoting the type of application.
67779be7 433 *
434 * FLAG_VERBOSE is set when the user requests verbose details.
435 *
436 * FLAG_STDERR is set in command-line applications (which have a
437 * functioning stderr that it makes sense to write to) and not in
438 * GUI applications (which don't).
439 *
440 * FLAG_INTERACTIVE is set when a full interactive shell session is
441 * being run, _either_ because no remote command has been provided
442 * _or_ because the application is GUI and can't run non-
443 * interactively.
0b4f0bc0 444 *
445 * These flags describe the type of _application_ - they wouldn't
446 * vary between individual sessions - and so it's OK to have this
447 * variable be GLOBAL.
4017be6d 448 */
67779be7 449#define FLAG_VERBOSE 0x0001
450#define FLAG_STDERR 0x0002
451#define FLAG_INTERACTIVE 0x0004
4017be6d 452GLOBAL int flags;
453
0b4f0bc0 454/*
455 * Likewise, these two variables are set up when the application
456 * initialises, and inform all default-settings accesses after
457 * that.
458 */
e277c42d 459GLOBAL int default_protocol;
460GLOBAL int default_port;
374330e2 461
4e23b276 462struct RSAKey; /* be a little careful of scope */
463
374330e2 464/*
465 * Exports from window.c.
466 */
a8327734 467void request_resize(void *frontend, int, int);
32874aea 468void do_text(Context, int, int, char *, int, unsigned long, int);
4eeb7d09 469void do_cursor(Context, int, int, char *, int, unsigned long, int);
2102eb8a 470int char_width(Context ctx, int uc);
37d2a505 471#ifdef OPTIMISE_SCROLL
472void do_scroll(void *, int, int, int);
473#endif
a8327734 474void set_title(void *frontend, char *);
475void set_icon(void *frontend, char *);
476void set_sbar(void *frontend, int, int, int);
477Context get_ctx(void *frontend);
32874aea 478void free_ctx(Context);
a8327734 479void palette_set(void *frontend, int, int, int, int);
480void palette_reset(void *frontend);
481void write_aclip(void *frontend, char *, int, int);
482void write_clip(void *frontend, wchar_t *, int, int);
483void get_clip(void *frontend, wchar_t **, int *);
484void optimised_move(void *frontend, int, int, int);
485void set_raw_mouse_mode(void *frontend, int);
a8327734 486void connection_fatal(void *frontend, char *, ...);
32874aea 487void fatalbox(char *, ...);
1709795f 488void modalfatalbox(char *, ...);
4b599b6d 489#ifdef macintosh
490#pragma noreturn(fatalbox)
491#pragma noreturn(modalfatalbox)
492#endif
a8327734 493void beep(void *frontend, int);
494void begin_session(void *frontend);
495void sys_cursor(void *frontend, int x, int y);
496void request_paste(void *frontend);
b9d7bcad 497void frontend_keypress(void *frontend);
498void ldisc_update(void *frontend, int echo, int edit);
374330e2 499#define OPTIMISE_IS_SCROLL 1
500
a8327734 501void set_iconic(void *frontend, int iconic);
502void move_window(void *frontend, int x, int y);
503void set_zorder(void *frontend, int top);
504void refresh_window(void *frontend);
505void set_zoomed(void *frontend, int zoomed);
506int is_iconic(void *frontend);
507void get_window_pos(void *frontend, int *x, int *y);
508void get_window_pixels(void *frontend, int *x, int *y);
509char *get_window_title(void *frontend, int icon);
68f9b3d9 510
93b581bd 511void cleanup_exit(int);
512
374330e2 513/*
514 * Exports from noise.c.
515 */
32874aea 516void noise_get_heavy(void (*func) (void *, int));
517void noise_get_light(void (*func) (void *, int));
7d6ee6ff 518void noise_regular(void);
f7f27309 519void noise_ultralight(unsigned long data);
374330e2 520void random_save_seed(void);
de3df031 521void random_destroy_seed(void);
374330e2 522
523/*
a9422f39 524 * Exports from settings.c.
525 */
32874aea 526void save_settings(char *section, int do_host, Config * cfg);
b537dd42 527void save_open_settings(void *sesskey, int do_host, Config *cfg);
32874aea 528void load_settings(char *section, int do_host, Config * cfg);
ce283213 529void load_open_settings(void *sesskey, int do_host, Config *cfg);
0b4f0bc0 530void get_sesslist(struct sesslist *, int allocate);
1709795f 531void do_defaults(char *, Config *);
532void registry_cleanup(void);
a9422f39 533
534/*
5a9eb105 535 * Functions used by settings.c to provide platform-specific
536 * default settings.
537 *
538 * (The integer one is expected to return `def' if it has no clear
539 * opinion of its own. This is because there's no integer value
540 * which I can reliably set aside to indicate `nil'. The string
541 * function is perfectly all right returning NULL, of course.)
542 */
c85623f9 543char *platform_default_s(const char *name);
544int platform_default_i(const char *name, int def);
5a9eb105 545
546/*
374330e2 547 * Exports from terminal.c.
548 */
549
21d2b241 550Terminal *term_init(Config *, struct unicode_data *, void *);
fabd1805 551void term_free(Terminal *);
887035a5 552void term_size(Terminal *, int, int, int);
553void term_out(Terminal *);
c1b55581 554void term_paint(Terminal *, Context, int, int, int, int, int);
887035a5 555void term_scroll(Terminal *, int, int);
556void term_pwron(Terminal *);
557void term_clrsb(Terminal *);
fc5b0934 558void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
559 int,int,int,int,int);
6c50d421 560void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
561 unsigned int);
887035a5 562void term_deselect(Terminal *);
563void term_update(Terminal *);
564void term_invalidate(Terminal *);
565void term_blink(Terminal *, int set_cursor);
566void term_do_paste(Terminal *);
567int term_paste_pending(Terminal *);
568void term_paste(Terminal *);
569void term_nopaste(Terminal *);
570int term_ldisc(Terminal *, int option);
571void term_copyall(Terminal *);
64734920 572void term_reconfig(Terminal *, Config *);
887035a5 573void term_seen_key_event(Terminal *);
574int from_backend(void *, int is_stderr, char *data, int len);
51470298 575void term_provide_resize_fn(Terminal *term,
576 void (*resize_fn)(void *, int, int),
577 void *resize_ctx);
a8327734 578void term_provide_logctx(Terminal *term, void *logctx);
374330e2 579
580/*
00db133f 581 * Exports from logging.c.
582 */
c229ef97 583void *log_init(void *frontend, Config *cfg);
fabd1805 584void log_free(void *logctx);
c229ef97 585void log_reconfig(void *logctx, Config *cfg);
a8327734 586void logfopen(void *logctx);
587void logfclose(void *logctx);
588void logtraffic(void *logctx, unsigned char c, int logmode);
589void log_eventlog(void *logctx, char *string);
00db133f 590enum { PKT_INCOMING, PKT_OUTGOING };
a8327734 591void log_packet(void *logctx, int direction, int type,
592 char *texttype, void *data, int len);
00db133f 593
594/*
d082ac49 595 * Exports from testback.c
596 */
597
598extern Backend null_backend;
599extern Backend loop_backend;
600
601/*
5e1a8e27 602 * Exports from raw.c.
603 */
604
3d9a14c9 605extern Backend raw_backend;
5e1a8e27 606
607/*
c91409da 608 * Exports from rlogin.c.
609 */
610
611extern Backend rlogin_backend;
612
613/*
374330e2 614 * Exports from telnet.c.
615 */
616
c14776e8 617extern Backend telnet_backend;
374330e2 618
619/*
c0a81592 620 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
621 * so that PuTTYtel will still compile - otherwise it would depend
622 * on ssh.c.)
374330e2 623 */
624
c0a81592 625GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
32874aea 626 int is_pw);
c0a81592 627GLOBAL int ssh_getline_pw_only;
c14776e8 628extern Backend ssh_backend;
374330e2 629
630/*
5bc238bb 631 * Exports from ldisc.c.
632 */
fe5634f6 633void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
fabd1805 634void ldisc_free(void *);
b9d7bcad 635void ldisc_send(void *handle, char *buf, int len, int interactive);
5bc238bb 636
637/*
5def7522 638 * Exports from ldiscucs.c.
639 */
640void lpage_send(void *, int codepage, char *buf, int len, int interactive);
641void luni_send(void *, wchar_t * widebuf, int len, int interactive);
642
643/*
374330e2 644 * Exports from sshrand.c.
645 */
646
647void random_add_noise(void *noise, int length);
648void random_init(void);
649int random_byte(void);
650void random_get_savedata(void **data, int *len);
93b581bd 651extern int random_active;
374330e2 652
653/*
654 * Exports from misc.c.
655 */
656
db9c0f86 657#include "misc.h"
374330e2 658
659/*
067a15ea 660 * Exports from version.c.
661 */
662extern char ver[];
663
664/*
4eeb7d09 665 * Exports from unicode.c.
14963b8f 666 */
4eeb7d09 667#ifndef CP_UTF8
668#define CP_UTF8 65001
669#endif
facd762c 670/* void init_ucs(void); -- this is now in platform-specific headers */
5def7522 671int is_dbcs_leadbyte(int codepage, char byte);
672int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
673 wchar_t *wcstr, int wclen);
674int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
21d2b241 675 char *mbstr, int mblen, char *defchr, int *defused,
676 struct unicode_data *ucsdata);
a9c02454 677wchar_t xlat_uskbd2cyrllic(int ch);
4eeb7d09 678int check_compose(int first, int second);
679int decode_codepage(char *cp_name);
875b193f 680char *cp_enumerate (int index);
4eeb7d09 681char *cp_name(int codepage);
a7419ea4 682void get_unitab(int codepage, wchar_t * unitab, int ftype);
14963b8f 683
684/*
5f6fe27e 685 * Exports from wcwidth.c
686 */
687int wcwidth(wchar_t ucs);
688int wcswidth(const wchar_t *pwcs, size_t n);
689
690/*
8f203108 691 * Exports from mscrypto.c
692 */
693#ifdef MSCRYPTOAPI
694int crypto_startup();
695void crypto_wrapup();
696#endif
697
698/*
5c58ad2d 699 * Exports from pageantc.c
700 */
701void agent_query(void *in, int inlen, void **out, int *outlen);
702int agent_exists(void);
703
4eb24e3a 704/*
705 * Exports from wildcard.c
706 */
707const char *wc_error(int value);
708int wc_match(const char *wildcard, const char *target);
709int wc_unescape(char *output, const char *wildcard);
374330e2 710
ff2ae367 711/*
1709795f 712 * Exports from windlg.c
713 */
a8327734 714void logevent(void *frontend, char *);
715void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
1709795f 716 char *keystr, char *fingerprint);
a8327734 717void askcipher(void *frontend, char *ciphername, int cs);
718int askappend(void *frontend, char *filename);
1709795f 719
720/*
ff2ae367 721 * Exports from console.c (that aren't equivalents to things in
722 * windlg.c).
723 */
724extern int console_batch_mode;
ff2ae367 725int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
d3fef4a5 726void console_provide_logctx(void *logctx);
ff2ae367 727
b44b307a 728/*
729 * Exports from printing.c.
730 */
731typedef struct printer_enum_tag printer_enum;
732typedef struct printer_job_tag printer_job;
733printer_enum *printer_start_enum(int *nprinters);
734char *printer_get_name(printer_enum *, int);
735void printer_finish_enum(printer_enum *);
736printer_job *printer_start_job(char *printer);
737void printer_job_data(printer_job *, void *, int);
738void printer_finish_job(printer_job *);
739
c0a81592 740/*
741 * Exports from cmdline.c (and also cmdline_error(), which is
742 * defined differently in various places and required _by_
743 * cmdline.c).
744 */
5555d393 745int cmdline_process_param(char *, char *, int, Config *);
746void cmdline_run_saved(Config *);
c0a81592 747extern char *cmdline_password;
748#define TOOLTYPE_FILETRANSFER 1
749extern int cmdline_tooltype;
750
751void cmdline_error(char *, ...);
752
e0e7dff8 753/*
754 * X11 auth mechanisms we know about.
755 */
756enum {
757 X11_NO_AUTH,
758 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
2f92b717 759 X11_XDM, /* XDM-AUTHORIZATION-1 */
e0e7dff8 760 X11_NAUTHS
761};
762extern const char *const x11_authnames[]; /* declared in x11fwd.c */
763
374330e2 764#endif