source: filezilla/trunk/fuentes/src/putty/putty.h @ 3185

Last change on this file since 3185 was 3185, checked in by jrpelegrina, 2 years ago

Update new version: 3.15.02

File size: 53.3 KB
Line 
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 conf_tag Conf;
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/*
31 * Fingerprints of the PGP master keys that can be used to establish a trust
32 * path between an executable and other files.
33 */
34#define PGP_MASTER_KEY_FP \
35    "440D E3B5 B7A1 CA85 B3CC  1718 AB58 5DC6 0467 6F7C"
36#define PGP_RSA_MASTER_KEY_FP \
37    "8F 15 97 DA 25 30 AB 0D  88 D1 92 54 11 CF 0C 4C"
38#define PGP_DSA_MASTER_KEY_FP \
39    "313C 3E76 4B74 C2C5 F2AE  83A8 4F5E 6DF5 6A93 B34E"
40
41/* Three attribute types:
42 * The ATTRs (normal attributes) are stored with the characters in
43 * the main display arrays
44 *
45 * The TATTRs (temporary attributes) are generated on the fly, they
46 * can overlap with characters but not with normal attributes.
47 *
48 * The LATTRs (line attributes) are an entirely disjoint space of
49 * flags.
50 *
51 * The DATTRs (display attributes) are internal to terminal.c (but
52 * defined here because their values have to match the others
53 * here); they reuse the TATTR_* space but are always masked off
54 * before sending to the front end.
55 *
56 * ATTR_INVALID is an illegal colour combination.
57 */
58
59#define TATTR_ACTCURS       0x40000000UL      /* active cursor (block) */
60#define TATTR_PASCURS       0x20000000UL      /* passive cursor (box) */
61#define TATTR_RIGHTCURS     0x10000000UL      /* cursor-on-RHS */
62#define TATTR_COMBINING     0x80000000UL      /* combining characters */
63
64#define DATTR_STARTRUN      0x80000000UL   /* start of redraw run */
65
66#define TDATTR_MASK         0xF0000000UL
67#define TATTR_MASK (TDATTR_MASK)
68#define DATTR_MASK (TDATTR_MASK)
69
70#define LATTR_NORM   0x00000000UL
71#define LATTR_WIDE   0x00000001UL
72#define LATTR_TOP    0x00000002UL
73#define LATTR_BOT    0x00000003UL
74#define LATTR_MODE   0x00000003UL
75#define LATTR_WRAPPED 0x00000010UL     /* this line wraps to next */
76#define LATTR_WRAPPED2 0x00000020UL    /* with WRAPPED: CJK wide character
77                                          wrapped to next line, so last
78                                          single-width cell is empty */
79
80#define ATTR_INVALID 0x03FFFFU
81
82/* Like Linux use the F000 page for direct to font. */
83#define CSET_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
84#define CSET_ACP     0x0000F100UL      /* Ansi Codepage DTF */
85
86/* These are internal use overlapping with the UTF-16 surrogates */
87#define CSET_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
88#define CSET_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
89#define CSET_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
90#define CSET_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
91#define CSET_MASK    0xFFFFFF00UL      /* Character set mask */
92
93#define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
94#define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
95
96#define UCSERR       (CSET_LINEDRW|'a') /* UCS Format error character. */
97/*
98 * UCSWIDE is a special value used in the terminal data to signify
99 * the character cell containing the right-hand half of a CJK wide
100 * character. We use 0xDFFF because it's part of the surrogate
101 * range and hence won't be used for anything else (it's impossible
102 * to input it via UTF-8 because our UTF-8 decoder correctly
103 * rejects surrogates).
104 */
105#define UCSWIDE      0xDFFF
106
107#define ATTR_NARROW  0x800000U
108#define ATTR_WIDE    0x400000U
109#define ATTR_BOLD    0x040000U
110#define ATTR_UNDER   0x080000U
111#define ATTR_REVERSE 0x100000U
112#define ATTR_BLINK   0x200000U
113#define ATTR_FGMASK  0x0001FFU
114#define ATTR_BGMASK  0x03FE00U
115#define ATTR_COLOURS 0x03FFFFU
116#define ATTR_FGSHIFT 0
117#define ATTR_BGSHIFT 9
118
119/*
120 * The definitive list of colour numbers stored in terminal
121 * attribute words is kept here. It is:
122 *
123 *  - 0-7 are ANSI colours (KRGYBMCW).
124 *  - 8-15 are the bold versions of those colours.
125 *  - 16-255 are the remains of the xterm 256-colour mode (a
126 *    216-colour cube with R at most significant and B at least,
127 *    followed by a uniform series of grey shades running between
128 *    black and white but not including either on grounds of
129 *    redundancy).
130 *  - 256 is default foreground
131 *  - 257 is default bold foreground
132 *  - 258 is default background
133 *  - 259 is default bold background
134 *  - 260 is cursor foreground
135 *  - 261 is cursor background
136 */
137
138#define ATTR_DEFFG   (256 << ATTR_FGSHIFT)
139#define ATTR_DEFBG   (258 << ATTR_BGSHIFT)
140#define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
141
142struct sesslist {
143    int nsessions;
144    const char **sessions;
145    char *buffer;                      /* so memory can be freed later */
146};
147
148struct unicode_data {
149    char **uni_tbl;
150    int dbcs_screenfont;
151    int font_codepage;
152    int line_codepage;
153    wchar_t unitab_scoacs[256];
154    wchar_t unitab_line[256];
155    wchar_t unitab_font[256];
156    wchar_t unitab_xterm[256];
157    wchar_t unitab_oemcp[256];
158    unsigned char unitab_ctrl[256];
159};
160
161#define LGXF_OVR  1                    /* existing logfile overwrite */
162#define LGXF_APN  0                    /* existing logfile append */
163#define LGXF_ASK -1                    /* existing logfile ask */
164#define LGTYP_NONE  0                  /* logmode: no logging */
165#define LGTYP_ASCII 1                  /* logmode: pure ascii */
166#define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
167#define LGTYP_PACKETS 3                /* logmode: SSH data packets */
168#define LGTYP_SSHRAW 4                 /* logmode: SSH raw data */
169
170typedef enum {
171    /* Actual special commands. Originally Telnet, but some codes have
172     * been re-used for similar specials in other protocols. */
173    TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
174    TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
175    TS_EOL,
176    /* Special command for SSH. */
177    TS_REKEY,
178    /* POSIX-style signals. (not Telnet) */
179    TS_SIGABRT, TS_SIGALRM, TS_SIGFPE,  TS_SIGHUP,  TS_SIGILL,
180    TS_SIGINT,  TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV,
181    TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2,
182    /* Pseudo-specials used for constructing the specials menu. */
183    TS_SEP,         /* Separator */
184    TS_SUBMENU,     /* Start a new submenu with specified name */
185    TS_EXITMENU     /* Exit current submenu or end of specials */
186} Telnet_Special;
187
188struct telnet_special {
189    const char *name;
190    int code;
191};
192
193typedef enum {
194    MBT_NOTHING,
195    MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
196    MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
197    MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
198} Mouse_Button;
199
200typedef enum {
201    MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
202} Mouse_Action;
203
204/* Keyboard modifiers -- keys the user is actually holding down */
205
206#define PKM_SHIFT       0x01
207#define PKM_CONTROL     0x02
208#define PKM_META        0x04
209#define PKM_ALT         0x08
210
211/* Keyboard flags that aren't really modifiers */
212#define PKF_CAPSLOCK    0x10
213#define PKF_NUMLOCK     0x20
214#define PKF_REPEAT      0x40
215
216/* Stand-alone keysyms for function keys */
217
218typedef enum {
219    PK_NULL,            /* No symbol for this key */
220    /* Main keypad keys */
221    PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
222    /* Editing keys */
223    PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
224    /* Cursor keys */
225    PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
226    /* Numeric keypad */                        /* Real one looks like: */
227    PK_PF1, PK_PF2, PK_PF3, PK_PF4,             /* PF1 PF2 PF3 PF4 */
228    PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL,       /*  7   8   9   -  */
229    PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4,     /*  4   5   6   ,  */
230    PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9,     /*  1   2   3  en- */
231    PK_KPBIGPLUS, PK_KPENTER,                   /*    0     .  ter */
232    /* Top row */
233    PK_F1,  PK_F2,  PK_F3,  PK_F4,  PK_F5,
234    PK_F6,  PK_F7,  PK_F8,  PK_F9,  PK_F10,
235    PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
236    PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
237    PK_PAUSE
238} Key_Sym;
239
240#define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
241#define PK_ISCURSOR(k)  ((k) >= PK_UP && (k) <= PK_REST)
242#define PK_ISKEYPAD(k)  ((k) >= PK_PF1 && (k) <= PK_KPENTER)
243#define PK_ISFKEY(k)    ((k) >= PK_F1 && (k) <= PK_F20)
244
245enum {
246    VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
247};
248
249enum {
250    /*
251     * SSH-2 key exchange algorithms
252     */
253    KEX_WARN,
254    KEX_DHGROUP1,
255    KEX_DHGROUP14,
256    KEX_DHGEX,
257    KEX_RSA,
258    KEX_ECDH,
259    KEX_MAX
260};
261
262enum {
263    /*
264     * SSH ciphers (both SSH-1 and SSH-2)
265     */
266    CIPHER_WARN,                       /* pseudo 'cipher' */
267    CIPHER_3DES,
268    CIPHER_BLOWFISH,
269    CIPHER_AES,                        /* (SSH-2 only) */
270    CIPHER_DES,
271    CIPHER_ARCFOUR,
272    CIPHER_CHACHA20,
273    CIPHER_MAX                         /* no. ciphers (inc warn) */
274};
275
276enum {
277    /*
278     * Several different bits of the PuTTY configuration seem to be
279     * three-way settings whose values are `always yes', `always
280     * no', and `decide by some more complex automated means'. This
281     * is true of line discipline options (local echo and line
282     * editing), proxy DNS, proxy terminal logging, Close On Exit, and
283     * SSH server bug workarounds. Accordingly I supply a single enum
284     * here to deal with them all.
285     */
286    FORCE_ON, FORCE_OFF, AUTO
287};
288
289enum {
290    /*
291     * Proxy types.
292     */
293    PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
294    PROXY_HTTP, PROXY_TELNET, PROXY_CMD, PROXY_FUZZ
295};
296
297enum {
298    /*
299     * Line discipline options which the backend might try to control.
300     */
301    LD_EDIT,                           /* local line editing */
302    LD_ECHO                            /* local echo */
303};
304
305enum {
306    /* Actions on remote window title query */
307    TITLE_NONE, TITLE_EMPTY, TITLE_REAL
308};
309
310enum {
311    /* Protocol back ends. (CONF_protocol) */
312    PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH,
313    /* PROT_SERIAL is supported on a subset of platforms, but it doesn't
314     * hurt to define it globally. */
315    PROT_SERIAL
316};
317
318enum {
319    /* Bell settings (CONF_beep) */
320    BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
321};
322
323enum {
324    /* Taskbar flashing indication on bell (CONF_beep_ind) */
325    B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
326};
327
328enum {
329    /* Resize actions (CONF_resize_action) */
330    RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
331};
332
333enum {
334    /* Function key types (CONF_funky_type) */
335    FUNKY_TILDE,
336    FUNKY_LINUX,
337    FUNKY_XTERM,
338    FUNKY_VT400,
339    FUNKY_VT100P,
340    FUNKY_SCO
341};
342
343enum {
344    FQ_DEFAULT, FQ_ANTIALIASED, FQ_NONANTIALIASED, FQ_CLEARTYPE
345};
346
347enum {
348    SER_PAR_NONE, SER_PAR_ODD, SER_PAR_EVEN, SER_PAR_MARK, SER_PAR_SPACE
349};
350
351enum {
352    SER_FLOW_NONE, SER_FLOW_XONXOFF, SER_FLOW_RTSCTS, SER_FLOW_DSRDTR
353};
354
355/*
356 * Tables of string <-> enum value mappings used in settings.c.
357 * Defined here so that backends can export their GSS library tables
358 * to the cross-platform settings code.
359 */
360struct keyvalwhere {
361    /*
362     * Two fields which define a string and enum value to be
363     * equivalent to each other.
364     */
365    const char *s;
366    int v;
367
368    /*
369     * The next pair of fields are used by gprefs() in settings.c to
370     * arrange that when it reads a list of strings representing a
371     * preference list and translates it into the corresponding list
372     * of integers, strings not appearing in the list are entered in a
373     * configurable position rather than uniformly at the end.
374     */
375
376    /*
377     * 'vrel' indicates which other value in the list to place this
378     * element relative to. It should be a value that has occurred in
379     * a 'v' field of some other element of the array, or -1 to
380     * indicate that we simply place relative to one or other end of
381     * the list.
382     *
383     * gprefs will try to process the elements in an order which makes
384     * this field work (i.e. so that the element referenced has been
385     * added before processing this one).
386     */
387    int vrel;
388
389    /*
390     * 'where' indicates whether to place the new value before or
391     * after the one referred to by vrel. -1 means before; +1 means
392     * after.
393     *
394     * When vrel is -1, this also implicitly indicates which end of
395     * the array to use. So vrel=-1, where=-1 means to place _before_
396     * some end of the list (hence, at the last element); vrel=-1,
397     * where=+1 means to place _after_ an end (hence, at the first).
398     */
399    int where;
400};
401
402#ifndef NO_GSSAPI
403extern const int ngsslibs;
404extern const char *const gsslibnames[]; /* for displaying in configuration */
405extern const struct keyvalwhere gsslibkeywords[]; /* for settings.c */
406#endif
407
408extern const char *const ttymodes[];
409
410enum {
411    /*
412     * Network address types. Used for specifying choice of IPv4/v6
413     * in config; also used in proxy.c to indicate whether a given
414     * host name has already been resolved or will be resolved at
415     * the proxy end.
416     */
417    ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME
418};
419
420struct backend_tag {
421    const char *(*init) (void *frontend_handle, void **backend_handle,
422                         Conf *conf, const char *host, int port,
423                         char **realhost, int nodelay, int keepalive);
424    void (*free) (void *handle);
425    /* back->reconfig() passes in a replacement configuration. */
426    void (*reconfig) (void *handle, Conf *conf);
427    /* back->send() returns the current amount of buffered data. */
428    int (*send) (void *handle, const char *buf, int len);
429    /* back->sendbuffer() does the same thing but without attempting a send */
430    int (*sendbuffer) (void *handle);
431    void (*size) (void *handle, int width, int height);
432    void (*special) (void *handle, Telnet_Special code);
433    const struct telnet_special *(*get_specials) (void *handle);
434    int (*connected) (void *handle);
435    int (*exitcode) (void *handle);
436    /* If back->sendok() returns FALSE, data sent to it from the frontend
437     * may be lost. */
438    int (*sendok) (void *handle);
439    int (*ldisc) (void *handle, int);
440    void (*provide_ldisc) (void *handle, void *ldisc);
441    void (*provide_logctx) (void *handle, void *logctx);
442    /*
443     * back->unthrottle() tells the back end that the front end
444     * buffer is clearing.
445     */
446    void (*unthrottle) (void *handle, int);
447    int (*cfg_info) (void *handle);
448    /* Only implemented in the SSH protocol: check whether a
449     * connection-sharing upstream exists for a given configuration. */
450    int (*test_for_upstream)(const char *host, int port, Conf *conf);
451    const char *name;
452    int protocol;
453    int default_port;
454};
455
456extern Backend *backends[];
457
458/*
459 * Suggested default protocol provided by the backend link module.
460 * The application is free to ignore this.
461 */
462extern const int be_default_protocol;
463
464/*
465 * Name of this particular application, for use in the config box
466 * and other pieces of text.
467 */
468extern const char *const appname;
469
470/*
471 * Some global flags denoting the type of application.
472 *
473 * FLAG_VERBOSE is set when the user requests verbose details.
474 *
475 * FLAG_STDERR is set in command-line applications (which have a
476 * functioning stderr that it makes sense to write to) and not in
477 * GUI applications (which don't).
478 *
479 * FLAG_INTERACTIVE is set when a full interactive shell session is
480 * being run, _either_ because no remote command has been provided
481 * _or_ because the application is GUI and can't run non-
482 * interactively.
483 *
484 * These flags describe the type of _application_ - they wouldn't
485 * vary between individual sessions - and so it's OK to have this
486 * variable be GLOBAL.
487 *
488 * Note that additional flags may be defined in platform-specific
489 * headers. It's probably best if those ones start from 0x1000, to
490 * avoid collision.
491 */
492#define FLAG_VERBOSE     0x0001
493#define FLAG_STDERR      0x0002
494#define FLAG_INTERACTIVE 0x0004
495GLOBAL int flags;
496
497/*
498 * Likewise, these two variables are set up when the application
499 * initialises, and inform all default-settings accesses after
500 * that.
501 */
502GLOBAL int default_protocol;
503GLOBAL int default_port;
504
505/*
506 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
507 */
508GLOBAL int loaded_session;
509/*
510 * This is set to the name of the loaded session.
511 */
512GLOBAL char *cmdline_session_name;
513
514struct RSAKey;                         /* be a little careful of scope */
515
516/*
517 * Mechanism for getting text strings such as usernames and passwords
518 * from the front-end.
519 * The fields are mostly modelled after SSH's keyboard-interactive auth.
520 * FIXME We should probably mandate a character set/encoding (probably UTF-8).
521 *
522 * Since many of the pieces of text involved may be chosen by the server,
523 * the caller must take care to ensure that the server can't spoof locally-
524 * generated prompts such as key passphrase prompts. Some ground rules:
525 *  - If the front-end needs to truncate a string, it should lop off the
526 *    end.
527 *  - The front-end should filter out any dangerous characters and
528 *    generally not trust the strings. (But \n is required to behave
529 *    vaguely sensibly, at least in `instruction', and ideally in
530 *    `prompt[]' too.)
531 */
532typedef struct {
533    char *prompt;
534    int echo;
535    /*
536     * 'result' must be a dynamically allocated array of exactly
537     * 'resultsize' chars. The code for actually reading input may
538     * realloc it bigger (and adjust resultsize accordingly) if it has
539     * to. The caller should free it again when finished with it.
540     *
541     * If resultsize==0, then result may be NULL. When setting up a
542     * prompt_t, it's therefore easiest to initialise them this way,
543     * which means all actual allocation is done by the callee. This
544     * is what add_prompt does.
545     */
546    char *result;
547    size_t resultsize;
548} prompt_t;
549typedef struct {
550    /*
551     * Indicates whether the information entered is to be used locally
552     * (for instance a key passphrase prompt), or is destined for the wire.
553     * This is a hint only; the front-end is at liberty not to use this
554     * information (so the caller should ensure that the supplied text is
555     * sufficient).
556     */
557    int to_server;
558    char *name;         /* Short description, perhaps for dialog box title */
559    int name_reqd;      /* Display of `name' required or optional? */
560    char *instruction;  /* Long description, maybe with embedded newlines */
561    int instr_reqd;     /* Display of `instruction' required or optional? */
562    size_t n_prompts;   /* May be zero (in which case display the foregoing,
563                         * if any, and return success) */
564    prompt_t **prompts;
565    void *frontend;
566    void *data;         /* slot for housekeeping data, managed by
567                         * get_userpass_input(); initially NULL */
568} prompts_t;
569prompts_t *new_prompts(void *frontend);
570void add_prompt(prompts_t *p, char *promptstr, int echo);
571void prompt_set_result(prompt_t *pr, const char *newstr);
572void prompt_ensure_result_size(prompt_t *pr, int len);
573/* Burn the evidence. (Assumes _all_ strings want free()ing.) */
574void free_prompts(prompts_t *p);
575
576/*
577 * Exports from the front end.
578 */
579void request_resize(void *frontend, int, int);
580void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
581void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
582int char_width(Context ctx, int uc);
583#ifdef OPTIMISE_SCROLL
584void do_scroll(Context, int, int, int);
585#endif
586void set_title(void *frontend, char *);
587void set_icon(void *frontend, char *);
588void set_sbar(void *frontend, int, int, int);
589Context get_ctx(void *frontend);
590void free_ctx(Context);
591void palette_set(void *frontend, int, int, int, int);
592void palette_reset(void *frontend);
593void write_aclip(void *frontend, char *, int, int);
594void write_clip(void *frontend, wchar_t *, int *, int, int);
595void get_clip(void *frontend, wchar_t **, int *);
596void optimised_move(void *frontend, int, int, int);
597void set_raw_mouse_mode(void *frontend, int);
598void connection_fatal(void *frontend, const char *, ...);
599void nonfatal(const char *, ...);
600void fatalbox(const char *, ...);
601void modalfatalbox(const char *, ...);
602#ifdef macintosh
603#pragma noreturn(fatalbox)
604#pragma noreturn(modalfatalbox)
605#endif
606void do_beep(void *frontend, int);
607void begin_session(void *frontend);
608void sys_cursor(void *frontend, int x, int y);
609void request_paste(void *frontend);
610void frontend_keypress(void *frontend);
611void frontend_echoedit_update(void *frontend, int echo, int edit);
612/* It's the backend's responsibility to invoke this at the start of a
613 * connection, if necessary; it can also invoke it later if the set of
614 * special commands changes. It does not need to invoke it at session
615 * shutdown. */
616void update_specials_menu(void *frontend);
617int from_backend(void *frontend, int is_stderr, const char *data, int len);
618int from_backend_untrusted(void *frontend, const char *data, int len);
619/* Called when the back end wants to indicate that EOF has arrived on
620 * the server-to-client stream. Returns FALSE to indicate that we
621 * intend to keep the session open in the other direction, or TRUE to
622 * indicate that if they're closing so are we. */
623int from_backend_eof(void *frontend);
624void notify_remote_exit(void *frontend);
625/* Get a sensible value for a tty mode. NULL return = don't set.
626 * Otherwise, returned value should be freed by caller. */
627char *get_ttymode(void *frontend, const char *mode);
628/*
629 * >0 = `got all results, carry on'
630 * 0  = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?)
631 * <0 = `please call back later with more in/inlen'
632 */
633int get_userpass_input(prompts_t *p, const unsigned char *in, int inlen);
634#define OPTIMISE_IS_SCROLL 1
635
636void set_iconic(void *frontend, int iconic);
637void move_window(void *frontend, int x, int y);
638void set_zorder(void *frontend, int top);
639void refresh_window(void *frontend);
640void set_zoomed(void *frontend, int zoomed);
641int is_iconic(void *frontend);
642void get_window_pos(void *frontend, int *x, int *y);
643void get_window_pixels(void *frontend, int *x, int *y);
644char *get_window_title(void *frontend, int icon);
645/* Hint from backend to frontend about time-consuming operations.
646 * Initial state is assumed to be BUSY_NOT. */
647enum {
648    BUSY_NOT,       /* Not busy, all user interaction OK */
649    BUSY_WAITING,   /* Waiting for something; local event loops still running
650                       so some local interaction (e.g. menus) OK, but network
651                       stuff is suspended */
652    BUSY_CPU        /* Locally busy (e.g. crypto); user interaction suspended */
653};
654void set_busy_status(void *frontend, int status);
655
656void cleanup_exit(int);
657
658/*
659 * Exports from conf.c, and a big enum (via parametric macro) of
660 * configuration option keys.
661 */
662#define CONFIG_OPTIONS(X) \
663    /* X(value-type, subkey-type, keyword) */ \
664    X(STR, NONE, host) \
665    X(INT, NONE, port) \
666    X(INT, NONE, protocol) \
667    X(INT, NONE, addressfamily) \
668    X(INT, NONE, close_on_exit) \
669    X(INT, NONE, warn_on_close) \
670    X(INT, NONE, ping_interval) /* in seconds */ \
671    X(INT, NONE, tcp_nodelay) \
672    X(INT, NONE, tcp_keepalives) \
673    X(STR, NONE, loghost) /* logical host being contacted, for host key check */ \
674    /* Proxy options */ \
675    X(STR, NONE, proxy_exclude_list) \
676    X(INT, NONE, proxy_dns) \
677    X(INT, NONE, even_proxy_localhost) \
678    X(INT, NONE, proxy_type) \
679    X(STR, NONE, proxy_host) \
680    X(INT, NONE, proxy_port) \
681    X(STR, NONE, proxy_username) \
682    X(STR, NONE, proxy_password) \
683    X(STR, NONE, proxy_telnet_command) \
684    X(INT, NONE, proxy_log_to_term) \
685    /* SSH options */ \
686    X(STR, NONE, remote_cmd) \
687    X(STR, NONE, remote_cmd2) /* fallback if remote_cmd fails; never loaded or saved */ \
688    X(INT, NONE, nopty) \
689    X(INT, NONE, compression) \
690    X(INT, INT, ssh_kexlist) \
691    X(INT, NONE, ssh_rekey_time) /* in minutes */ \
692    X(STR, NONE, ssh_rekey_data) /* string encoding e.g. "100K", "2M", "1G" */ \
693    X(INT, NONE, tryagent) \
694    X(INT, NONE, agentfwd) \
695    X(INT, NONE, change_username) /* allow username switching in SSH-2 */ \
696    X(INT, INT, ssh_cipherlist) \
697    X(FILENAME, NONE, keyfile) \
698    X(STR, STR, fz_keyfiles) \
699    X(INT, NONE, sshprot) /* use v1 or v2 when both available */ \
700    X(INT, NONE, ssh2_des_cbc) /* "des-cbc" unrecommended SSH-2 cipher */ \
701    X(INT, NONE, ssh_no_userauth) /* bypass "ssh-userauth" (SSH-2 only) */ \
702    X(INT, NONE, ssh_show_banner) /* show USERAUTH_BANNERs (SSH-2 only) */ \
703    X(INT, NONE, try_tis_auth) \
704    X(INT, NONE, try_ki_auth) \
705    X(INT, NONE, try_gssapi_auth) /* attempt gssapi auth */ \
706    X(INT, NONE, gssapifwd) /* forward tgt via gss */ \
707    X(INT, INT, ssh_gsslist) /* preference order for local GSS libs */ \
708    X(FILENAME, NONE, ssh_gss_custom) \
709    X(INT, NONE, ssh_subsys) /* run a subsystem rather than a command */ \
710    X(INT, NONE, ssh_subsys2) /* fallback to go with remote_cmd_ptr2 */ \
711    X(INT, NONE, ssh_no_shell) /* avoid running a shell */ \
712    X(STR, NONE, ssh_nc_host) /* host to connect to in `nc' mode */ \
713    X(INT, NONE, ssh_nc_port) /* port to connect to in `nc' mode */ \
714    /* Telnet options */ \
715    X(STR, NONE, termtype) \
716    X(STR, NONE, termspeed) \
717    X(STR, STR, ttymodes) /* values are "Vvalue" or "A" */ \
718    X(STR, STR, environmt) \
719    X(STR, NONE, username) \
720    X(INT, NONE, username_from_env) \
721    X(STR, NONE, localusername) \
722    X(INT, NONE, rfc_environ) \
723    X(INT, NONE, passive_telnet) \
724    /* Serial port options */ \
725    X(STR, NONE, serline) \
726    X(INT, NONE, serspeed) \
727    X(INT, NONE, serdatabits) \
728    X(INT, NONE, serstopbits) \
729    X(INT, NONE, serparity) \
730    X(INT, NONE, serflow) \
731    /* Keyboard options */ \
732    X(INT, NONE, bksp_is_delete) \
733    X(INT, NONE, rxvt_homeend) \
734    X(INT, NONE, funky_type) \
735    X(INT, NONE, no_applic_c) /* totally disable app cursor keys */ \
736    X(INT, NONE, no_applic_k) /* totally disable app keypad */ \
737    X(INT, NONE, no_mouse_rep) /* totally disable mouse reporting */ \
738    X(INT, NONE, no_remote_resize) /* disable remote resizing */ \
739    X(INT, NONE, no_alt_screen) /* disable alternate screen */ \
740    X(INT, NONE, no_remote_wintitle) /* disable remote retitling */ \
741    X(INT, NONE, no_dbackspace) /* disable destructive backspace */ \
742    X(INT, NONE, no_remote_charset) /* disable remote charset config */ \
743    X(INT, NONE, remote_qtitle_action) /* remote win title query action */ \
744    X(INT, NONE, app_cursor) \
745    X(INT, NONE, app_keypad) \
746    X(INT, NONE, nethack_keypad) \
747    X(INT, NONE, telnet_keyboard) \
748    X(INT, NONE, telnet_newline) \
749    X(INT, NONE, alt_f4) /* is it special? */ \
750    X(INT, NONE, alt_space) /* is it special? */ \
751    X(INT, NONE, alt_only) /* is it special? */ \
752    X(INT, NONE, localecho) \
753    X(INT, NONE, localedit) \
754    X(INT, NONE, alwaysontop) \
755    X(INT, NONE, fullscreenonaltenter) \
756    X(INT, NONE, scroll_on_key) \
757    X(INT, NONE, scroll_on_disp) \
758    X(INT, NONE, erase_to_scrollback) \
759    X(INT, NONE, compose_key) \
760    X(INT, NONE, ctrlaltkeys) \
761    X(INT, NONE, osx_option_meta) \
762    X(INT, NONE, osx_command_meta) \
763    X(STR, NONE, wintitle) /* initial window title */ \
764    /* Terminal options */ \
765    X(INT, NONE, savelines) \
766    X(INT, NONE, dec_om) \
767    X(INT, NONE, wrap_mode) \
768    X(INT, NONE, lfhascr) \
769    X(INT, NONE, cursor_type) /* 0=block 1=underline 2=vertical */ \
770    X(INT, NONE, blink_cur) \
771    X(INT, NONE, beep) \
772    X(INT, NONE, beep_ind) \
773    X(INT, NONE, bellovl) /* bell overload protection active? */ \
774    X(INT, NONE, bellovl_n) /* number of bells to cause overload */ \
775    X(INT, NONE, bellovl_t) /* time interval for overload (seconds) */ \
776    X(INT, NONE, bellovl_s) /* period of silence to re-enable bell (s) */ \
777    X(FILENAME, NONE, bell_wavefile) \
778    X(INT, NONE, scrollbar) \
779    X(INT, NONE, scrollbar_in_fullscreen) \
780    X(INT, NONE, resize_action) \
781    X(INT, NONE, bce) \
782    X(INT, NONE, blinktext) \
783    X(INT, NONE, win_name_always) \
784    X(INT, NONE, width) \
785    X(INT, NONE, height) \
786    X(FONT, NONE, font) \
787    X(INT, NONE, font_quality) \
788    X(FILENAME, NONE, logfilename) \
789    X(INT, NONE, logtype) \
790    X(INT, NONE, logxfovr) \
791    X(INT, NONE, logflush) \
792    X(INT, NONE, logomitpass) \
793    X(INT, NONE, logomitdata) \
794    X(INT, NONE, hide_mouseptr) \
795    X(INT, NONE, sunken_edge) \
796    X(INT, NONE, window_border) \
797    X(STR, NONE, answerback) \
798    X(STR, NONE, printer) \
799    X(INT, NONE, arabicshaping) \
800    X(INT, NONE, bidi) \
801    /* Colour options */ \
802    X(INT, NONE, ansi_colour) \
803    X(INT, NONE, xterm_256_colour) \
804    X(INT, NONE, system_colour) \
805    X(INT, NONE, try_palette) \
806    X(INT, NONE, bold_style) \
807    X(INT, INT, colours) \
808    /* Selection options */ \
809    X(INT, NONE, mouse_is_xterm) \
810    X(INT, NONE, rect_select) \
811    X(INT, NONE, rawcnp) \
812    X(INT, NONE, rtf_paste) \
813    X(INT, NONE, mouse_override) \
814    X(INT, INT, wordness) \
815    /* translations */ \
816    X(INT, NONE, vtmode) \
817    X(STR, NONE, line_codepage) \
818    X(INT, NONE, cjk_ambig_wide) \
819    X(INT, NONE, utf8_override) \
820    X(INT, NONE, xlat_capslockcyr) \
821    /* X11 forwarding */ \
822    X(INT, NONE, x11_forward) \
823    X(STR, NONE, x11_display) \
824    X(INT, NONE, x11_auth) \
825    X(FILENAME, NONE, xauthfile) \
826    /* port forwarding */ \
827    X(INT, NONE, lport_acceptall) /* accept conns from hosts other than localhost */ \
828    X(INT, NONE, rport_acceptall) /* same for remote forwarded ports (SSH-2 only) */ \
829    /*                                                                \
830     * Subkeys for 'portfwd' can have the following forms:            \
831     *                                                                \
832     *   [LR]localport                                                \
833     *   [LR]localaddr:localport                                      \
834     *                                                                \
835     * Dynamic forwardings are indicated by an 'L' key, and the       \
836     * special value "D". For all other forwardings, the value        \
837     * should be of the form 'host:port'.                             \
838     */ \
839    X(STR, STR, portfwd) \
840    /* SSH bug compatibility modes */ \
841    X(INT, NONE, sshbug_ignore1) \
842    X(INT, NONE, sshbug_plainpw1) \
843    X(INT, NONE, sshbug_rsa1) \
844    X(INT, NONE, sshbug_hmac2) \
845    X(INT, NONE, sshbug_derivekey2) \
846    X(INT, NONE, sshbug_rsapad2) \
847    X(INT, NONE, sshbug_pksessid2) \
848    X(INT, NONE, sshbug_rekey2) \
849    X(INT, NONE, sshbug_maxpkt2) \
850    X(INT, NONE, sshbug_ignore2) \
851    X(INT, NONE, sshbug_oldgex2) \
852    X(INT, NONE, sshbug_winadj) \
853    X(INT, NONE, sshbug_chanreq) \
854    /*                                                                \
855     * ssh_simple means that we promise never to open any channel     \
856     * other than the main one, which means it can safely use a very  \
857     * large window in SSH-2.                                         \
858     */ \
859    X(INT, NONE, ssh_simple) \
860    X(INT, NONE, ssh_connection_sharing) \
861    X(INT, NONE, ssh_connection_sharing_upstream) \
862    X(INT, NONE, ssh_connection_sharing_downstream) \
863    /*
864     * ssh_manual_hostkeys is conceptually a set rather than a
865     * dictionary: the string subkeys are the important thing, and the
866     * actual values to which those subkeys map are all "".
867     */ \
868    X(STR, STR, ssh_manual_hostkeys) \
869    /* Options for pterm. Should split out into platform-dependent part. */ \
870    X(INT, NONE, stamp_utmp) \
871    X(INT, NONE, login_shell) \
872    X(INT, NONE, scrollbar_on_left) \
873    X(INT, NONE, shadowbold) \
874    X(FONT, NONE, boldfont) \
875    X(FONT, NONE, widefont) \
876    X(FONT, NONE, wideboldfont) \
877    X(INT, NONE, shadowboldoffset) \
878    X(INT, NONE, crhaslf) \
879    X(STR, NONE, winclass) \
880
881/* Now define the actual enum of option keywords using that macro. */
882#define CONF_ENUM_DEF(valtype, keytype, keyword) CONF_ ## keyword,
883enum config_primary_key { CONFIG_OPTIONS(CONF_ENUM_DEF) N_CONFIG_OPTIONS };
884#undef CONF_ENUM_DEF
885
886#define NCFGCOLOURS 22 /* number of colours in CONF_colours above */
887
888/* Functions handling configuration structures. */
889Conf *conf_new(void);                  /* create an empty configuration */
890void conf_free(Conf *conf);
891Conf *conf_copy(Conf *oldconf);
892void conf_copy_into(Conf *dest, Conf *src);
893/* Mandatory accessor functions: enforce by assertion that keys exist. */
894int conf_get_int(Conf *conf, int key);
895int conf_get_int_int(Conf *conf, int key, int subkey);
896char *conf_get_str(Conf *conf, int key);   /* result still owned by conf */
897char *conf_get_str_str(Conf *conf, int key, const char *subkey);
898Filename *conf_get_filename(Conf *conf, int key);
899FontSpec *conf_get_fontspec(Conf *conf, int key); /* still owned by conf */
900/* Optional accessor function: return NULL if key does not exist. */
901char *conf_get_str_str_opt(Conf *conf, int key, const char *subkey);
902/* Accessor function to step through a string-subkeyed list.
903 * Returns the next subkey after the provided one, or the first if NULL.
904 * Returns NULL if there are none left.
905 * Both the return value and *subkeyout are still owned by conf. */
906char *conf_get_str_strs(Conf *conf, int key, char *subkeyin, char **subkeyout);
907/* Return the nth string subkey in a list. Owned by conf. NULL if beyond end */
908char *conf_get_str_nthstrkey(Conf *conf, int key, int n);
909/* Functions to set entries in configuration. Always copy their inputs. */
910void conf_set_int(Conf *conf, int key, int value);
911void conf_set_int_int(Conf *conf, int key, int subkey, int value);
912void conf_set_str(Conf *conf, int key, const char *value);
913void conf_set_str_str(Conf *conf, int key,
914                      const char *subkey, const char *val);
915void conf_del_str_str(Conf *conf, int key, const char *subkey);
916void conf_set_filename(Conf *conf, int key, const Filename *val);
917void conf_set_fontspec(Conf *conf, int key, const FontSpec *val);
918/* Serialisation functions for Duplicate Session */
919int conf_serialised_size(Conf *conf);
920void conf_serialise(Conf *conf, void *data);
921int conf_deserialise(Conf *conf, void *data, int maxsize);/*returns size used*/
922
923/*
924 * Functions to copy, free, serialise and deserialise FontSpecs.
925 * Provided per-platform, to go with the platform's idea of a
926 * FontSpec's contents.
927 *
928 * fontspec_serialise returns the number of bytes written, and can
929 * handle data==NULL without crashing. So you can call it once to find
930 * out a size, then again once you've allocated a buffer.
931 */
932FontSpec *fontspec_copy(const FontSpec *f);
933void fontspec_free(FontSpec *f);
934int fontspec_serialise(FontSpec *f, void *data);
935FontSpec *fontspec_deserialise(void *data, int maxsize, int *used);
936
937/*
938 * Exports from noise.c.
939 */
940void noise_get_heavy(void (*func) (void *, int));
941void noise_get_light(void (*func) (void *, int));
942void noise_regular(void);
943void noise_ultralight(unsigned long data);
944void random_save_seed(void);
945void random_destroy_seed(void);
946
947/*
948 * Exports from settings.c.
949 */
950Backend *backend_from_name(const char *name);
951Backend *backend_from_proto(int proto);
952char *get_remote_username(Conf *conf); /* dynamically allocated */
953char *save_settings(const char *section, Conf *conf);
954void save_open_settings(void *sesskey, Conf *conf);
955void load_settings(const char *section, Conf *conf);
956void load_open_settings(void *sesskey, Conf *conf, int load_proxy_settings);
957void get_sesslist(struct sesslist *, int allocate);
958void do_defaults(const char *, Conf *);
959void registry_cleanup(void);
960
961/*
962 * Functions used by settings.c to provide platform-specific
963 * default settings.
964 *
965 * (The integer one is expected to return `def' if it has no clear
966 * opinion of its own. This is because there's no integer value
967 * which I can reliably set aside to indicate `nil'. The string
968 * function is perfectly all right returning NULL, of course. The
969 * Filename and FontSpec functions are _not allowed_ to fail to
970 * return, since these defaults _must_ be per-platform.)
971 *
972 * The 'Filename *' returned by platform_default_filename, and the
973 * 'FontSpec *' returned by platform_default_fontspec, have ownership
974 * transferred to the caller, and must be freed.
975 */
976char *platform_default_s(const char *name);
977int platform_default_i(const char *name, int def);
978Filename *platform_default_filename(const char *name);
979FontSpec *platform_default_fontspec(const char *name);
980
981/*
982 * Exports from terminal.c.
983 */
984
985Terminal *term_init(Conf *, struct unicode_data *, void *);
986void term_free(Terminal *);
987void term_size(Terminal *, int, int, int);
988void term_paint(Terminal *, Context, int, int, int, int, int);
989void term_scroll(Terminal *, int, int);
990void term_scroll_to_selection(Terminal *, int);
991void term_pwron(Terminal *, int);
992void term_clrsb(Terminal *);
993void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
994                int,int,int,int,int);
995void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
996              unsigned int);
997void term_deselect(Terminal *);
998void term_update(Terminal *);
999void term_invalidate(Terminal *);
1000void term_blink(Terminal *, int set_cursor);
1001void term_do_paste(Terminal *);
1002void term_nopaste(Terminal *);
1003int term_ldisc(Terminal *, int option);
1004void term_copyall(Terminal *);
1005void term_reconfig(Terminal *, Conf *);
1006void term_seen_key_event(Terminal *); 
1007int term_data(Terminal *, int is_stderr, const char *data, int len);
1008int term_data_untrusted(Terminal *, const char *data, int len);
1009void term_provide_resize_fn(Terminal *term,
1010                            void (*resize_fn)(void *, int, int),
1011                            void *resize_ctx);
1012void term_provide_logctx(Terminal *term, void *logctx);
1013void term_set_focus(Terminal *term, int has_focus);
1014char *term_get_ttymode(Terminal *term, const char *mode);
1015int term_get_userpass_input(Terminal *term, prompts_t *p,
1016                            const unsigned char *in, int inlen);
1017
1018int format_arrow_key(char *buf, Terminal *term, int xkey, int ctrl);
1019
1020/*
1021 * Exports from logging.c.
1022 */
1023void *log_init(void *frontend, Conf *conf);
1024void log_free(void *logctx);
1025void log_reconfig(void *logctx, Conf *conf);
1026void logfopen(void *logctx);
1027void logfclose(void *logctx);
1028void logtraffic(void *logctx, unsigned char c, int logmode);
1029void logflush(void *logctx);
1030void log_eventlog(void *logctx, const char *string);
1031enum { PKT_INCOMING, PKT_OUTGOING };
1032enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
1033struct logblank_t {
1034    int offset;
1035    int len;
1036    int type;
1037};
1038void log_packet(void *logctx, int direction, int type,
1039                const char *texttype, const void *data, int len,
1040                int n_blanks, const struct logblank_t *blanks,
1041                const unsigned long *sequence,
1042                unsigned downstream_id, const char *additional_log_text);
1043
1044/*
1045 * Exports from testback.c
1046 */
1047
1048extern Backend null_backend;
1049extern Backend loop_backend;
1050
1051/*
1052 * Exports from raw.c.
1053 */
1054
1055extern Backend raw_backend;
1056
1057/*
1058 * Exports from rlogin.c.
1059 */
1060
1061extern Backend rlogin_backend;
1062
1063/*
1064 * Exports from telnet.c.
1065 */
1066
1067extern Backend telnet_backend;
1068
1069/*
1070 * Exports from ssh.c.
1071 */
1072extern Backend ssh_backend;
1073
1074/*
1075 * Exports from ldisc.c.
1076 */
1077void *ldisc_create(Conf *, Terminal *, Backend *, void *, void *);
1078void ldisc_configure(void *, Conf *);
1079void ldisc_free(void *);
1080void ldisc_send(void *handle, const char *buf, int len, int interactive);
1081void ldisc_echoedit_update(void *handle);
1082
1083/*
1084 * Exports from ldiscucs.c.
1085 */
1086void lpage_send(void *, int codepage, const char *buf, int len,
1087                int interactive);
1088void luni_send(void *, const wchar_t * widebuf, int len, int interactive);
1089
1090/*
1091 * Exports from sshrand.c.
1092 */
1093
1094void random_add_noise(void *noise, int length);
1095int random_byte(void);
1096void random_get_savedata(void **data, int *len);
1097extern int random_active;
1098/* The random number subsystem is activated if at least one other entity
1099 * within the program expresses an interest in it. So each SSH session
1100 * calls random_ref on startup and random_unref on shutdown. */
1101void random_ref(void);
1102void random_unref(void);
1103
1104/*
1105 * Exports from pinger.c.
1106 */
1107typedef struct pinger_tag *Pinger;
1108Pinger pinger_new(Conf *conf, Backend *back, void *backhandle);
1109void pinger_reconfig(Pinger, Conf *oldconf, Conf *newconf);
1110void pinger_free(Pinger);
1111
1112/*
1113 * Exports from misc.c.
1114 */
1115
1116#include "misc.h"
1117int conf_launchable(Conf *conf);
1118char const *conf_dest(Conf *conf);
1119
1120/*
1121 * Exports from sercfg.c.
1122 */
1123void ser_setup_config_box(struct controlbox *b, int midsession,
1124                          int parity_mask, int flow_mask);
1125
1126/*
1127 * Exports from version.c.
1128 */
1129extern char ver[];
1130
1131/*
1132 * Exports from unicode.c.
1133 */
1134#ifndef CP_UTF8
1135#define CP_UTF8 65001
1136#endif
1137/* void init_ucs(void); -- this is now in platform-specific headers */
1138int is_dbcs_leadbyte(int codepage, char byte);
1139int mb_to_wc(int codepage, int flags, const char *mbstr, int mblen,
1140             wchar_t *wcstr, int wclen);
1141int wc_to_mb(int codepage, int flags, const wchar_t *wcstr, int wclen,
1142             char *mbstr, int mblen, const char *defchr, int *defused,
1143             struct unicode_data *ucsdata);
1144wchar_t xlat_uskbd2cyrllic(int ch);
1145int check_compose(int first, int second);
1146int decode_codepage(char *cp_name);
1147const char *cp_enumerate (int index);
1148const char *cp_name(int codepage);
1149void get_unitab(int codepage, wchar_t * unitab, int ftype);
1150
1151/*
1152 * Exports from wcwidth.c
1153 */
1154int mk_wcwidth(unsigned int ucs);
1155int mk_wcswidth(const unsigned int *pwcs, size_t n);
1156int mk_wcwidth_cjk(unsigned int ucs);
1157int mk_wcswidth_cjk(const unsigned int *pwcs, size_t n);
1158
1159/*
1160 * Exports from mscrypto.c
1161 */
1162#ifdef MSCRYPTOAPI
1163int crypto_startup();
1164void crypto_wrapup();
1165#endif
1166
1167/*
1168 * Exports from pageantc.c.
1169 *
1170 * agent_query returns 1 for here's-a-response, and 0 for query-in-
1171 * progress. In the latter case there will be a call to `callback'
1172 * at some future point, passing callback_ctx as the first
1173 * parameter and the actual reply data as the second and third.
1174 *
1175 * The response may be a NULL pointer (in either of the synchronous
1176 * or asynchronous cases), which indicates failure to receive a
1177 * response.
1178 */
1179int agent_query(void *in, int inlen, void **out, int *outlen,
1180                void (*callback)(void *, void *, int), void *callback_ctx);
1181int agent_exists(void);
1182
1183/*
1184 * Exports from wildcard.c
1185 */
1186const char *wc_error(int value);
1187int wc_match(const char *wildcard, const char *target);
1188int wc_unescape(char *output, const char *wildcard);
1189
1190/*
1191 * Exports from frontend (windlg.c etc)
1192 */
1193void logevent(void *frontend, const char *);
1194void pgp_fingerprints(void);
1195/*
1196 * verify_ssh_host_key() can return one of three values:
1197 *
1198 *  - +1 means `key was OK' (either already known or the user just
1199 *    approved it) `so continue with the connection'
1200 *
1201 *  - 0 means `key was not OK, abandon the connection'
1202 *
1203 *  - -1 means `I've initiated enquiries, please wait to be called
1204 *    back via the provided function with a result that's either 0
1205 *    or +1'.
1206 */
1207int verify_ssh_host_key(void *frontend, char *host, int port,
1208                        const char *keytype, char *keystr, char *fingerprint,
1209                        void (*callback)(void *ctx, int result), void *ctx);
1210/*
1211 * have_ssh_host_key() just returns true if a key of that type is
1212 * already chached and false otherwise.
1213 */
1214int have_ssh_host_key(const char *host, int port, const char *keytype);
1215/*
1216 * askalg has the same set of return values as verify_ssh_host_key.
1217 */
1218int askalg(void *frontend, const char *algtype, const char *algname,
1219           void (*callback)(void *ctx, int result), void *ctx);
1220/*
1221 * askappend can return four values:
1222 *
1223 *  - 2 means overwrite the log file
1224 *  - 1 means append to the log file
1225 *  - 0 means cancel logging for this session
1226 *  - -1 means please wait.
1227 */
1228int askappend(void *frontend, Filename *filename,
1229              void (*callback)(void *ctx, int result), void *ctx);
1230
1231/*
1232 * Exports from console frontends (wincons.c, uxcons.c)
1233 * that aren't equivalents to things in windlg.c et al.
1234 */
1235extern int console_batch_mode;
1236int console_get_userpass_input(prompts_t *p, const unsigned char *in,
1237                               int inlen);
1238void console_provide_logctx(void *logctx);
1239int is_interactive(void);
1240
1241/*
1242 * Exports from printing.c.
1243 */
1244typedef struct printer_enum_tag printer_enum;
1245typedef struct printer_job_tag printer_job;
1246printer_enum *printer_start_enum(int *nprinters);
1247char *printer_get_name(printer_enum *, int);
1248void printer_finish_enum(printer_enum *);
1249printer_job *printer_start_job(char *printer);
1250void printer_job_data(printer_job *, void *, int);
1251void printer_finish_job(printer_job *);
1252
1253/*
1254 * Exports from cmdline.c (and also cmdline_error(), which is
1255 * defined differently in various places and required _by_
1256 * cmdline.c).
1257 *
1258 * Note that cmdline_process_param takes a const option string, but a
1259 * writable argument string. That's not a mistake - that's so it can
1260 * zero out password arguments in the hope of not having them show up
1261 * avoidably in Unix 'ps'.
1262 */
1263int cmdline_process_param(const char *, char *, int, Conf *);
1264void cmdline_run_saved(Conf *);
1265void cmdline_cleanup(void);
1266int cmdline_get_passwd_input(prompts_t *p, const unsigned char *in, int inlen);
1267#define TOOLTYPE_FILETRANSFER 1
1268#define TOOLTYPE_NONNETWORK 2
1269extern int cmdline_tooltype;
1270
1271void cmdline_error(const char *, ...);
1272
1273/*
1274 * Exports from config.c.
1275 */
1276struct controlbox;
1277union control;
1278void conf_radiobutton_handler(union control *ctrl, void *dlg,
1279                              void *data, int event);
1280#define CHECKBOX_INVERT (1<<30)
1281void conf_checkbox_handler(union control *ctrl, void *dlg,
1282                           void *data, int event);
1283void conf_editbox_handler(union control *ctrl, void *dlg,
1284                          void *data, int event);
1285void conf_filesel_handler(union control *ctrl, void *dlg,
1286                          void *data, int event);
1287void conf_fontsel_handler(union control *ctrl, void *dlg,
1288                          void *data, int event);
1289void setup_config_box(struct controlbox *b, int midsession,
1290                      int protocol, int protcfginfo);
1291
1292/*
1293 * Exports from minibidi.c.
1294 */
1295typedef struct bidi_char {
1296    unsigned int origwc, wc;
1297    unsigned short index;
1298} bidi_char;
1299int do_bidi(bidi_char *line, int count);
1300int do_shape(bidi_char *line, bidi_char *to, int count);
1301int is_rtl(int c);
1302
1303/*
1304 * X11 auth mechanisms we know about.
1305 */
1306enum {
1307    X11_NO_AUTH,
1308    X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
1309    X11_XDM,                           /* XDM-AUTHORIZATION-1 */
1310    X11_NAUTHS
1311};
1312extern const char *const x11_authnames[];  /* declared in x11fwd.c */
1313
1314/*
1315 * Miscellaneous exports from the platform-specific code.
1316 *
1317 * filename_serialise and filename_deserialise have the same semantics
1318 * as fontspec_serialise and fontspec_deserialise above.
1319 */
1320Filename *filename_from_str(const char *string);
1321const char *filename_to_str(const Filename *fn);
1322int filename_equal(const Filename *f1, const Filename *f2);
1323int filename_is_null(const Filename *fn);
1324Filename *filename_copy(const Filename *fn);
1325void filename_free(Filename *fn);
1326int filename_serialise(const Filename *f, void *data);
1327Filename *filename_deserialise(void *data, int maxsize, int *used);
1328char *get_username(void);              /* return value needs freeing */
1329char *get_random_data(int bytes);      /* used in cmdgen.c */
1330char filename_char_sanitise(char c);   /* rewrite special pathname chars */
1331
1332/*
1333 * Exports and imports from timing.c.
1334 *
1335 * schedule_timer() asks the front end to schedule a callback to a
1336 * timer function in a given number of ticks. The returned value is
1337 * the time (in ticks since an arbitrary offset) at which the
1338 * callback can be expected. This value will also be passed as the
1339 * `now' parameter to the callback function. Hence, you can (for
1340 * example) schedule an event at a particular time by calling
1341 * schedule_timer() and storing the return value in your context
1342 * structure as the time when that event is due. The first time a
1343 * callback function gives you that value or more as `now', you do
1344 * the thing.
1345 *
1346 * expire_timer_context() drops all current timers associated with
1347 * a given value of ctx (for when you're about to free ctx).
1348 *
1349 * run_timers() is called from the front end when it has reason to
1350 * think some timers have reached their moment, or when it simply
1351 * needs to know how long to wait next. We pass it the time we
1352 * think it is. It returns TRUE and places the time when the next
1353 * timer needs to go off in `next', or alternatively it returns
1354 * FALSE if there are no timers at all pending.
1355 *
1356 * timer_change_notify() must be supplied by the front end; it
1357 * notifies the front end that a new timer has been added to the
1358 * list which is sooner than any existing ones. It provides the
1359 * time when that timer needs to go off.
1360 *
1361 * *** FRONT END IMPLEMENTORS NOTE:
1362 *
1363 * There's an important subtlety in the front-end implementation of
1364 * the timer interface. When a front end is given a `next' value,
1365 * either returned from run_timers() or via timer_change_notify(),
1366 * it should ensure that it really passes _that value_ as the `now'
1367 * parameter to its next run_timers call. It should _not_ simply
1368 * call GETTICKCOUNT() to get the `now' parameter when invoking
1369 * run_timers().
1370 *
1371 * The reason for this is that an OS's system clock might not agree
1372 * exactly with the timing mechanisms it supplies to wait for a
1373 * given interval. I'll illustrate this by the simple example of
1374 * Unix Plink, which uses timeouts to select() in a way which for
1375 * these purposes can simply be considered to be a wait() function.
1376 * Suppose, for the sake of argument, that this wait() function
1377 * tends to return early by 1%. Then a possible sequence of actions
1378 * is:
1379 *
1380 *  - run_timers() tells the front end that the next timer firing
1381 *    is 10000ms from now.
1382 *  - Front end calls wait(10000ms), but according to
1383 *    GETTICKCOUNT() it has only waited for 9900ms.
1384 *  - Front end calls run_timers() again, passing time T-100ms as
1385 *    `now'.
1386 *  - run_timers() does nothing, and says the next timer firing is
1387 *    still 100ms from now.
1388 *  - Front end calls wait(100ms), which only waits for 99ms.
1389 *  - Front end calls run_timers() yet again, passing time T-1ms.
1390 *  - run_timers() says there's still 1ms to wait.
1391 *  - Front end calls wait(1ms).
1392 *
1393 * If you're _lucky_ at this point, wait(1ms) will actually wait
1394 * for 1ms and you'll only have woken the program up three times.
1395 * If you're unlucky, wait(1ms) might do nothing at all due to
1396 * being below some minimum threshold, and you might find your
1397 * program spends the whole of the last millisecond tight-looping
1398 * between wait() and run_timers().
1399 *
1400 * Instead, what you should do is to _save_ the precise `next'
1401 * value provided by run_timers() or via timer_change_notify(), and
1402 * use that precise value as the input to the next run_timers()
1403 * call. So:
1404 *
1405 *  - run_timers() tells the front end that the next timer firing
1406 *    is at time T, 10000ms from now.
1407 *  - Front end calls wait(10000ms).
1408 *  - Front end then immediately calls run_timers() and passes it
1409 *    time T, without stopping to check GETTICKCOUNT() at all.
1410 *
1411 * This guarantees that the program wakes up only as many times as
1412 * there are actual timer actions to be taken, and that the timing
1413 * mechanism will never send it into a tight loop.
1414 *
1415 * (It does also mean that the timer action in the above example
1416 * will occur 100ms early, but this is not generally critical. And
1417 * the hypothetical 1% error in wait() will be partially corrected
1418 * for anyway when, _after_ run_timers() returns, you call
1419 * GETTICKCOUNT() and compare the result with the returned `next'
1420 * value to find out how long you have to make your next wait().)
1421 */
1422typedef void (*timer_fn_t)(void *ctx, unsigned long now);
1423unsigned long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
1424void expire_timer_context(void *ctx);
1425int run_timers(unsigned long now, unsigned long *next);
1426void timer_change_notify(unsigned long next);
1427
1428/*
1429 * Exports from callback.c.
1430 *
1431 * This provides a method of queuing function calls to be run at the
1432 * earliest convenience from the top-level event loop. Use it if
1433 * you're deep in a nested chain of calls and want to trigger an
1434 * action which will probably lead to your function being re-entered
1435 * recursively if you just call the initiating function the normal
1436 * way.
1437 *
1438 * Most front ends run the queued callbacks by simply calling
1439 * run_toplevel_callbacks() after handling each event in their
1440 * top-level event loop. However, if a front end doesn't have control
1441 * over its own event loop (e.g. because it's using GTK) then it can
1442 * instead request notifications when a callback is available, so that
1443 * it knows to ask its delegate event loop to do the same thing. Also,
1444 * if a front end needs to know whether a callback is pending without
1445 * actually running it (e.g. so as to put a zero timeout on a select()
1446 * call) then it can call toplevel_callback_pending(), which will
1447 * return true if at least one callback is in the queue.
1448 */
1449typedef void (*toplevel_callback_fn_t)(void *ctx);
1450void queue_toplevel_callback(toplevel_callback_fn_t fn, void *ctx);
1451void run_toplevel_callbacks(void);
1452int toplevel_callback_pending(void);
1453
1454typedef void (*toplevel_callback_notify_fn_t)(void *frontend);
1455void request_callback_notifications(toplevel_callback_notify_fn_t notify,
1456                                    void *frontend);
1457
1458/*
1459 * Define no-op macros for the jump list functions, on platforms that
1460 * don't support them. (This is a bit of a hack, and it'd be nicer to
1461 * localise even the calls to those functions into the Windows front
1462 * end, but it'll do for the moment.)
1463 */
1464#ifndef JUMPLIST_SUPPORTED
1465#define add_session_to_jumplist(x) ((void)0)
1466#define remove_session_from_jumplist(x) ((void)0)
1467#endif
1468
1469/* SURROGATE PAIR */
1470#define HIGH_SURROGATE_START 0xd800
1471#define HIGH_SURROGATE_END 0xdbff
1472#define LOW_SURROGATE_START 0xdc00
1473#define LOW_SURROGATE_END 0xdfff
1474
1475/* These macros exist in the Windows API, so the environment may
1476 * provide them. If not, define them in terms of the above. */
1477#ifndef IS_HIGH_SURROGATE
1478#define IS_HIGH_SURROGATE(wch) (((wch) >= HIGH_SURROGATE_START) && \
1479                                ((wch) <= HIGH_SURROGATE_END))
1480#define IS_LOW_SURROGATE(wch) (((wch) >= LOW_SURROGATE_START) && \
1481                               ((wch) <= LOW_SURROGATE_END))
1482#define IS_SURROGATE_PAIR(hs, ls) (IS_HIGH_SURROGATE(hs) && \
1483                                   IS_LOW_SURROGATE(ls))
1484#endif
1485
1486
1487#define IS_SURROGATE(wch) (((wch) >= HIGH_SURROGATE_START) &&   \
1488                           ((wch) <= LOW_SURROGATE_END))
1489#define HIGH_SURROGATE_OF(codept) \
1490    (HIGH_SURROGATE_START + (((codept) - 0x10000) >> 10))
1491#define LOW_SURROGATE_OF(codept) \
1492    (LOW_SURROGATE_START + (((codept) - 0x10000) & 0x3FF))
1493#define FROM_SURROGATES(wch1, wch2) \
1494    (0x10000 + (((wch1) & 0x3FF) << 10) + ((wch2) & 0x3FF))
1495
1496#include "fzprintf.h"
1497#include "fzsftp.h"
1498
1499#endif
Note: See TracBrowser for help on using the repository browser.