4 #include <stddef.h> /* for wchar_t */
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.
12 #ifdef PUTTY_DO_GLOBALS
21 typedef struct config_tag Config
;
22 typedef struct backend_tag Backend
;
23 typedef struct terminal_tag Terminal
;
30 /* Three attribute types:
31 * The ATTRs (normal attributes) are stored with the characters in
32 * the main display arrays
34 * The TATTRs (temporary attributes) are generated on the fly, they
35 * can overlap with characters but not with normal attributes.
37 * The LATTRs (line attributes) are an entirely disjoint space of
40 * The DATTRs (display attributes) are internal to terminal.c (but
41 * defined here because their values have to match the others
42 * here); they reuse the TATTR_* space but are always masked off
43 * before sending to the front end.
45 * ATTR_INVALID is an illegal colour combination.
48 #define TATTR_ACTCURS 0x40000000UL /* active cursor (block) */
49 #define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */
50 #define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */
51 #define TATTR_COMBINING 0x80000000UL /* combining characters */
53 #define DATTR_STARTRUN 0x80000000UL /* start of redraw run */
55 #define TDATTR_MASK 0xF0000000UL
56 #define TATTR_MASK (TDATTR_MASK)
57 #define DATTR_MASK (TDATTR_MASK)
59 #define LATTR_NORM 0x00000000UL
60 #define LATTR_WIDE 0x00000001UL
61 #define LATTR_TOP 0x00000002UL
62 #define LATTR_BOT 0x00000003UL
63 #define LATTR_MODE 0x00000003UL
64 #define LATTR_WRAPPED 0x00000010UL
65 #define LATTR_WRAPPED2 0x00000020UL
67 #define ATTR_INVALID 0x03FFFFU
69 /* Like Linux use the F000 page for direct to font. */
70 #define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */
71 #define CSET_ACP 0x0000F100UL /* Ansi Codepage DTF */
73 /* These are internal use overlapping with the UTF-16 surrogates */
74 #define CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
75 #define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
76 #define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */
77 #define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
78 #define CSET_MASK 0xFFFFFF00UL /* Character set mask */
80 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
81 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
83 #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */
85 * UCSWIDE is a special value used in the terminal data to signify
86 * the character cell containing the right-hand half of a CJK wide
87 * character. We use 0xDFFF because it's part of the surrogate
88 * range and hence won't be used for anything else (it's impossible
89 * to input it via UTF-8 because our UTF-8 decoder correctly
90 * rejects surrogates).
92 #define UCSWIDE 0xDFFF
94 #define ATTR_NARROW 0x800000U
95 #define ATTR_WIDE 0x400000U
96 #define ATTR_BOLD 0x040000U
97 #define ATTR_UNDER 0x080000U
98 #define ATTR_REVERSE 0x100000U
99 #define ATTR_BLINK 0x200000U
100 #define ATTR_FGMASK 0x0001FFU
101 #define ATTR_BGMASK 0x03FE00U
102 #define ATTR_COLOURS 0x03FFFFU
103 #define ATTR_FGSHIFT 0
104 #define ATTR_BGSHIFT 9
107 * The definitive list of colour numbers stored in terminal
108 * attribute words is kept here. It is:
110 * - 0-7 are ANSI colours (KRGYBMCW).
111 * - 8-15 are the bold versions of those colours.
112 * - 16-255 are the remains of the xterm 256-colour mode (a
113 * 216-colour cube with R at most significant and B at least,
114 * followed by a uniform series of grey shades running between
115 * black and white but not including either on grounds of
117 * - 256 is default foreground
118 * - 257 is default bold foreground
119 * - 258 is default background
120 * - 259 is default bold background
121 * - 260 is cursor foreground
122 * - 261 is cursor background
125 #define ATTR_DEFFG (256 << ATTR_FGSHIFT)
126 #define ATTR_DEFBG (258 << ATTR_BGSHIFT)
127 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
132 char *buffer
; /* so memory can be freed later */
135 struct unicode_data
{
140 wchar_t unitab_scoacs
[256];
141 wchar_t unitab_line
[256];
142 wchar_t unitab_font
[256];
143 wchar_t unitab_xterm
[256];
144 wchar_t unitab_oemcp
[256];
145 unsigned char unitab_ctrl
[256];
148 #define LGXF_OVR 1 /* existing logfile overwrite */
149 #define LGXF_APN 0 /* existing logfile append */
150 #define LGXF_ASK -1 /* existing logfile ask */
151 #define LGTYP_NONE 0 /* logmode: no logging */
152 #define LGTYP_ASCII 1 /* logmode: pure ascii */
153 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
154 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
157 /* Actual special commands. Originally Telnet, but some codes have
158 * been re-used for similar specials in other protocols. */
159 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
160 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
162 /* Special command for SSH. */
164 /* POSIX-style signals. (not Telnet) */
165 TS_SIGABRT
, TS_SIGALRM
, TS_SIGFPE
, TS_SIGHUP
, TS_SIGILL
,
166 TS_SIGINT
, TS_SIGKILL
, TS_SIGPIPE
, TS_SIGQUIT
, TS_SIGSEGV
,
167 TS_SIGTERM
, TS_SIGUSR1
, TS_SIGUSR2
,
168 /* Pseudo-specials used for constructing the specials menu. */
169 TS_SEP
, /* Separator */
170 TS_SUBMENU
, /* Start a new submenu with specified name */
171 TS_EXITMENU
/* Exit current submenu or end of specials */
174 struct telnet_special
{
181 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
182 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
183 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
187 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
190 /* Keyboard modifiers -- keys the user is actually holding down */
192 #define PKM_SHIFT 0x01
193 #define PKM_CONTROL 0x02
194 #define PKM_META 0x04
197 /* Keyboard flags that aren't really modifiers */
198 #define PKF_CAPSLOCK 0x10
199 #define PKF_NUMLOCK 0x20
200 #define PKF_REPEAT 0x40
202 /* Stand-alone keysyms for function keys */
205 PK_NULL
, /* No symbol for this key */
206 /* Main keypad keys */
207 PK_ESCAPE
, PK_TAB
, PK_BACKSPACE
, PK_RETURN
, PK_COMPOSE
,
209 PK_HOME
, PK_INSERT
, PK_DELETE
, PK_END
, PK_PAGEUP
, PK_PAGEDOWN
,
211 PK_UP
, PK_DOWN
, PK_RIGHT
, PK_LEFT
, PK_REST
,
212 /* Numeric keypad */ /* Real one looks like: */
213 PK_PF1
, PK_PF2
, PK_PF3
, PK_PF4
, /* PF1 PF2 PF3 PF4 */
214 PK_KPCOMMA
, PK_KPMINUS
, PK_KPDECIMAL
, /* 7 8 9 - */
215 PK_KP0
, PK_KP1
, PK_KP2
, PK_KP3
, PK_KP4
, /* 4 5 6 , */
216 PK_KP5
, PK_KP6
, PK_KP7
, PK_KP8
, PK_KP9
, /* 1 2 3 en- */
217 PK_KPBIGPLUS
, PK_KPENTER
, /* 0 . ter */
219 PK_F1
, PK_F2
, PK_F3
, PK_F4
, PK_F5
,
220 PK_F6
, PK_F7
, PK_F8
, PK_F9
, PK_F10
,
221 PK_F11
, PK_F12
, PK_F13
, PK_F14
, PK_F15
,
222 PK_F16
, PK_F17
, PK_F18
, PK_F19
, PK_F20
,
226 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
227 #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST)
228 #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER)
229 #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20)
232 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
237 * SSH-2 key exchange algorithms
248 * SSH ciphers (both SSH1 and SSH2)
250 CIPHER_WARN
, /* pseudo 'cipher' */
253 CIPHER_AES
, /* (SSH 2 only) */
255 CIPHER_MAX
/* no. ciphers (inc warn) */
260 * Several different bits of the PuTTY configuration seem to be
261 * three-way settings whose values are `always yes', `always
262 * no', and `decide by some more complex automated means'. This
263 * is true of line discipline options (local echo and line
264 * editing), proxy DNS, Close On Exit, and SSH server bug
265 * workarounds. Accordingly I supply a single enum here to deal
268 FORCE_ON
, FORCE_OFF
, AUTO
275 PROXY_NONE
, PROXY_SOCKS4
, PROXY_SOCKS5
,
276 PROXY_HTTP
, PROXY_TELNET
, PROXY_CMD
281 * Line discipline options which the backend might try to control.
283 LD_EDIT
, /* local line editing */
284 LD_ECHO
/* local echo */
288 /* Protocol back ends. (cfg.protocol) */
289 PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
293 /* Bell settings (cfg.beep) */
294 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
, BELL_PCSPEAKER
298 /* Taskbar flashing indication on bell (cfg.beep_ind) */
299 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
303 /* Resize actions (cfg.resize_action) */
304 RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
308 /* Function key types (cfg.funky_type) */
318 const char *(*init
) (void *frontend_handle
, void **backend_handle
,
320 char *host
, int port
, char **realhost
, int nodelay
,
322 void (*free
) (void *handle
);
323 /* back->reconfig() passes in a replacement configuration. */
324 void (*reconfig
) (void *handle
, Config
*cfg
);
325 /* back->send() returns the current amount of buffered data. */
326 int (*send
) (void *handle
, char *buf
, int len
);
327 /* back->sendbuffer() does the same thing but without attempting a send */
328 int (*sendbuffer
) (void *handle
);
329 void (*size
) (void *handle
, int width
, int height
);
330 void (*special
) (void *handle
, Telnet_Special code
);
331 const struct telnet_special
*(*get_specials
) (void *handle
);
332 Socket(*socket
) (void *handle
);
333 int (*exitcode
) (void *handle
);
334 int (*sendok
) (void *handle
);
335 int (*ldisc
) (void *handle
, int);
336 void (*provide_ldisc
) (void *handle
, void *ldisc
);
337 void (*provide_logctx
) (void *handle
, void *logctx
);
339 * back->unthrottle() tells the back end that the front end
340 * buffer is clearing.
342 void (*unthrottle
) (void *handle
, int);
346 extern struct backend_list
{
353 * Suggested default protocol provided by the backend link module.
354 * The application is free to ignore this.
356 extern const int be_default_protocol
;
359 * Name of this particular application, for use in the config box
360 * and other pieces of text.
362 extern const char *const appname
;
365 * IMPORTANT POLICY POINT: everything in this structure which wants
366 * to be treated like an integer must be an actual, honest-to-
367 * goodness `int'. No enum-typed variables. This is because parts
368 * of the code will want to pass around `int *' pointers to them
369 * and we can't run the risk of porting to some system on which the
370 * enum comes out as a different size from int.
379 int ping_interval
; /* in seconds */
383 char proxy_exclude_list
[512];
385 int even_proxy_localhost
;
387 char proxy_host
[512];
389 char proxy_username
[128];
390 char proxy_password
[128];
391 char proxy_telnet_command
[512];
393 char remote_cmd
[512];
394 char remote_cmd2
[512]; /* fallback if the first fails
395 * (used internally for scp) */
396 char *remote_cmd_ptr
; /* might point to a larger command
397 * but never for loading/saving */
398 char *remote_cmd_ptr2
; /* might point to a larger command
399 * but never for loading/saving */
402 int ssh_kexlist
[KEX_MAX
];
403 int ssh_rekey_time
; /* in minutes */
404 char ssh_rekey_data
[16];
406 int change_username
; /* allow username switching in SSH2 */
407 int ssh_cipherlist
[CIPHER_MAX
];
409 int sshprot
; /* use v1 or v2 when both available */
410 int ssh2_des_cbc
; /* "des-cbc" nonstandard SSH2 cipher */
413 int ssh_subsys
; /* run a subsystem rather than a command */
414 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
415 int ssh_no_shell
; /* avoid running a shell */
419 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
421 char localusername
[100];
424 /* Keyboard options */
428 int no_applic_c
; /* totally disable app cursor keys */
429 int no_applic_k
; /* totally disable app keypad */
430 int no_mouse_rep
; /* totally disable mouse reporting */
431 int no_remote_resize
; /* disable remote resizing */
432 int no_alt_screen
; /* disable alternate screen */
433 int no_remote_wintitle
; /* disable remote retitling */
434 int no_dbackspace
; /* disable destructive backspace */
435 int no_remote_charset
; /* disable remote charset config */
436 int no_remote_qtitle
; /* disable remote win title query */
442 int alt_f4
; /* is it special? */
443 int alt_space
; /* is it special? */
444 int alt_only
; /* is it special? */
448 int fullscreenonaltenter
;
451 int erase_to_scrollback
;
454 char wintitle
[256]; /* initial window title */
455 /* Terminal options */
460 int cursor_type
; /* 0=block 1=underline 2=vertical */
464 int bellovl
; /* bell overload protection active? */
465 int bellovl_n
; /* number of bells to cause overload */
466 int bellovl_t
; /* time interval for overload (seconds) */
467 int bellovl_s
; /* period of silence to re-enable bell (s) */
468 Filename bell_wavefile
;
470 int scrollbar_in_fullscreen
;
477 Filename logfilename
;
486 char answerback
[256];
492 int xterm_256_colour
;
496 unsigned char colours
[22][3];
497 /* Selection options */
506 char line_codepage
[128];
508 int xlat_capslockcyr
;
511 char x11_display
[128];
513 /* port forwarding */
514 int lport_acceptall
; /* accept conns from hosts other than localhost */
515 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
517 * The port forwarding string contains a number of
518 * NUL-terminated substrings, terminated in turn by an empty
519 * string (i.e. a second NUL immediately after the previous
520 * one). Each string can be of one of the following forms:
522 * [LR]localport\thost:port
523 * [LR]localaddr:localport\thost:port
525 * Dlocaladdr:localport
528 /* SSH bug compatibility modes */
529 int sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
530 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
532 /* Options for pterm. Should split out into platform-dependent part. */
535 int scrollbar_on_left
;
539 FontSpec wideboldfont
;
540 int shadowboldoffset
;
544 * Some global flags denoting the type of application.
546 * FLAG_VERBOSE is set when the user requests verbose details.
548 * FLAG_STDERR is set in command-line applications (which have a
549 * functioning stderr that it makes sense to write to) and not in
550 * GUI applications (which don't).
552 * FLAG_INTERACTIVE is set when a full interactive shell session is
553 * being run, _either_ because no remote command has been provided
554 * _or_ because the application is GUI and can't run non-
557 * These flags describe the type of _application_ - they wouldn't
558 * vary between individual sessions - and so it's OK to have this
559 * variable be GLOBAL.
561 * Note that additional flags may be defined in platform-specific
562 * headers. It's probably best if those ones start from 0x1000, to
565 #define FLAG_VERBOSE 0x0001
566 #define FLAG_STDERR 0x0002
567 #define FLAG_INTERACTIVE 0x0004
571 * Likewise, these two variables are set up when the application
572 * initialises, and inform all default-settings accesses after
575 GLOBAL
int default_protocol
;
576 GLOBAL
int default_port
;
579 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
581 GLOBAL
int loaded_session
;
583 struct RSAKey
; /* be a little careful of scope */
586 * Exports from window.c.
588 void request_resize(void *frontend
, int, int);
589 void do_text(Context
, int, int, wchar_t *, int, unsigned long, int);
590 void do_cursor(Context
, int, int, wchar_t *, int, unsigned long, int);
591 int char_width(Context ctx
, int uc
);
592 #ifdef OPTIMISE_SCROLL
593 void do_scroll(Context
, int, int, int);
595 void set_title(void *frontend
, char *);
596 void set_icon(void *frontend
, char *);
597 void set_sbar(void *frontend
, int, int, int);
598 Context
get_ctx(void *frontend
);
599 void free_ctx(Context
);
600 void palette_set(void *frontend
, int, int, int, int);
601 void palette_reset(void *frontend
);
602 void write_aclip(void *frontend
, char *, int, int);
603 void write_clip(void *frontend
, wchar_t *, int, int);
604 void get_clip(void *frontend
, wchar_t **, int *);
605 void optimised_move(void *frontend
, int, int, int);
606 void set_raw_mouse_mode(void *frontend
, int);
607 void connection_fatal(void *frontend
, char *, ...);
608 void fatalbox(char *, ...);
609 void modalfatalbox(char *, ...);
611 #pragma noreturn(fatalbox)
612 #pragma noreturn(modalfatalbox)
614 void beep(void *frontend
, int);
615 void begin_session(void *frontend
);
616 void sys_cursor(void *frontend
, int x
, int y
);
617 void request_paste(void *frontend
);
618 void frontend_keypress(void *frontend
);
619 void ldisc_update(void *frontend
, int echo
, int edit
);
620 /* It's the backend's responsibility to invoke this at the start of a
621 * connection, if necessary; it can also invoke it later if the set of
622 * special commands changes. It does not need to invoke it at session
624 void update_specials_menu(void *frontend
);
625 int from_backend(void *frontend
, int is_stderr
, const char *data
, int len
);
626 void notify_remote_exit(void *frontend
);
627 #define OPTIMISE_IS_SCROLL 1
629 void set_iconic(void *frontend
, int iconic
);
630 void move_window(void *frontend
, int x
, int y
);
631 void set_zorder(void *frontend
, int top
);
632 void refresh_window(void *frontend
);
633 void set_zoomed(void *frontend
, int zoomed
);
634 int is_iconic(void *frontend
);
635 void get_window_pos(void *frontend
, int *x
, int *y
);
636 void get_window_pixels(void *frontend
, int *x
, int *y
);
637 char *get_window_title(void *frontend
, int icon
);
639 void cleanup_exit(int);
642 * Exports from noise.c.
644 void noise_get_heavy(void (*func
) (void *, int));
645 void noise_get_light(void (*func
) (void *, int));
646 void noise_regular(void);
647 void noise_ultralight(unsigned long data
);
648 void random_save_seed(void);
649 void random_destroy_seed(void);
652 * Exports from settings.c.
654 char *save_settings(char *section
, int do_host
, Config
* cfg
);
655 void save_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
656 void load_settings(char *section
, int do_host
, Config
* cfg
);
657 void load_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
658 void get_sesslist(struct sesslist
*, int allocate
);
659 void do_defaults(char *, Config
*);
660 void registry_cleanup(void);
663 * Functions used by settings.c to provide platform-specific
666 * (The integer one is expected to return `def' if it has no clear
667 * opinion of its own. This is because there's no integer value
668 * which I can reliably set aside to indicate `nil'. The string
669 * function is perfectly all right returning NULL, of course. The
670 * Filename and FontSpec functions are _not allowed_ to fail to
671 * return, since these defaults _must_ be per-platform.)
673 char *platform_default_s(const char *name
);
674 int platform_default_i(const char *name
, int def
);
675 Filename
platform_default_filename(const char *name
);
676 FontSpec
platform_default_fontspec(const char *name
);
679 * Exports from terminal.c.
682 Terminal
*term_init(Config
*, struct unicode_data
*, void *);
683 void term_free(Terminal
*);
684 void term_size(Terminal
*, int, int, int);
685 void term_paint(Terminal
*, Context
, int, int, int, int, int);
686 void term_scroll(Terminal
*, int, int);
687 void term_pwron(Terminal
*);
688 void term_clrsb(Terminal
*);
689 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Button
, Mouse_Action
,
690 int,int,int,int,int);
691 void term_key(Terminal
*, Key_Sym
, wchar_t *, size_t, unsigned int,
693 void term_deselect(Terminal
*);
694 void term_update(Terminal
*);
695 void term_invalidate(Terminal
*);
696 void term_blink(Terminal
*, int set_cursor
);
697 void term_do_paste(Terminal
*);
698 int term_paste_pending(Terminal
*);
699 void term_paste(Terminal
*);
700 void term_nopaste(Terminal
*);
701 int term_ldisc(Terminal
*, int option
);
702 void term_copyall(Terminal
*);
703 void term_reconfig(Terminal
*, Config
*);
704 void term_seen_key_event(Terminal
*);
705 int term_data(Terminal
*, int is_stderr
, const char *data
, int len
);
706 void term_provide_resize_fn(Terminal
*term
,
707 void (*resize_fn
)(void *, int, int),
709 void term_provide_logctx(Terminal
*term
, void *logctx
);
710 void term_set_focus(Terminal
*term
, int has_focus
);
713 * Exports from logging.c.
715 void *log_init(void *frontend
, Config
*cfg
);
716 void log_free(void *logctx
);
717 void log_reconfig(void *logctx
, Config
*cfg
);
718 void logfopen(void *logctx
);
719 void logfclose(void *logctx
);
720 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
721 void logflush(void *logctx
);
722 void log_eventlog(void *logctx
, const char *string
);
723 enum { PKT_INCOMING
, PKT_OUTGOING
};
724 enum { PKTLOG_EMIT
, PKTLOG_BLANK
, PKTLOG_OMIT
};
730 void log_packet(void *logctx
, int direction
, int type
,
731 char *texttype
, void *data
, int len
,
732 int n_blanks
, const struct logblank_t
*blanks
);
735 * Exports from testback.c
738 extern Backend null_backend
;
739 extern Backend loop_backend
;
742 * Exports from raw.c.
745 extern Backend raw_backend
;
748 * Exports from rlogin.c.
751 extern Backend rlogin_backend
;
754 * Exports from telnet.c.
757 extern Backend telnet_backend
;
760 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
761 * so that PuTTYtel will still compile - otherwise it would depend
765 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
767 GLOBAL
int ssh_getline_pw_only
;
768 extern Backend ssh_backend
;
771 * Exports from ldisc.c.
773 void *ldisc_create(Config
*, Terminal
*, Backend
*, void *, void *);
774 void ldisc_free(void *);
775 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
778 * Exports from ldiscucs.c.
780 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
781 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
784 * Exports from sshrand.c.
787 void random_add_noise(void *noise
, int length
);
788 int random_byte(void);
789 void random_get_savedata(void **data
, int *len
);
790 extern int random_active
;
791 /* The random number subsystem is activated if at least one other entity
792 * within the program expresses an interest in it. So each SSH session
793 * calls random_ref on startup and random_unref on shutdown. */
794 void random_ref(void);
795 void random_unref(void);
798 * Exports from pinger.c.
800 typedef struct pinger_tag
*Pinger
;
801 Pinger
pinger_new(Config
*cfg
, Backend
*back
, void *backhandle
);
802 void pinger_reconfig(Pinger
, Config
*oldcfg
, Config
*newcfg
);
803 void pinger_free(Pinger
);
806 * Exports from misc.c.
812 * Exports from version.c.
817 * Exports from unicode.c.
820 #define CP_UTF8 65001
822 /* void init_ucs(void); -- this is now in platform-specific headers */
823 int is_dbcs_leadbyte(int codepage
, char byte
);
824 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
825 wchar_t *wcstr
, int wclen
);
826 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
827 char *mbstr
, int mblen
, char *defchr
, int *defused
,
828 struct unicode_data
*ucsdata
);
829 wchar_t xlat_uskbd2cyrllic(int ch
);
830 int check_compose(int first
, int second
);
831 int decode_codepage(char *cp_name
);
832 const char *cp_enumerate (int index
);
833 const char *cp_name(int codepage
);
834 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
837 * Exports from wcwidth.c
839 int wcwidth(wchar_t ucs
);
840 int wcswidth(const wchar_t *pwcs
, size_t n
);
843 * Exports from mscrypto.c
846 int crypto_startup();
847 void crypto_wrapup();
851 * Exports from pageantc.c.
853 * agent_query returns 1 for here's-a-response, and 0 for query-in-
854 * progress. In the latter case there will be a call to `callback'
855 * at some future point, passing callback_ctx as the first
856 * parameter and the actual reply data as the second and third.
858 * The response may be a NULL pointer (in either of the synchronous
859 * or asynchronous cases), which indicates failure to receive a
862 int agent_query(void *in
, int inlen
, void **out
, int *outlen
,
863 void (*callback
)(void *, void *, int), void *callback_ctx
);
864 int agent_exists(void);
867 * Exports from wildcard.c
869 const char *wc_error(int value
);
870 int wc_match(const char *wildcard
, const char *target
);
871 int wc_unescape(char *output
, const char *wildcard
);
874 * Exports from windlg.c
876 void logevent(void *frontend
, const char *);
877 void verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
878 char *keystr
, char *fingerprint
);
879 void askalg(void *frontend
, const char *algtype
, const char *algname
);
880 int askappend(void *frontend
, Filename filename
);
883 * Exports from console.c (that aren't equivalents to things in
886 extern int console_batch_mode
;
887 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
888 void console_provide_logctx(void *logctx
);
889 int is_interactive(void);
892 * Exports from printing.c.
894 typedef struct printer_enum_tag printer_enum
;
895 typedef struct printer_job_tag printer_job
;
896 printer_enum
*printer_start_enum(int *nprinters
);
897 char *printer_get_name(printer_enum
*, int);
898 void printer_finish_enum(printer_enum
*);
899 printer_job
*printer_start_job(char *printer
);
900 void printer_job_data(printer_job
*, void *, int);
901 void printer_finish_job(printer_job
*);
904 * Exports from cmdline.c (and also cmdline_error(), which is
905 * defined differently in various places and required _by_
908 int cmdline_process_param(char *, char *, int, Config
*);
909 void cmdline_run_saved(Config
*);
910 void cmdline_cleanup(void);
911 extern char *cmdline_password
;
912 #define TOOLTYPE_FILETRANSFER 1
913 #define TOOLTYPE_NONNETWORK 2
914 extern int cmdline_tooltype
;
916 void cmdline_error(char *, ...);
919 * Exports from config.c.
922 void setup_config_box(struct controlbox
*b
, struct sesslist
*sesslist
,
923 int midsession
, int protocol
);
926 * Exports from minibidi.c.
928 typedef struct bidi_char
{
930 unsigned short index
;
932 int do_bidi(bidi_char
*line
, int count
);
933 int do_shape(bidi_char
*line
, bidi_char
*to
, int count
);
936 * X11 auth mechanisms we know about.
940 X11_MIT
, /* MIT-MAGIC-COOKIE-1 */
941 X11_XDM
, /* XDM-AUTHORIZATION-1 */
944 extern const char *const x11_authnames
[]; /* declared in x11fwd.c */
947 * Miscellaneous exports from the platform-specific code.
949 Filename
filename_from_str(const char *string
);
950 const char *filename_to_str(const Filename
*fn
);
951 int filename_equal(Filename f1
, Filename f2
);
952 int filename_is_null(Filename fn
);
953 char *get_username(void); /* return value needs freeing */
954 char *get_random_data(int bytes
); /* used in cmdgen.c */
957 * Exports and imports from timing.c.
959 * schedule_timer() asks the front end to schedule a callback to a
960 * timer function in a given number of ticks. The returned value is
961 * the time (in ticks since an arbitrary offset) at which the
962 * callback can be expected. This value will also be passed as the
963 * `now' parameter to the callback function. Hence, you can (for
964 * example) schedule an event at a particular time by calling
965 * schedule_timer() and storing the return value in your context
966 * structure as the time when that event is due. The first time a
967 * callback function gives you that value or more as `now', you do
970 * expire_timer_context() drops all current timers associated with
971 * a given value of ctx (for when you're about to free ctx).
973 * run_timers() is called from the front end when it has reason to
974 * think some timers have reached their moment, or when it simply
975 * needs to know how long to wait next. We pass it the time we
976 * think it is. It returns TRUE and places the time when the next
977 * timer needs to go off in `next', or alternatively it returns
978 * FALSE if there are no timers at all pending.
980 * timer_change_notify() must be supplied by the front end; it
981 * notifies the front end that a new timer has been added to the
982 * list which is sooner than any existing ones. It provides the
983 * time when that timer needs to go off.
985 typedef void (*timer_fn_t
)(void *ctx
, long now
);
986 long schedule_timer(int ticks
, timer_fn_t fn
, void *ctx
);
987 void expire_timer_context(void *ctx
);
988 int run_timers(long now
, long *next
);
989 void timer_change_notify(long next
);