Fix segfaults in terminal resizing, introduced by re-engineering.
[u/mdw/putty] / putty.h
... / ...
CommitLineData
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
21typedef struct config_tag Config;
22typedef struct backend_tag Backend;
23typedef 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 0x40000000UL /* active cursor (block) */
44#define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */
45#define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */
46
47#define LATTR_NORM 0x00000000UL
48#define LATTR_WIDE 0x00000001UL
49#define LATTR_TOP 0x00000002UL
50#define LATTR_BOT 0x00000003UL
51#define LATTR_MODE 0x00000003UL
52#define LATTR_WRAPPED 0x00000010UL
53#define LATTR_WRAPPED2 0x00000020UL
54
55#define ATTR_INVALID 0x03FFU
56
57/* Like Linux use the F000 page for direct to font. */
58#define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */
59#define CSET_ACP 0x0000F100UL /* Ansi Codepage DTF */
60
61/* These are internal use overlapping with the UTF-16 surrogates */
62#define CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
63#define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
64#define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */
65#define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
66#define CSET_MASK 0xFFFFFF00UL /* Character set mask */
67
68#define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
69#define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
70
71#define UCSERR (CSET_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 0x8000U
83#define ATTR_WIDE 0x4000U
84#define ATTR_BOLD 0x0400U
85#define ATTR_UNDER 0x0800U
86#define ATTR_REVERSE 0x1000U
87#define ATTR_BLINK 0x2000U
88#define ATTR_FGMASK 0x001FU
89#define ATTR_BGMASK 0x03E0U
90#define ATTR_COLOURS 0x03FFU
91#define ATTR_FGSHIFT 0
92#define ATTR_BGSHIFT 5
93
94#define ATTR_DEFAULT 0x0128U /* bg 9, fg 8 */
95#define ATTR_DEFFG 0x0008U
96#define ATTR_DEFBG 0x0120U
97
98#define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
99#define ATTR_CUR_XOR 0x016AU
100
101struct sesslist {
102 int nsessions;
103 char **sessions;
104 char *buffer; /* so memory can be freed later */
105};
106
107struct unicode_data {
108 char **uni_tbl;
109 int dbcs_screenfont;
110 int font_codepage;
111 int line_codepage;
112 wchar_t unitab_scoacs[256];
113 wchar_t unitab_line[256];
114 wchar_t unitab_font[256];
115 wchar_t unitab_xterm[256];
116 wchar_t unitab_oemcp[256];
117 unsigned char unitab_ctrl[256];
118};
119
120#define LGXF_OVR 1 /* existing logfile overwrite */
121#define LGXF_APN 0 /* existing logfile append */
122#define LGXF_ASK -1 /* existing logfile ask */
123#define LGTYP_NONE 0 /* logmode: no logging */
124#define LGTYP_ASCII 1 /* logmode: pure ascii */
125#define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
126#define LGTYP_PACKETS 3 /* logmode: SSH data packets */
127
128typedef enum {
129 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
130 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
131 TS_EOL
132} Telnet_Special;
133
134struct telnet_special {
135 const char *name; /* NULL==end, ""==separator */
136 int code;
137};
138
139typedef enum {
140 MBT_NOTHING,
141 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
142 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
143 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
144} Mouse_Button;
145
146typedef enum {
147 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
148} Mouse_Action;
149
150/* Keyboard modifiers -- keys the user is actually holding down */
151
152#define PKM_SHIFT 0x01
153#define PKM_CONTROL 0x02
154#define PKM_META 0x04
155#define PKM_ALT 0x08
156
157/* Keyboard flags that aren't really modifiers */
158#define PKF_CAPSLOCK 0x10
159#define PKF_NUMLOCK 0x20
160#define PKF_REPEAT 0x40
161
162/* Stand-alone keysyms for function keys */
163
164typedef enum {
165 PK_NULL, /* No symbol for this key */
166 /* Main keypad keys */
167 PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
168 /* Editing keys */
169 PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
170 /* Cursor keys */
171 PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
172 /* Numeric keypad */ /* Real one looks like: */
173 PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */
174 PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */
175 PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */
176 PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */
177 PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */
178 /* Top row */
179 PK_F1, PK_F2, PK_F3, PK_F4, PK_F5,
180 PK_F6, PK_F7, PK_F8, PK_F9, PK_F10,
181 PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
182 PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
183 PK_PAUSE
184} Key_Sym;
185
186#define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
187#define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST)
188#define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER)
189#define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20)
190
191enum {
192 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
193};
194
195enum {
196 /*
197 * SSH ciphers (both SSH1 and SSH2)
198 */
199 CIPHER_WARN, /* pseudo 'cipher' */
200 CIPHER_3DES,
201 CIPHER_BLOWFISH,
202 CIPHER_AES, /* (SSH 2 only) */
203 CIPHER_DES,
204 CIPHER_MAX /* no. ciphers (inc warn) */
205};
206
207enum {
208 /*
209 * Several different bits of the PuTTY configuration seem to be
210 * three-way settings whose values are `always yes', `always
211 * no', and `decide by some more complex automated means'. This
212 * is true of line discipline options (local echo and line
213 * editing), proxy DNS, Close On Exit, and SSH server bug
214 * workarounds. Accordingly I supply a single enum here to deal
215 * with them all.
216 */
217 FORCE_ON, FORCE_OFF, AUTO
218};
219
220enum {
221 /*
222 * Proxy types.
223 */
224 PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
225 PROXY_HTTP, PROXY_TELNET, PROXY_CMD
226};
227
228enum {
229 /*
230 * Line discipline options which the backend might try to control.
231 */
232 LD_EDIT, /* local line editing */
233 LD_ECHO /* local echo */
234};
235
236enum {
237 /* Protocol back ends. (cfg.protocol) */
238 PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
239};
240
241enum {
242 /* Bell settings (cfg.beep) */
243 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
244};
245
246enum {
247 /* Taskbar flashing indication on bell (cfg.beep_ind) */
248 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
249};
250
251enum {
252 /* Resize actions (cfg.resize_action) */
253 RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
254};
255
256enum {
257 /* Function key types (cfg.funky_type) */
258 FUNKY_TILDE,
259 FUNKY_LINUX,
260 FUNKY_XTERM,
261 FUNKY_VT400,
262 FUNKY_VT100P,
263 FUNKY_SCO
264};
265
266struct backend_tag {
267 const char *(*init) (void *frontend_handle, void **backend_handle,
268 Config *cfg,
269 char *host, int port, char **realhost, int nodelay,
270 int keepalive);
271 void (*free) (void *handle);
272 /* back->reconfig() passes in a replacement configuration. */
273 void (*reconfig) (void *handle, Config *cfg);
274 /* back->send() returns the current amount of buffered data. */
275 int (*send) (void *handle, char *buf, int len);
276 /* back->sendbuffer() does the same thing but without attempting a send */
277 int (*sendbuffer) (void *handle);
278 void (*size) (void *handle, int width, int height);
279 void (*special) (void *handle, Telnet_Special code);
280 const struct telnet_special *(*get_specials) (void *handle);
281 Socket(*socket) (void *handle);
282 int (*exitcode) (void *handle);
283 int (*sendok) (void *handle);
284 int (*ldisc) (void *handle, int);
285 void (*provide_ldisc) (void *handle, void *ldisc);
286 void (*provide_logctx) (void *handle, void *logctx);
287 /*
288 * back->unthrottle() tells the back end that the front end
289 * buffer is clearing.
290 */
291 void (*unthrottle) (void *handle, int);
292 int default_port;
293};
294
295extern struct backend_list {
296 int protocol;
297 char *name;
298 Backend *backend;
299} backends[];
300
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
307/*
308 * Name of this particular application, for use in the config box
309 * and other pieces of text.
310 */
311extern const char *const appname;
312
313/*
314 * IMPORTANT POLICY POINT: everything in this structure which wants
315 * to be treated like an integer must be an actual, honest-to-
316 * goodness `int'. No enum-typed variables. This is because parts
317 * of the code will want to pass around `int *' pointers to them
318 * and we can't run the risk of porting to some system on which the
319 * enum comes out as a different size from int.
320 */
321struct config_tag {
322 /* Basic options */
323 char host[512];
324 int port;
325 int protocol;
326 int close_on_exit;
327 int warn_on_close;
328 int ping_interval; /* in seconds */
329 int tcp_nodelay;
330 int tcp_keepalives;
331 /* Proxy options */
332 char proxy_exclude_list[512];
333 int proxy_dns;
334 int even_proxy_localhost;
335 int proxy_type;
336 char proxy_host[512];
337 int proxy_port;
338 char proxy_username[128];
339 char proxy_password[128];
340 char proxy_telnet_command[512];
341 /* SSH options */
342 char remote_cmd[512];
343 char remote_cmd2[512]; /* fallback if the first fails
344 * (used internally for scp) */
345 char *remote_cmd_ptr; /* might point to a larger command
346 * but never for loading/saving */
347 char *remote_cmd_ptr2; /* might point to a larger command
348 * but never for loading/saving */
349 int nopty;
350 int compression;
351 int agentfwd;
352 int change_username; /* allow username switching in SSH2 */
353 int ssh_cipherlist[CIPHER_MAX];
354 Filename keyfile;
355 int sshprot; /* use v1 or v2 when both available */
356 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
357 int try_tis_auth;
358 int try_ki_auth;
359 int ssh_subsys; /* run a subsystem rather than a command */
360 int ssh_subsys2; /* fallback to go with remote_cmd2 */
361 /* Telnet options */
362 char termtype[32];
363 char termspeed[32];
364 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
365 char username[100];
366 char localusername[100];
367 int rfc_environ;
368 int passive_telnet;
369 /* Keyboard options */
370 int bksp_is_delete;
371 int rxvt_homeend;
372 int funky_type;
373 int no_applic_c; /* totally disable app cursor keys */
374 int no_applic_k; /* totally disable app keypad */
375 int no_mouse_rep; /* totally disable mouse reporting */
376 int no_remote_resize; /* disable remote resizing */
377 int no_alt_screen; /* disable alternate screen */
378 int no_remote_wintitle; /* disable remote retitling */
379 int no_dbackspace; /* disable destructive backspace */
380 int no_remote_charset; /* disable remote charset config */
381 int no_remote_qtitle; /* disable remote win title query */
382 int app_cursor;
383 int app_keypad;
384 int nethack_keypad;
385 int telnet_keyboard;
386 int telnet_newline;
387 int alt_f4; /* is it special? */
388 int alt_space; /* is it special? */
389 int alt_only; /* is it special? */
390 int localecho;
391 int localedit;
392 int alwaysontop;
393 int fullscreenonaltenter;
394 int scroll_on_key;
395 int scroll_on_disp;
396 int erase_to_scrollback;
397 int compose_key;
398 int ctrlaltkeys;
399 char wintitle[256]; /* initial window title */
400 /* Terminal options */
401 int savelines;
402 int dec_om;
403 int wrap_mode;
404 int lfhascr;
405 int cursor_type; /* 0=block 1=underline 2=vertical */
406 int blink_cur;
407 int beep;
408 int beep_ind;
409 int bellovl; /* bell overload protection active? */
410 int bellovl_n; /* number of bells to cause overload */
411 int bellovl_t; /* time interval for overload (seconds) */
412 int bellovl_s; /* period of silence to re-enable bell (s) */
413 Filename bell_wavefile;
414 int scrollbar;
415 int scrollbar_in_fullscreen;
416 int resize_action;
417 int bce;
418 int blinktext;
419 int win_name_always;
420 int width, height;
421 FontSpec font;
422 Filename logfilename;
423 int logtype;
424 int logxfovr;
425 int logomitpass;
426 int logomitdata;
427 int hide_mouseptr;
428 int sunken_edge;
429 int window_border;
430 char answerback[256];
431 char printer[128];
432 int arabicshaping;
433 int bidi;
434 /* Colour options */
435 int system_colour;
436 int try_palette;
437 int bold_colour;
438 unsigned char colours[22][3];
439 /* Selection options */
440 int mouse_is_xterm;
441 int rect_select;
442 int rawcnp;
443 int rtf_paste;
444 int mouse_override;
445 short wordness[256];
446 /* translations */
447 int vtmode;
448 char line_codepage[128];
449 int xlat_capslockcyr;
450 /* X11 forwarding */
451 int x11_forward;
452 char x11_display[128];
453 int x11_auth;
454 /* port forwarding */
455 int lport_acceptall; /* accept conns from hosts other than localhost */
456 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
457 /*
458 * The port forwarding string contains a number of
459 * NUL-terminated substrings, terminated in turn by an empty
460 * string (i.e. a second NUL immediately after the previous
461 * one). Each string can be of one of the following forms:
462 *
463 * [LR]localport\thost:port
464 * [LR]localaddr:localport\thost:port
465 * Dlocalport
466 * Dlocaladdr:localport
467 */
468 char portfwd[1024];
469 /* SSH bug compatibility modes */
470 int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
471 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
472 sshbug_dhgex2, sshbug_pksessid2;
473 /* Options for pterm. Should split out into platform-dependent part. */
474 int stamp_utmp;
475 int login_shell;
476 int scrollbar_on_left;
477 int shadowbold;
478 FontSpec boldfont;
479 FontSpec widefont;
480 FontSpec wideboldfont;
481 int shadowboldoffset;
482};
483
484/*
485 * Some global flags denoting the type of application.
486 *
487 * FLAG_VERBOSE is set when the user requests verbose details.
488 *
489 * FLAG_STDERR is set in command-line applications (which have a
490 * functioning stderr that it makes sense to write to) and not in
491 * GUI applications (which don't).
492 *
493 * FLAG_INTERACTIVE is set when a full interactive shell session is
494 * being run, _either_ because no remote command has been provided
495 * _or_ because the application is GUI and can't run non-
496 * interactively.
497 *
498 * These flags describe the type of _application_ - they wouldn't
499 * vary between individual sessions - and so it's OK to have this
500 * variable be GLOBAL.
501 *
502 * Note that additional flags may be defined in platform-specific
503 * headers. It's probably best if those ones start from 0x1000, to
504 * avoid collision.
505 */
506#define FLAG_VERBOSE 0x0001
507#define FLAG_STDERR 0x0002
508#define FLAG_INTERACTIVE 0x0004
509GLOBAL int flags;
510
511/*
512 * Likewise, these two variables are set up when the application
513 * initialises, and inform all default-settings accesses after
514 * that.
515 */
516GLOBAL int default_protocol;
517GLOBAL int default_port;
518
519/*
520 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
521 */
522GLOBAL int loaded_session;
523
524struct RSAKey; /* be a little careful of scope */
525
526/*
527 * Exports from window.c.
528 */
529void request_resize(void *frontend, int, int);
530void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
531void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
532int char_width(Context ctx, int uc);
533#ifdef OPTIMISE_SCROLL
534void do_scroll(Context, int, int, int);
535#endif
536void set_title(void *frontend, char *);
537void set_icon(void *frontend, char *);
538void set_sbar(void *frontend, int, int, int);
539Context get_ctx(void *frontend);
540void free_ctx(Context);
541void palette_set(void *frontend, int, int, int, int);
542void palette_reset(void *frontend);
543void write_aclip(void *frontend, char *, int, int);
544void write_clip(void *frontend, wchar_t *, int, int);
545void get_clip(void *frontend, wchar_t **, int *);
546void optimised_move(void *frontend, int, int, int);
547void set_raw_mouse_mode(void *frontend, int);
548void connection_fatal(void *frontend, char *, ...);
549void fatalbox(char *, ...);
550void modalfatalbox(char *, ...);
551#ifdef macintosh
552#pragma noreturn(fatalbox)
553#pragma noreturn(modalfatalbox)
554#endif
555void beep(void *frontend, int);
556void begin_session(void *frontend);
557void sys_cursor(void *frontend, int x, int y);
558void request_paste(void *frontend);
559void frontend_keypress(void *frontend);
560void ldisc_update(void *frontend, int echo, int edit);
561void update_specials_menu(void *frontend);
562int from_backend(void *frontend, int is_stderr, const char *data, int len);
563#define OPTIMISE_IS_SCROLL 1
564
565void set_iconic(void *frontend, int iconic);
566void move_window(void *frontend, int x, int y);
567void set_zorder(void *frontend, int top);
568void refresh_window(void *frontend);
569void set_zoomed(void *frontend, int zoomed);
570int is_iconic(void *frontend);
571void get_window_pos(void *frontend, int *x, int *y);
572void get_window_pixels(void *frontend, int *x, int *y);
573char *get_window_title(void *frontend, int icon);
574
575void cleanup_exit(int);
576
577/*
578 * Exports from noise.c.
579 */
580void noise_get_heavy(void (*func) (void *, int));
581void noise_get_light(void (*func) (void *, int));
582void noise_regular(void);
583void noise_ultralight(unsigned long data);
584void random_save_seed(void);
585void random_destroy_seed(void);
586
587/*
588 * Exports from settings.c.
589 */
590char *save_settings(char *section, int do_host, Config * cfg);
591void save_open_settings(void *sesskey, int do_host, Config *cfg);
592void load_settings(char *section, int do_host, Config * cfg);
593void load_open_settings(void *sesskey, int do_host, Config *cfg);
594void get_sesslist(struct sesslist *, int allocate);
595void do_defaults(char *, Config *);
596void registry_cleanup(void);
597
598/*
599 * Functions used by settings.c to provide platform-specific
600 * default settings.
601 *
602 * (The integer one is expected to return `def' if it has no clear
603 * opinion of its own. This is because there's no integer value
604 * which I can reliably set aside to indicate `nil'. The string
605 * function is perfectly all right returning NULL, of course. The
606 * Filename and FontSpec functions are _not allowed_ to fail to
607 * return, since these defaults _must_ be per-platform.)
608 */
609char *platform_default_s(const char *name);
610int platform_default_i(const char *name, int def);
611Filename platform_default_filename(const char *name);
612FontSpec platform_default_fontspec(const char *name);
613
614/*
615 * Exports from terminal.c.
616 */
617
618Terminal *term_init(Config *, struct unicode_data *, void *);
619void term_free(Terminal *);
620void term_size(Terminal *, int, int, int);
621void term_out(Terminal *);
622void term_paint(Terminal *, Context, int, int, int, int, int);
623void term_scroll(Terminal *, int, int);
624void term_pwron(Terminal *);
625void term_clrsb(Terminal *);
626void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
627 int,int,int,int,int);
628void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
629 unsigned int);
630void term_deselect(Terminal *);
631void term_update(Terminal *);
632void term_invalidate(Terminal *);
633void term_blink(Terminal *, int set_cursor);
634void term_do_paste(Terminal *);
635int term_paste_pending(Terminal *);
636void term_paste(Terminal *);
637void term_nopaste(Terminal *);
638int term_ldisc(Terminal *, int option);
639void term_copyall(Terminal *);
640void term_reconfig(Terminal *, Config *);
641void term_seen_key_event(Terminal *);
642int term_data(Terminal *, int is_stderr, const char *data, int len);
643void term_provide_resize_fn(Terminal *term,
644 void (*resize_fn)(void *, int, int),
645 void *resize_ctx);
646void term_provide_logctx(Terminal *term, void *logctx);
647
648/*
649 * Exports from logging.c.
650 */
651void *log_init(void *frontend, Config *cfg);
652void log_free(void *logctx);
653void log_reconfig(void *logctx, Config *cfg);
654void logfopen(void *logctx);
655void logfclose(void *logctx);
656void logtraffic(void *logctx, unsigned char c, int logmode);
657void logflush(void *logctx);
658void log_eventlog(void *logctx, const char *string);
659enum { PKT_INCOMING, PKT_OUTGOING };
660enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
661struct logblank_t {
662 int offset;
663 int len;
664 int type;
665};
666void log_packet(void *logctx, int direction, int type,
667 char *texttype, void *data, int len,
668 int n_blanks, const struct logblank_t *blanks);
669
670/*
671 * Exports from testback.c
672 */
673
674extern Backend null_backend;
675extern Backend loop_backend;
676
677/*
678 * Exports from raw.c.
679 */
680
681extern Backend raw_backend;
682
683/*
684 * Exports from rlogin.c.
685 */
686
687extern Backend rlogin_backend;
688
689/*
690 * Exports from telnet.c.
691 */
692
693extern Backend telnet_backend;
694
695/*
696 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
697 * so that PuTTYtel will still compile - otherwise it would depend
698 * on ssh.c.)
699 */
700
701GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
702 int is_pw);
703GLOBAL int ssh_getline_pw_only;
704extern Backend ssh_backend;
705
706/*
707 * Exports from ldisc.c.
708 */
709void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
710void ldisc_free(void *);
711void ldisc_send(void *handle, char *buf, int len, int interactive);
712
713/*
714 * Exports from ldiscucs.c.
715 */
716void lpage_send(void *, int codepage, char *buf, int len, int interactive);
717void luni_send(void *, wchar_t * widebuf, int len, int interactive);
718
719/*
720 * Exports from sshrand.c.
721 */
722
723void random_add_noise(void *noise, int length);
724void random_init(void);
725int random_byte(void);
726void random_get_savedata(void **data, int *len);
727extern int random_active;
728
729/*
730 * Exports from misc.c.
731 */
732
733#include "misc.h"
734
735/*
736 * Exports from version.c.
737 */
738extern char ver[];
739
740/*
741 * Exports from unicode.c.
742 */
743#ifndef CP_UTF8
744#define CP_UTF8 65001
745#endif
746/* void init_ucs(void); -- this is now in platform-specific headers */
747int is_dbcs_leadbyte(int codepage, char byte);
748int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
749 wchar_t *wcstr, int wclen);
750int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
751 char *mbstr, int mblen, char *defchr, int *defused,
752 struct unicode_data *ucsdata);
753wchar_t xlat_uskbd2cyrllic(int ch);
754int check_compose(int first, int second);
755int decode_codepage(char *cp_name);
756const char *cp_enumerate (int index);
757const char *cp_name(int codepage);
758void get_unitab(int codepage, wchar_t * unitab, int ftype);
759
760/*
761 * Exports from wcwidth.c
762 */
763int wcwidth(wchar_t ucs);
764int wcswidth(const wchar_t *pwcs, size_t n);
765
766/*
767 * Exports from mscrypto.c
768 */
769#ifdef MSCRYPTOAPI
770int crypto_startup();
771void crypto_wrapup();
772#endif
773
774/*
775 * Exports from pageantc.c.
776 *
777 * agent_query returns 1 for here's-a-response, and 0 for query-in-
778 * progress. In the latter case there will be a call to `callback'
779 * at some future point, passing callback_ctx as the first
780 * parameter and the actual reply data as the second and third.
781 *
782 * The response may be a NULL pointer (in either of the synchronous
783 * or asynchronous cases), which indicates failure to receive a
784 * response.
785 */
786int agent_query(void *in, int inlen, void **out, int *outlen,
787 void (*callback)(void *, void *, int), void *callback_ctx);
788int agent_exists(void);
789
790/*
791 * Exports from wildcard.c
792 */
793const char *wc_error(int value);
794int wc_match(const char *wildcard, const char *target);
795int wc_unescape(char *output, const char *wildcard);
796
797/*
798 * Exports from windlg.c
799 */
800void logevent(void *frontend, const char *);
801void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
802 char *keystr, char *fingerprint);
803void askcipher(void *frontend, char *ciphername, int cs);
804int askappend(void *frontend, Filename filename);
805
806/*
807 * Exports from console.c (that aren't equivalents to things in
808 * windlg.c).
809 */
810extern int console_batch_mode;
811int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
812void console_provide_logctx(void *logctx);
813int is_interactive(void);
814
815/*
816 * Exports from printing.c.
817 */
818typedef struct printer_enum_tag printer_enum;
819typedef struct printer_job_tag printer_job;
820printer_enum *printer_start_enum(int *nprinters);
821char *printer_get_name(printer_enum *, int);
822void printer_finish_enum(printer_enum *);
823printer_job *printer_start_job(char *printer);
824void printer_job_data(printer_job *, void *, int);
825void printer_finish_job(printer_job *);
826
827/*
828 * Exports from cmdline.c (and also cmdline_error(), which is
829 * defined differently in various places and required _by_
830 * cmdline.c).
831 */
832int cmdline_process_param(char *, char *, int, Config *);
833void cmdline_run_saved(Config *);
834void cmdline_cleanup(void);
835extern char *cmdline_password;
836#define TOOLTYPE_FILETRANSFER 1
837#define TOOLTYPE_NONNETWORK 2
838extern int cmdline_tooltype;
839
840void cmdline_error(char *, ...);
841
842/*
843 * Exports from config.c.
844 */
845struct controlbox;
846void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
847 int midsession, int protocol);
848
849/*
850 * Exports from minibidi.c.
851 */
852typedef struct bidi_char {
853 wchar_t origwc, wc;
854 unsigned short index;
855} bidi_char;
856int do_bidi(bidi_char *line, int count);
857int do_shape(bidi_char *line, bidi_char *to, int count);
858
859/*
860 * X11 auth mechanisms we know about.
861 */
862enum {
863 X11_NO_AUTH,
864 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
865 X11_XDM, /* XDM-AUTHORIZATION-1 */
866 X11_NAUTHS
867};
868extern const char *const x11_authnames[]; /* declared in x11fwd.c */
869
870/*
871 * Miscellaneous exports from the platform-specific code.
872 */
873Filename filename_from_str(const char *string);
874const char *filename_to_str(const Filename *fn);
875int filename_equal(Filename f1, Filename f2);
876int filename_is_null(Filename fn);
877char *get_username(void); /* return value needs freeing */
878char *get_random_data(int bytes); /* used in cmdgen.c */
879
880#endif