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