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 ciphers (both SSH1 and SSH2)
239 CIPHER_WARN, /* pseudo 'cipher' */
242 CIPHER_AES, /* (SSH 2 only) */
244 CIPHER_MAX /* no. ciphers (inc warn) */
249 * Several different bits of the PuTTY configuration seem to be
250 * three-way settings whose values are `always yes', `always
251 * no', and `decide by some more complex automated means'. This
252 * is true of line discipline options (local echo and line
253 * editing), proxy DNS, Close On Exit, and SSH server bug
254 * workarounds. Accordingly I supply a single enum here to deal
257 FORCE_ON, FORCE_OFF, AUTO
264 PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
265 PROXY_HTTP, PROXY_TELNET, PROXY_CMD
270 * Line discipline options which the backend might try to control.
272 LD_EDIT, /* local line editing */
273 LD_ECHO /* local echo */
277 /* Protocol back ends. (cfg.protocol) */
278 PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
282 /* Bell settings (cfg.beep) */
283 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
287 /* Taskbar flashing indication on bell (cfg.beep_ind) */
288 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
292 /* Resize actions (cfg.resize_action) */
293 RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
297 /* Function key types (cfg.funky_type) */
307 const char *(*init) (void *frontend_handle, void **backend_handle,
309 char *host, int port, char **realhost, int nodelay,
311 void (*free) (void *handle);
312 /* back->reconfig() passes in a replacement configuration. */
313 void (*reconfig) (void *handle, Config *cfg);
314 /* back->send() returns the current amount of buffered data. */
315 int (*send) (void *handle, char *buf, int len);
316 /* back->sendbuffer() does the same thing but without attempting a send */
317 int (*sendbuffer) (void *handle);
318 void (*size) (void *handle, int width, int height);
319 void (*special) (void *handle, Telnet_Special code);
320 const struct telnet_special *(*get_specials) (void *handle);
321 Socket(*socket) (void *handle);
322 int (*exitcode) (void *handle);
323 int (*sendok) (void *handle);
324 int (*ldisc) (void *handle, int);
325 void (*provide_ldisc) (void *handle, void *ldisc);
326 void (*provide_logctx) (void *handle, void *logctx);
328 * back->unthrottle() tells the back end that the front end
329 * buffer is clearing.
331 void (*unthrottle) (void *handle, int);
335 extern struct backend_list {
342 * Suggested default protocol provided by the backend link module.
343 * The application is free to ignore this.
345 extern const int be_default_protocol;
348 * Name of this particular application, for use in the config box
349 * and other pieces of text.
351 extern const char *const appname;
354 * IMPORTANT POLICY POINT: everything in this structure which wants
355 * to be treated like an integer must be an actual, honest-to-
356 * goodness `int'. No enum-typed variables. This is because parts
357 * of the code will want to pass around `int *' pointers to them
358 * and we can't run the risk of porting to some system on which the
359 * enum comes out as a different size from int.
368 int ping_interval; /* in seconds */
372 char proxy_exclude_list[512];
374 int even_proxy_localhost;
376 char proxy_host[512];
378 char proxy_username[128];
379 char proxy_password[128];
380 char proxy_telnet_command[512];
382 char remote_cmd[512];
383 char remote_cmd2[512]; /* fallback if the first fails
384 * (used internally for scp) */
385 char *remote_cmd_ptr; /* might point to a larger command
386 * but never for loading/saving */
387 char *remote_cmd_ptr2; /* might point to a larger command
388 * but never for loading/saving */
392 int change_username; /* allow username switching in SSH2 */
393 int ssh_cipherlist[CIPHER_MAX];
395 int sshprot; /* use v1 or v2 when both available */
396 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
399 int ssh_subsys; /* run a subsystem rather than a command */
400 int ssh_subsys2; /* fallback to go with remote_cmd2 */
401 int ssh_no_shell; /* avoid running a shell */
405 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
407 char localusername[100];
410 /* Keyboard options */
414 int no_applic_c; /* totally disable app cursor keys */
415 int no_applic_k; /* totally disable app keypad */
416 int no_mouse_rep; /* totally disable mouse reporting */
417 int no_remote_resize; /* disable remote resizing */
418 int no_alt_screen; /* disable alternate screen */
419 int no_remote_wintitle; /* disable remote retitling */
420 int no_dbackspace; /* disable destructive backspace */
421 int no_remote_charset; /* disable remote charset config */
422 int no_remote_qtitle; /* disable remote win title query */
428 int alt_f4; /* is it special? */
429 int alt_space; /* is it special? */
430 int alt_only; /* is it special? */
434 int fullscreenonaltenter;
437 int erase_to_scrollback;
440 char wintitle[256]; /* initial window title */
441 /* Terminal options */
446 int cursor_type; /* 0=block 1=underline 2=vertical */
450 int bellovl; /* bell overload protection active? */
451 int bellovl_n; /* number of bells to cause overload */
452 int bellovl_t; /* time interval for overload (seconds) */
453 int bellovl_s; /* period of silence to re-enable bell (s) */
454 Filename bell_wavefile;
456 int scrollbar_in_fullscreen;
463 Filename logfilename;
472 char answerback[256];
478 int xterm_256_colour;
482 unsigned char colours[22][3];
483 /* Selection options */
492 char line_codepage[128];
494 int xlat_capslockcyr;
497 char x11_display[128];
499 /* port forwarding */
500 int lport_acceptall; /* accept conns from hosts other than localhost */
501 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
503 * The port forwarding string contains a number of
504 * NUL-terminated substrings, terminated in turn by an empty
505 * string (i.e. a second NUL immediately after the previous
506 * one). Each string can be of one of the following forms:
508 * [LR]localport\thost:port
509 * [LR]localaddr:localport\thost:port
511 * Dlocaladdr:localport
514 /* SSH bug compatibility modes */
515 int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
516 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
517 sshbug_dhgex2, sshbug_pksessid2;
518 /* Options for pterm. Should split out into platform-dependent part. */
521 int scrollbar_on_left;
525 FontSpec wideboldfont;
526 int shadowboldoffset;
530 * Some global flags denoting the type of application.
532 * FLAG_VERBOSE is set when the user requests verbose details.
534 * FLAG_STDERR is set in command-line applications (which have a
535 * functioning stderr that it makes sense to write to) and not in
536 * GUI applications (which don't).
538 * FLAG_INTERACTIVE is set when a full interactive shell session is
539 * being run, _either_ because no remote command has been provided
540 * _or_ because the application is GUI and can't run non-
543 * These flags describe the type of _application_ - they wouldn't
544 * vary between individual sessions - and so it's OK to have this
545 * variable be GLOBAL.
547 * Note that additional flags may be defined in platform-specific
548 * headers. It's probably best if those ones start from 0x1000, to
551 #define FLAG_VERBOSE 0x0001
552 #define FLAG_STDERR 0x0002
553 #define FLAG_INTERACTIVE 0x0004
557 * Likewise, these two variables are set up when the application
558 * initialises, and inform all default-settings accesses after
561 GLOBAL int default_protocol;
562 GLOBAL int default_port;
565 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
567 GLOBAL int loaded_session;
569 struct RSAKey; /* be a little careful of scope */
572 * Exports from window.c.
574 void request_resize(void *frontend, int, int);
575 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
576 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
577 int char_width(Context ctx, int uc);
578 #ifdef OPTIMISE_SCROLL
579 void do_scroll(Context, int, int, int);
581 void set_title(void *frontend, char *);
582 void set_icon(void *frontend, char *);
583 void set_sbar(void *frontend, int, int, int);
584 Context get_ctx(void *frontend);
585 void free_ctx(Context);
586 void palette_set(void *frontend, int, int, int, int);
587 void palette_reset(void *frontend);
588 void write_aclip(void *frontend, char *, int, int);
589 void write_clip(void *frontend, wchar_t *, int, int);
590 void get_clip(void *frontend, wchar_t **, int *);
591 void optimised_move(void *frontend, int, int, int);
592 void set_raw_mouse_mode(void *frontend, int);
593 void connection_fatal(void *frontend, char *, ...);
594 void fatalbox(char *, ...);
595 void modalfatalbox(char *, ...);
597 #pragma noreturn(fatalbox)
598 #pragma noreturn(modalfatalbox)
600 void beep(void *frontend, int);
601 void begin_session(void *frontend);
602 void sys_cursor(void *frontend, int x, int y);
603 void request_paste(void *frontend);
604 void frontend_keypress(void *frontend);
605 void ldisc_update(void *frontend, int echo, int edit);
606 /* It's the backend's responsibility to invoke this at the start of a
607 * connection, if necessary; it can also invoke it later if the set of
608 * special commands changes. It does not need to invoke it at session
610 void update_specials_menu(void *frontend);
611 int from_backend(void *frontend, int is_stderr, const char *data, int len);
612 void notify_remote_exit(void *frontend);
613 #define OPTIMISE_IS_SCROLL 1
615 void set_iconic(void *frontend, int iconic);
616 void move_window(void *frontend, int x, int y);
617 void set_zorder(void *frontend, int top);
618 void refresh_window(void *frontend);
619 void set_zoomed(void *frontend, int zoomed);
620 int is_iconic(void *frontend);
621 void get_window_pos(void *frontend, int *x, int *y);
622 void get_window_pixels(void *frontend, int *x, int *y);
623 char *get_window_title(void *frontend, int icon);
625 void cleanup_exit(int);
628 * Exports from noise.c.
630 void noise_get_heavy(void (*func) (void *, int));
631 void noise_get_light(void (*func) (void *, int));
632 void noise_regular(void);
633 void noise_ultralight(unsigned long data);
634 void random_save_seed(void);
635 void random_destroy_seed(void);
638 * Exports from settings.c.
640 char *save_settings(char *section, int do_host, Config * cfg);
641 void save_open_settings(void *sesskey, int do_host, Config *cfg);
642 void load_settings(char *section, int do_host, Config * cfg);
643 void load_open_settings(void *sesskey, int do_host, Config *cfg);
644 void get_sesslist(struct sesslist *, int allocate);
645 void do_defaults(char *, Config *);
646 void registry_cleanup(void);
649 * Functions used by settings.c to provide platform-specific
652 * (The integer one is expected to return `def' if it has no clear
653 * opinion of its own. This is because there's no integer value
654 * which I can reliably set aside to indicate `nil'. The string
655 * function is perfectly all right returning NULL, of course. The
656 * Filename and FontSpec functions are _not allowed_ to fail to
657 * return, since these defaults _must_ be per-platform.)
659 char *platform_default_s(const char *name);
660 int platform_default_i(const char *name, int def);
661 Filename platform_default_filename(const char *name);
662 FontSpec platform_default_fontspec(const char *name);
665 * Exports from terminal.c.
668 Terminal *term_init(Config *, struct unicode_data *, void *);
669 void term_free(Terminal *);
670 void term_size(Terminal *, int, int, int);
671 void term_paint(Terminal *, Context, int, int, int, int, int);
672 void term_scroll(Terminal *, int, int);
673 void term_pwron(Terminal *);
674 void term_clrsb(Terminal *);
675 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
676 int,int,int,int,int);
677 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
679 void term_deselect(Terminal *);
680 void term_update(Terminal *);
681 void term_invalidate(Terminal *);
682 void term_blink(Terminal *, int set_cursor);
683 void term_do_paste(Terminal *);
684 int term_paste_pending(Terminal *);
685 void term_paste(Terminal *);
686 void term_nopaste(Terminal *);
687 int term_ldisc(Terminal *, int option);
688 void term_copyall(Terminal *);
689 void term_reconfig(Terminal *, Config *);
690 void term_seen_key_event(Terminal *);
691 int term_data(Terminal *, int is_stderr, const char *data, int len);
692 void term_provide_resize_fn(Terminal *term,
693 void (*resize_fn)(void *, int, int),
695 void term_provide_logctx(Terminal *term, void *logctx);
696 void term_set_focus(Terminal *term, int has_focus);
699 * Exports from logging.c.
701 void *log_init(void *frontend, Config *cfg);
702 void log_free(void *logctx);
703 void log_reconfig(void *logctx, Config *cfg);
704 void logfopen(void *logctx);
705 void logfclose(void *logctx);
706 void logtraffic(void *logctx, unsigned char c, int logmode);
707 void logflush(void *logctx);
708 void log_eventlog(void *logctx, const char *string);
709 enum { PKT_INCOMING, PKT_OUTGOING };
710 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
716 void log_packet(void *logctx, int direction, int type,
717 char *texttype, void *data, int len,
718 int n_blanks, const struct logblank_t *blanks);
721 * Exports from testback.c
724 extern Backend null_backend;
725 extern Backend loop_backend;
728 * Exports from raw.c.
731 extern Backend raw_backend;
734 * Exports from rlogin.c.
737 extern Backend rlogin_backend;
740 * Exports from telnet.c.
743 extern Backend telnet_backend;
746 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
747 * so that PuTTYtel will still compile - otherwise it would depend
751 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
753 GLOBAL int ssh_getline_pw_only;
754 extern Backend ssh_backend;
757 * Exports from ldisc.c.
759 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
760 void ldisc_free(void *);
761 void ldisc_send(void *handle, char *buf, int len, int interactive);
764 * Exports from ldiscucs.c.
766 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
767 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
770 * Exports from sshrand.c.
773 void random_add_noise(void *noise, int length);
774 int random_byte(void);
775 void random_get_savedata(void **data, int *len);
776 extern int random_active;
777 /* The random number subsystem is activated if at least one other entity
778 * within the program expresses an interest in it. So each SSH session
779 * calls random_ref on startup and random_unref on shutdown. */
780 void random_ref(void);
781 void random_unref(void);
784 * Exports from pinger.c.
786 typedef struct pinger_tag *Pinger;
787 Pinger pinger_new(Config *cfg, Backend *back, void *backhandle);
788 void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg);
789 void pinger_free(Pinger);
792 * Exports from misc.c.
798 * Exports from version.c.
803 * Exports from unicode.c.
806 #define CP_UTF8 65001
808 /* void init_ucs(void); -- this is now in platform-specific headers */
809 int is_dbcs_leadbyte(int codepage, char byte);
810 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
811 wchar_t *wcstr, int wclen);
812 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
813 char *mbstr, int mblen, char *defchr, int *defused,
814 struct unicode_data *ucsdata);
815 wchar_t xlat_uskbd2cyrllic(int ch);
816 int check_compose(int first, int second);
817 int decode_codepage(char *cp_name);
818 const char *cp_enumerate (int index);
819 const char *cp_name(int codepage);
820 void get_unitab(int codepage, wchar_t * unitab, int ftype);
823 * Exports from wcwidth.c
825 int wcwidth(wchar_t ucs);
826 int wcswidth(const wchar_t *pwcs, size_t n);
829 * Exports from mscrypto.c
832 int crypto_startup();
833 void crypto_wrapup();
837 * Exports from pageantc.c.
839 * agent_query returns 1 for here's-a-response, and 0 for query-in-
840 * progress. In the latter case there will be a call to `callback'
841 * at some future point, passing callback_ctx as the first
842 * parameter and the actual reply data as the second and third.
844 * The response may be a NULL pointer (in either of the synchronous
845 * or asynchronous cases), which indicates failure to receive a
848 int agent_query(void *in, int inlen, void **out, int *outlen,
849 void (*callback)(void *, void *, int), void *callback_ctx);
850 int agent_exists(void);
853 * Exports from wildcard.c
855 const char *wc_error(int value);
856 int wc_match(const char *wildcard, const char *target);
857 int wc_unescape(char *output, const char *wildcard);
860 * Exports from windlg.c
862 void logevent(void *frontend, const char *);
863 void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
864 char *keystr, char *fingerprint);
865 void askcipher(void *frontend, char *ciphername, int cs);
866 int askappend(void *frontend, Filename filename);
869 * Exports from console.c (that aren't equivalents to things in
872 extern int console_batch_mode;
873 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
874 void console_provide_logctx(void *logctx);
875 int is_interactive(void);
878 * Exports from printing.c.
880 typedef struct printer_enum_tag printer_enum;
881 typedef struct printer_job_tag printer_job;
882 printer_enum *printer_start_enum(int *nprinters);
883 char *printer_get_name(printer_enum *, int);
884 void printer_finish_enum(printer_enum *);
885 printer_job *printer_start_job(char *printer);
886 void printer_job_data(printer_job *, void *, int);
887 void printer_finish_job(printer_job *);
890 * Exports from cmdline.c (and also cmdline_error(), which is
891 * defined differently in various places and required _by_
894 int cmdline_process_param(char *, char *, int, Config *);
895 void cmdline_run_saved(Config *);
896 void cmdline_cleanup(void);
897 extern char *cmdline_password;
898 #define TOOLTYPE_FILETRANSFER 1
899 #define TOOLTYPE_NONNETWORK 2
900 extern int cmdline_tooltype;
902 void cmdline_error(char *, ...);
905 * Exports from config.c.
908 void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
909 int midsession, int protocol);
912 * Exports from minibidi.c.
914 typedef struct bidi_char {
916 unsigned short index;
918 int do_bidi(bidi_char *line, int count);
919 int do_shape(bidi_char *line, bidi_char *to, int count);
922 * X11 auth mechanisms we know about.
926 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
927 X11_XDM, /* XDM-AUTHORIZATION-1 */
930 extern const char *const x11_authnames[]; /* declared in x11fwd.c */
933 * Miscellaneous exports from the platform-specific code.
935 Filename filename_from_str(const char *string);
936 const char *filename_to_str(const Filename *fn);
937 int filename_equal(Filename f1, Filename f2);
938 int filename_is_null(Filename fn);
939 char *get_username(void); /* return value needs freeing */
940 char *get_random_data(int bytes); /* used in cmdgen.c */
943 * Exports and imports from timing.c.
945 * schedule_timer() asks the front end to schedule a callback to a
946 * timer function in a given number of ticks. The returned value is
947 * the time (in ticks since an arbitrary offset) at which the
948 * callback can be expected. This value will also be passed as the
949 * `now' parameter to the callback function. Hence, you can (for
950 * example) schedule an event at a particular time by calling
951 * schedule_timer() and storing the return value in your context
952 * structure as the time when that event is due. The first time a
953 * callback function gives you that value or more as `now', you do
956 * expire_timer_context() drops all current timers associated with
957 * a given value of ctx (for when you're about to free ctx).
959 * run_timers() is called from the front end when it has reason to
960 * think some timers have reached their moment, or when it simply
961 * needs to know how long to wait next. We pass it the time we
962 * think it is. It returns TRUE and places the time when the next
963 * timer needs to go off in `next', or alternatively it returns
964 * FALSE if there are no timers at all pending.
966 * timer_change_notify() must be supplied by the front end; it
967 * notifies the front end that a new timer has been added to the
968 * list which is sooner than any existing ones. It provides the
969 * time when that timer needs to go off.
971 typedef void (*timer_fn_t)(void *ctx, long now);
972 long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
973 void expire_timer_context(void *ctx);
974 int run_timers(long now, long *next);
975 void timer_change_notify(long next);