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 conf_tag Conf;
22 typedef struct backend_tag Backend;
23 typedef struct terminal_tag Terminal;
31 * Fingerprints of the PGP master keys that can be used to establish a trust
32 * path between an executable and other files.
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"
41 /* Three attribute types:
42 * The ATTRs (normal attributes) are stored with the characters in
43 * the main display arrays
45 * The TATTRs (temporary attributes) are generated on the fly, they
46 * can overlap with characters but not with normal attributes.
48 * The LATTRs (line attributes) are an entirely disjoint space of
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.
56 * ATTR_INVALID is an illegal colour combination.
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 */
64 #define DATTR_STARTRUN 0x80000000UL /* start of redraw run */
66 #define TDATTR_MASK 0xF0000000UL
67 #define TATTR_MASK (TDATTR_MASK)
68 #define DATTR_MASK (TDATTR_MASK)
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 */
80 #define ATTR_INVALID 0x03FFFFU
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 */
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 */
93 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
94 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
96 #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */
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).
105 #define UCSWIDE 0xDFFF
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
120 * The definitive list of colour numbers stored in terminal
121 * attribute words is kept here. It is:
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
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
138 #define ATTR_DEFFG (256 << ATTR_FGSHIFT)
139 #define ATTR_DEFBG (258 << ATTR_BGSHIFT)
140 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
144 const char **sessions;
145 char *buffer; /* so memory can be freed later */
148 struct unicode_data {
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];
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 */
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,
176 /* Special command for SSH. */
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 /* Starting point for protocols to invent special-action codes
187 * that can't live in this enum at all, e.g. because they change
188 * with every session.
190 * Of course, this must remain the last value in this
195 struct telnet_special {
202 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
203 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
204 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
208 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
211 /* Keyboard modifiers -- keys the user is actually holding down */
213 #define PKM_SHIFT 0x01
214 #define PKM_CONTROL 0x02
215 #define PKM_META 0x04
218 /* Keyboard flags that aren't really modifiers */
219 #define PKF_CAPSLOCK 0x10
220 #define PKF_NUMLOCK 0x20
221 #define PKF_REPEAT 0x40
223 /* Stand-alone keysyms for function keys */
226 PK_NULL, /* No symbol for this key */
227 /* Main keypad keys */
228 PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
230 PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
232 PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
233 /* Numeric keypad */ /* Real one looks like: */
234 PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */
235 PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */
236 PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */
237 PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */
238 PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */
240 PK_F1, PK_F2, PK_F3, PK_F4, PK_F5,
241 PK_F6, PK_F7, PK_F8, PK_F9, PK_F10,
242 PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
243 PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
247 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
248 #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST)
249 #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER)
250 #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20)
253 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
258 * SSH-2 key exchange algorithms
271 * SSH-2 host key algorithms
283 * SSH ciphers (both SSH-1 and SSH-2)
285 CIPHER_WARN, /* pseudo 'cipher' */
288 CIPHER_AES, /* (SSH-2 only) */
292 CIPHER_MAX /* no. ciphers (inc warn) */
297 * Several different bits of the PuTTY configuration seem to be
298 * three-way settings whose values are `always yes', `always
299 * no', and `decide by some more complex automated means'. This
300 * is true of line discipline options (local echo and line
301 * editing), proxy DNS, proxy terminal logging, Close On Exit, and
302 * SSH server bug workarounds. Accordingly I supply a single enum
303 * here to deal with them all.
305 FORCE_ON, FORCE_OFF, AUTO
312 PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
313 PROXY_HTTP, PROXY_TELNET, PROXY_CMD, PROXY_FUZZ
318 * Line discipline options which the backend might try to control.
320 LD_EDIT, /* local line editing */
321 LD_ECHO /* local echo */
325 /* Actions on remote window title query */
326 TITLE_NONE, TITLE_EMPTY, TITLE_REAL
330 /* Protocol back ends. (CONF_protocol) */
331 PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH,
332 /* PROT_SERIAL is supported on a subset of platforms, but it doesn't
333 * hurt to define it globally. */
338 /* Bell settings (CONF_beep) */
339 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
343 /* Taskbar flashing indication on bell (CONF_beep_ind) */
344 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
348 /* Resize actions (CONF_resize_action) */
349 RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
353 /* Function key types (CONF_funky_type) */
363 FQ_DEFAULT, FQ_ANTIALIASED, FQ_NONANTIALIASED, FQ_CLEARTYPE
367 SER_PAR_NONE, SER_PAR_ODD, SER_PAR_EVEN, SER_PAR_MARK, SER_PAR_SPACE
371 SER_FLOW_NONE, SER_FLOW_XONXOFF, SER_FLOW_RTSCTS, SER_FLOW_DSRDTR
375 * Tables of string <-> enum value mappings used in settings.c.
376 * Defined here so that backends can export their GSS library tables
377 * to the cross-platform settings code.
381 * Two fields which define a string and enum value to be
382 * equivalent to each other.
388 * The next pair of fields are used by gprefs() in settings.c to
389 * arrange that when it reads a list of strings representing a
390 * preference list and translates it into the corresponding list
391 * of integers, strings not appearing in the list are entered in a
392 * configurable position rather than uniformly at the end.
396 * 'vrel' indicates which other value in the list to place this
397 * element relative to. It should be a value that has occurred in
398 * a 'v' field of some other element of the array, or -1 to
399 * indicate that we simply place relative to one or other end of
402 * gprefs will try to process the elements in an order which makes
403 * this field work (i.e. so that the element referenced has been
404 * added before processing this one).
409 * 'where' indicates whether to place the new value before or
410 * after the one referred to by vrel. -1 means before; +1 means
413 * When vrel is -1, this also implicitly indicates which end of
414 * the array to use. So vrel=-1, where=-1 means to place _before_
415 * some end of the list (hence, at the last element); vrel=-1,
416 * where=+1 means to place _after_ an end (hence, at the first).
422 extern const int ngsslibs;
423 extern const char *const gsslibnames[]; /* for displaying in configuration */
424 extern const struct keyvalwhere gsslibkeywords[]; /* for settings.c */
427 extern const char *const ttymodes[];
431 * Network address types. Used for specifying choice of IPv4/v6
432 * in config; also used in proxy.c to indicate whether a given
433 * host name has already been resolved or will be resolved at
436 ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME
440 const char *(*init) (void *frontend_handle, void **backend_handle,
441 Conf *conf, const char *host, int port,
442 char **realhost, int nodelay, int keepalive);
443 void (*free) (void *handle);
444 /* back->reconfig() passes in a replacement configuration. */
445 void (*reconfig) (void *handle, Conf *conf);
446 /* back->send() returns the current amount of buffered data. */
447 int (*send) (void *handle, const char *buf, int len);
448 /* back->sendbuffer() does the same thing but without attempting a send */
449 int (*sendbuffer) (void *handle);
450 void (*size) (void *handle, int width, int height);
451 void (*special) (void *handle, Telnet_Special code);
452 const struct telnet_special *(*get_specials) (void *handle);
453 int (*connected) (void *handle);
454 int (*exitcode) (void *handle);
455 /* If back->sendok() returns FALSE, data sent to it from the frontend
457 int (*sendok) (void *handle);
458 int (*ldisc) (void *handle, int);
459 void (*provide_ldisc) (void *handle, void *ldisc);
460 void (*provide_logctx) (void *handle, void *logctx);
462 * back->unthrottle() tells the back end that the front end
463 * buffer is clearing.
465 void (*unthrottle) (void *handle, int);
466 int (*cfg_info) (void *handle);
467 /* Only implemented in the SSH protocol: check whether a
468 * connection-sharing upstream exists for a given configuration. */
469 int (*test_for_upstream)(const char *host, int port, Conf *conf);
475 extern Backend *backends[];
478 * Suggested default protocol provided by the backend link module.
479 * The application is free to ignore this.
481 extern const int be_default_protocol;
484 * Name of this particular application, for use in the config box
485 * and other pieces of text.
487 extern const char *const appname;
490 * Some global flags denoting the type of application.
492 * FLAG_VERBOSE is set when the user requests verbose details.
494 * FLAG_STDERR is set in command-line applications (which have a
495 * functioning stderr that it makes sense to write to) and not in
496 * GUI applications (which don't).
498 * FLAG_INTERACTIVE is set when a full interactive shell session is
499 * being run, _either_ because no remote command has been provided
500 * _or_ because the application is GUI and can't run non-
503 * These flags describe the type of _application_ - they wouldn't
504 * vary between individual sessions - and so it's OK to have this
505 * variable be GLOBAL.
507 * Note that additional flags may be defined in platform-specific
508 * headers. It's probably best if those ones start from 0x1000, to
511 #define FLAG_VERBOSE 0x0001
512 #define FLAG_STDERR 0x0002
513 #define FLAG_INTERACTIVE 0x0004
517 * Likewise, these two variables are set up when the application
518 * initialises, and inform all default-settings accesses after
521 GLOBAL int default_protocol;
522 GLOBAL int default_port;
525 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
527 GLOBAL int loaded_session;
529 * This is set to the name of the loaded session.
531 GLOBAL char *cmdline_session_name;
533 struct RSAKey; /* be a little careful of scope */
536 * Mechanism for getting text strings such as usernames and passwords
537 * from the front-end.
538 * The fields are mostly modelled after SSH's keyboard-interactive auth.
539 * FIXME We should probably mandate a character set/encoding (probably UTF-8).
541 * Since many of the pieces of text involved may be chosen by the server,
542 * the caller must take care to ensure that the server can't spoof locally-
543 * generated prompts such as key passphrase prompts. Some ground rules:
544 * - If the front-end needs to truncate a string, it should lop off the
546 * - The front-end should filter out any dangerous characters and
547 * generally not trust the strings. (But \n is required to behave
548 * vaguely sensibly, at least in `instruction', and ideally in
555 * 'result' must be a dynamically allocated array of exactly
556 * 'resultsize' chars. The code for actually reading input may
557 * realloc it bigger (and adjust resultsize accordingly) if it has
558 * to. The caller should free it again when finished with it.
560 * If resultsize==0, then result may be NULL. When setting up a
561 * prompt_t, it's therefore easiest to initialise them this way,
562 * which means all actual allocation is done by the callee. This
563 * is what add_prompt does.
570 * Indicates whether the information entered is to be used locally
571 * (for instance a key passphrase prompt), or is destined for the wire.
572 * This is a hint only; the front-end is at liberty not to use this
573 * information (so the caller should ensure that the supplied text is
577 char *name; /* Short description, perhaps for dialog box title */
578 int name_reqd; /* Display of `name' required or optional? */
579 char *instruction; /* Long description, maybe with embedded newlines */
580 int instr_reqd; /* Display of `instruction' required or optional? */
581 size_t n_prompts; /* May be zero (in which case display the foregoing,
582 * if any, and return success) */
585 void *data; /* slot for housekeeping data, managed by
586 * get_userpass_input(); initially NULL */
588 prompts_t *new_prompts(void *frontend);
589 void add_prompt(prompts_t *p, char *promptstr, int echo);
590 void prompt_set_result(prompt_t *pr, const char *newstr);
591 void prompt_ensure_result_size(prompt_t *pr, int len);
592 /* Burn the evidence. (Assumes _all_ strings want free()ing.) */
593 void free_prompts(prompts_t *p);
596 * Exports from the front end.
598 void request_resize(void *frontend, int, int);
599 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
600 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
601 int char_width(Context ctx, int uc);
602 #ifdef OPTIMISE_SCROLL
603 void do_scroll(Context, int, int, int);
605 void set_title(void *frontend, char *);
606 void set_icon(void *frontend, char *);
607 void set_sbar(void *frontend, int, int, int);
608 Context get_ctx(void *frontend);
609 void free_ctx(Context);
610 void palette_set(void *frontend, int, int, int, int);
611 void palette_reset(void *frontend);
612 void write_aclip(void *frontend, char *, int, int);
613 void write_clip(void *frontend, wchar_t *, int *, int, int);
614 void get_clip(void *frontend, wchar_t **, int *);
615 void optimised_move(void *frontend, int, int, int);
616 void set_raw_mouse_mode(void *frontend, int);
617 void connection_fatal(void *frontend, const char *, ...);
618 void nonfatal(const char *, ...);
619 void fatalbox(const char *, ...);
620 void modalfatalbox(const char *, ...);
622 #pragma noreturn(fatalbox)
623 #pragma noreturn(modalfatalbox)
625 void do_beep(void *frontend, int);
626 void begin_session(void *frontend);
627 void sys_cursor(void *frontend, int x, int y);
628 void request_paste(void *frontend);
629 void frontend_keypress(void *frontend);
630 void frontend_echoedit_update(void *frontend, int echo, int edit);
631 /* It's the backend's responsibility to invoke this at the start of a
632 * connection, if necessary; it can also invoke it later if the set of
633 * special commands changes. It does not need to invoke it at session
635 void update_specials_menu(void *frontend);
636 int from_backend(void *frontend, int is_stderr, const char *data, int len);
637 int from_backend_untrusted(void *frontend, const char *data, int len);
638 /* Called when the back end wants to indicate that EOF has arrived on
639 * the server-to-client stream. Returns FALSE to indicate that we
640 * intend to keep the session open in the other direction, or TRUE to
641 * indicate that if they're closing so are we. */
642 int from_backend_eof(void *frontend);
643 void notify_remote_exit(void *frontend);
644 /* Get a sensible value for a tty mode. NULL return = don't set.
645 * Otherwise, returned value should be freed by caller. */
646 char *get_ttymode(void *frontend, const char *mode);
648 * >0 = `got all results, carry on'
649 * 0 = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?)
650 * <0 = `please call back later with more in/inlen'
652 int get_userpass_input(prompts_t *p, const unsigned char *in, int inlen);
653 #define OPTIMISE_IS_SCROLL 1
655 void set_iconic(void *frontend, int iconic);
656 void move_window(void *frontend, int x, int y);
657 void set_zorder(void *frontend, int top);
658 void refresh_window(void *frontend);
659 void set_zoomed(void *frontend, int zoomed);
660 int is_iconic(void *frontend);
661 void get_window_pos(void *frontend, int *x, int *y);
662 void get_window_pixels(void *frontend, int *x, int *y);
663 char *get_window_title(void *frontend, int icon);
664 /* Hint from backend to frontend about time-consuming operations.
665 * Initial state is assumed to be BUSY_NOT. */
667 BUSY_NOT, /* Not busy, all user interaction OK */
668 BUSY_WAITING, /* Waiting for something; local event loops still running
669 so some local interaction (e.g. menus) OK, but network
670 stuff is suspended */
671 BUSY_CPU /* Locally busy (e.g. crypto); user interaction suspended */
673 void set_busy_status(void *frontend, int status);
675 void cleanup_exit(int);
678 * Exports from conf.c, and a big enum (via parametric macro) of
679 * configuration option keys.
681 #define CONFIG_OPTIONS(X) \
682 /* X(value-type, subkey-type, keyword) */ \
685 X(INT, NONE, protocol) \
686 X(INT, NONE, addressfamily) \
687 X(INT, NONE, close_on_exit) \
688 X(INT, NONE, warn_on_close) \
689 X(INT, NONE, ping_interval) /* in seconds */ \
690 X(INT, NONE, tcp_nodelay) \
691 X(INT, NONE, tcp_keepalives) \
692 X(STR, NONE, loghost) /* logical host being contacted, for host key check */ \
693 /* Proxy options */ \
694 X(STR, NONE, proxy_exclude_list) \
695 X(INT, NONE, proxy_dns) \
696 X(INT, NONE, even_proxy_localhost) \
697 X(INT, NONE, proxy_type) \
698 X(STR, NONE, proxy_host) \
699 X(INT, NONE, proxy_port) \
700 X(STR, NONE, proxy_username) \
701 X(STR, NONE, proxy_password) \
702 X(STR, NONE, proxy_telnet_command) \
703 X(INT, NONE, proxy_log_to_term) \
705 X(STR, NONE, remote_cmd) \
706 X(STR, NONE, remote_cmd2) /* fallback if remote_cmd fails; never loaded or saved */ \
707 X(INT, NONE, nopty) \
708 X(INT, NONE, compression) \
709 X(INT, INT, ssh_kexlist) \
710 X(INT, INT, ssh_hklist) \
711 X(INT, NONE, ssh_rekey_time) /* in minutes */ \
712 X(STR, NONE, ssh_rekey_data) /* string encoding e.g. "100K", "2M", "1G" */ \
713 X(INT, NONE, tryagent) \
714 X(INT, NONE, agentfwd) \
715 X(INT, NONE, change_username) /* allow username switching in SSH-2 */ \
716 X(INT, INT, ssh_cipherlist) \
717 X(FILENAME, NONE, keyfile) \
719 * Which SSH protocol to use. \
720 * For historical reasons, the current legal values for CONF_sshprot \
724 * We used to also support \
725 * 1 = SSH-1 with fallback to SSH-2 \
726 * 2 = SSH-2 with fallback to SSH-1 \
727 * and we continue to use 0/3 in storage formats rather than the more \
728 * obvious 1/2 to avoid surprises if someone saves a session and later \
729 * downgrades PuTTY. So it's easier to use these numbers internally too. \
731 X(INT, NONE, sshprot) \
732 X(INT, NONE, ssh2_des_cbc) /* "des-cbc" unrecommended SSH-2 cipher */ \
733 X(INT, NONE, ssh_no_userauth) /* bypass "ssh-userauth" (SSH-2 only) */ \
734 X(INT, NONE, ssh_show_banner) /* show USERAUTH_BANNERs (SSH-2 only) */ \
735 X(INT, NONE, try_tis_auth) \
736 X(INT, NONE, try_ki_auth) \
737 X(INT, NONE, try_gssapi_auth) /* attempt gssapi auth */ \
738 X(INT, NONE, gssapifwd) /* forward tgt via gss */ \
739 X(INT, INT, ssh_gsslist) /* preference order for local GSS libs */ \
740 X(FILENAME, NONE, ssh_gss_custom) \
741 X(INT, NONE, ssh_subsys) /* run a subsystem rather than a command */ \
742 X(INT, NONE, ssh_subsys2) /* fallback to go with remote_cmd_ptr2 */ \
743 X(INT, NONE, ssh_no_shell) /* avoid running a shell */ \
744 X(STR, NONE, ssh_nc_host) /* host to connect to in `nc' mode */ \
745 X(INT, NONE, ssh_nc_port) /* port to connect to in `nc' mode */ \
746 /* Telnet options */ \
747 X(STR, NONE, termtype) \
748 X(STR, NONE, termspeed) \
749 X(STR, STR, ttymodes) /* values are "Vvalue" or "A" */ \
750 X(STR, STR, environmt) \
751 X(STR, NONE, username) \
752 X(INT, NONE, username_from_env) \
753 X(STR, NONE, localusername) \
754 X(INT, NONE, rfc_environ) \
755 X(INT, NONE, passive_telnet) \
756 /* Serial port options */ \
757 X(STR, NONE, serline) \
758 X(INT, NONE, serspeed) \
759 X(INT, NONE, serdatabits) \
760 X(INT, NONE, serstopbits) \
761 X(INT, NONE, serparity) \
762 X(INT, NONE, serflow) \
763 /* Keyboard options */ \
764 X(INT, NONE, bksp_is_delete) \
765 X(INT, NONE, rxvt_homeend) \
766 X(INT, NONE, funky_type) \
767 X(INT, NONE, no_applic_c) /* totally disable app cursor keys */ \
768 X(INT, NONE, no_applic_k) /* totally disable app keypad */ \
769 X(INT, NONE, no_mouse_rep) /* totally disable mouse reporting */ \
770 X(INT, NONE, no_remote_resize) /* disable remote resizing */ \
771 X(INT, NONE, no_alt_screen) /* disable alternate screen */ \
772 X(INT, NONE, no_remote_wintitle) /* disable remote retitling */ \
773 X(INT, NONE, no_remote_clearscroll) /* disable ESC[3J */ \
774 X(INT, NONE, no_dbackspace) /* disable destructive backspace */ \
775 X(INT, NONE, no_remote_charset) /* disable remote charset config */ \
776 X(INT, NONE, remote_qtitle_action) /* remote win title query action */ \
777 X(INT, NONE, app_cursor) \
778 X(INT, NONE, app_keypad) \
779 X(INT, NONE, nethack_keypad) \
780 X(INT, NONE, telnet_keyboard) \
781 X(INT, NONE, telnet_newline) \
782 X(INT, NONE, alt_f4) /* is it special? */ \
783 X(INT, NONE, alt_space) /* is it special? */ \
784 X(INT, NONE, alt_only) /* is it special? */ \
785 X(INT, NONE, localecho) \
786 X(INT, NONE, localedit) \
787 X(INT, NONE, alwaysontop) \
788 X(INT, NONE, fullscreenonaltenter) \
789 X(INT, NONE, scroll_on_key) \
790 X(INT, NONE, scroll_on_disp) \
791 X(INT, NONE, erase_to_scrollback) \
792 X(INT, NONE, compose_key) \
793 X(INT, NONE, ctrlaltkeys) \
794 X(INT, NONE, osx_option_meta) \
795 X(INT, NONE, osx_command_meta) \
796 X(STR, NONE, wintitle) /* initial window title */ \
797 /* Terminal options */ \
798 X(INT, NONE, savelines) \
799 X(INT, NONE, dec_om) \
800 X(INT, NONE, wrap_mode) \
801 X(INT, NONE, lfhascr) \
802 X(INT, NONE, cursor_type) /* 0=block 1=underline 2=vertical */ \
803 X(INT, NONE, blink_cur) \
805 X(INT, NONE, beep_ind) \
806 X(INT, NONE, bellovl) /* bell overload protection active? */ \
807 X(INT, NONE, bellovl_n) /* number of bells to cause overload */ \
808 X(INT, NONE, bellovl_t) /* time interval for overload (seconds) */ \
809 X(INT, NONE, bellovl_s) /* period of silence to re-enable bell (s) */ \
810 X(FILENAME, NONE, bell_wavefile) \
811 X(INT, NONE, scrollbar) \
812 X(INT, NONE, scrollbar_in_fullscreen) \
813 X(INT, NONE, resize_action) \
815 X(INT, NONE, blinktext) \
816 X(INT, NONE, win_name_always) \
817 X(INT, NONE, width) \
818 X(INT, NONE, height) \
819 X(FONT, NONE, font) \
820 X(INT, NONE, font_quality) \
821 X(FILENAME, NONE, logfilename) \
822 X(INT, NONE, logtype) \
823 X(INT, NONE, logxfovr) \
824 X(INT, NONE, logflush) \
825 X(INT, NONE, logomitpass) \
826 X(INT, NONE, logomitdata) \
827 X(INT, NONE, hide_mouseptr) \
828 X(INT, NONE, sunken_edge) \
829 X(INT, NONE, window_border) \
830 X(STR, NONE, answerback) \
831 X(STR, NONE, printer) \
832 X(INT, NONE, arabicshaping) \
834 /* Colour options */ \
835 X(INT, NONE, ansi_colour) \
836 X(INT, NONE, xterm_256_colour) \
837 X(INT, NONE, system_colour) \
838 X(INT, NONE, try_palette) \
839 X(INT, NONE, bold_style) \
840 X(INT, INT, colours) \
841 /* Selection options */ \
842 X(INT, NONE, mouse_is_xterm) \
843 X(INT, NONE, rect_select) \
844 X(INT, NONE, rawcnp) \
845 X(INT, NONE, rtf_paste) \
846 X(INT, NONE, mouse_override) \
847 X(INT, INT, wordness) \
849 X(INT, NONE, vtmode) \
850 X(STR, NONE, line_codepage) \
851 X(INT, NONE, cjk_ambig_wide) \
852 X(INT, NONE, utf8_override) \
853 X(INT, NONE, xlat_capslockcyr) \
854 /* X11 forwarding */ \
855 X(INT, NONE, x11_forward) \
856 X(STR, NONE, x11_display) \
857 X(INT, NONE, x11_auth) \
858 X(FILENAME, NONE, xauthfile) \
859 /* port forwarding */ \
860 X(INT, NONE, lport_acceptall) /* accept conns from hosts other than localhost */ \
861 X(INT, NONE, rport_acceptall) /* same for remote forwarded ports (SSH-2 only) */ \
863 * Subkeys for 'portfwd' can have the following forms: \
866 * [LR]localaddr:localport \
868 * Dynamic forwardings are indicated by an 'L' key, and the \
869 * special value "D". For all other forwardings, the value \
870 * should be of the form 'host:port'. \
872 X(STR, STR, portfwd) \
873 /* SSH bug compatibility modes */ \
874 X(INT, NONE, sshbug_ignore1) \
875 X(INT, NONE, sshbug_plainpw1) \
876 X(INT, NONE, sshbug_rsa1) \
877 X(INT, NONE, sshbug_hmac2) \
878 X(INT, NONE, sshbug_derivekey2) \
879 X(INT, NONE, sshbug_rsapad2) \
880 X(INT, NONE, sshbug_pksessid2) \
881 X(INT, NONE, sshbug_rekey2) \
882 X(INT, NONE, sshbug_maxpkt2) \
883 X(INT, NONE, sshbug_ignore2) \
884 X(INT, NONE, sshbug_oldgex2) \
885 X(INT, NONE, sshbug_winadj) \
886 X(INT, NONE, sshbug_chanreq) \
888 * ssh_simple means that we promise never to open any channel \
889 * other than the main one, which means it can safely use a very \
890 * large window in SSH-2. \
892 X(INT, NONE, ssh_simple) \
893 X(INT, NONE, ssh_connection_sharing) \
894 X(INT, NONE, ssh_connection_sharing_upstream) \
895 X(INT, NONE, ssh_connection_sharing_downstream) \
897 * ssh_manual_hostkeys is conceptually a set rather than a
898 * dictionary: the string subkeys are the important thing, and the
899 * actual values to which those subkeys map are all "".
901 X(STR, STR, ssh_manual_hostkeys) \
902 /* Options for pterm. Should split out into platform-dependent part. */ \
903 X(INT, NONE, stamp_utmp) \
904 X(INT, NONE, login_shell) \
905 X(INT, NONE, scrollbar_on_left) \
906 X(INT, NONE, shadowbold) \
907 X(FONT, NONE, boldfont) \
908 X(FONT, NONE, widefont) \
909 X(FONT, NONE, wideboldfont) \
910 X(INT, NONE, shadowboldoffset) \
911 X(INT, NONE, crhaslf) \
912 X(STR, NONE, winclass) \
914 /* Now define the actual enum of option keywords using that macro. */
915 #define CONF_ENUM_DEF(valtype, keytype, keyword) CONF_ ## keyword,
916 enum config_primary_key { CONFIG_OPTIONS(CONF_ENUM_DEF) N_CONFIG_OPTIONS };
919 #define NCFGCOLOURS 22 /* number of colours in CONF_colours above */
921 /* Functions handling configuration structures. */
922 Conf *conf_new(void); /* create an empty configuration */
923 void conf_free(Conf *conf);
924 Conf *conf_copy(Conf *oldconf);
925 void conf_copy_into(Conf *dest, Conf *src);
926 /* Mandatory accessor functions: enforce by assertion that keys exist. */
927 int conf_get_int(Conf *conf, int key);
928 int conf_get_int_int(Conf *conf, int key, int subkey);
929 char *conf_get_str(Conf *conf, int key); /* result still owned by conf */
930 char *conf_get_str_str(Conf *conf, int key, const char *subkey);
931 Filename *conf_get_filename(Conf *conf, int key);
932 FontSpec *conf_get_fontspec(Conf *conf, int key); /* still owned by conf */
933 /* Optional accessor function: return NULL if key does not exist. */
934 char *conf_get_str_str_opt(Conf *conf, int key, const char *subkey);
935 /* Accessor function to step through a string-subkeyed list.
936 * Returns the next subkey after the provided one, or the first if NULL.
937 * Returns NULL if there are none left.
938 * Both the return value and *subkeyout are still owned by conf. */
939 char *conf_get_str_strs(Conf *conf, int key, char *subkeyin, char **subkeyout);
940 /* Return the nth string subkey in a list. Owned by conf. NULL if beyond end */
941 char *conf_get_str_nthstrkey(Conf *conf, int key, int n);
942 /* Functions to set entries in configuration. Always copy their inputs. */
943 void conf_set_int(Conf *conf, int key, int value);
944 void conf_set_int_int(Conf *conf, int key, int subkey, int value);
945 void conf_set_str(Conf *conf, int key, const char *value);
946 void conf_set_str_str(Conf *conf, int key,
947 const char *subkey, const char *val);
948 void conf_del_str_str(Conf *conf, int key, const char *subkey);
949 void conf_set_filename(Conf *conf, int key, const Filename *val);
950 void conf_set_fontspec(Conf *conf, int key, const FontSpec *val);
951 /* Serialisation functions for Duplicate Session */
952 int conf_serialised_size(Conf *conf);
953 void conf_serialise(Conf *conf, void *data);
954 int conf_deserialise(Conf *conf, void *data, int maxsize);/*returns size used*/
957 * Functions to copy, free, serialise and deserialise FontSpecs.
958 * Provided per-platform, to go with the platform's idea of a
959 * FontSpec's contents.
961 * fontspec_serialise returns the number of bytes written, and can
962 * handle data==NULL without crashing. So you can call it once to find
963 * out a size, then again once you've allocated a buffer.
965 FontSpec *fontspec_copy(const FontSpec *f);
966 void fontspec_free(FontSpec *f);
967 int fontspec_serialise(FontSpec *f, void *data);
968 FontSpec *fontspec_deserialise(void *data, int maxsize, int *used);
971 * Exports from noise.c.
973 void noise_get_heavy(void (*func) (void *, int));
974 void noise_get_light(void (*func) (void *, int));
975 void noise_regular(void);
976 void noise_ultralight(unsigned long data);
977 void random_save_seed(void);
978 void random_destroy_seed(void);
981 * Exports from settings.c.
983 Backend *backend_from_name(const char *name);
984 Backend *backend_from_proto(int proto);
985 char *get_remote_username(Conf *conf); /* dynamically allocated */
986 char *save_settings(const char *section, Conf *conf);
987 void save_open_settings(void *sesskey, Conf *conf);
988 void load_settings(const char *section, Conf *conf);
989 void load_open_settings(void *sesskey, Conf *conf);
990 void get_sesslist(struct sesslist *, int allocate);
991 void do_defaults(const char *, Conf *);
992 void registry_cleanup(void);
995 * Functions used by settings.c to provide platform-specific
998 * (The integer one is expected to return `def' if it has no clear
999 * opinion of its own. This is because there's no integer value
1000 * which I can reliably set aside to indicate `nil'. The string
1001 * function is perfectly all right returning NULL, of course. The
1002 * Filename and FontSpec functions are _not allowed_ to fail to
1003 * return, since these defaults _must_ be per-platform.)
1005 * The 'Filename *' returned by platform_default_filename, and the
1006 * 'FontSpec *' returned by platform_default_fontspec, have ownership
1007 * transferred to the caller, and must be freed.
1009 char *platform_default_s(const char *name);
1010 int platform_default_i(const char *name, int def);
1011 Filename *platform_default_filename(const char *name);
1012 FontSpec *platform_default_fontspec(const char *name);
1015 * Exports from terminal.c.
1018 Terminal *term_init(Conf *, struct unicode_data *, void *);
1019 void term_free(Terminal *);
1020 void term_size(Terminal *, int, int, int);
1021 void term_paint(Terminal *, Context, int, int, int, int, int);
1022 void term_scroll(Terminal *, int, int);
1023 void term_scroll_to_selection(Terminal *, int);
1024 void term_pwron(Terminal *, int);
1025 void term_clrsb(Terminal *);
1026 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
1027 int,int,int,int,int);
1028 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
1030 void term_deselect(Terminal *);
1031 void term_update(Terminal *);
1032 void term_invalidate(Terminal *);
1033 void term_blink(Terminal *, int set_cursor);
1034 void term_do_paste(Terminal *);
1035 void term_nopaste(Terminal *);
1036 int term_ldisc(Terminal *, int option);
1037 void term_copyall(Terminal *);
1038 void term_reconfig(Terminal *, Conf *);
1039 void term_seen_key_event(Terminal *);
1040 int term_data(Terminal *, int is_stderr, const char *data, int len);
1041 int term_data_untrusted(Terminal *, const char *data, int len);
1042 void term_provide_resize_fn(Terminal *term,
1043 void (*resize_fn)(void *, int, int),
1045 void term_provide_logctx(Terminal *term, void *logctx);
1046 void term_set_focus(Terminal *term, int has_focus);
1047 char *term_get_ttymode(Terminal *term, const char *mode);
1048 int term_get_userpass_input(Terminal *term, prompts_t *p,
1049 const unsigned char *in, int inlen);
1051 int format_arrow_key(char *buf, Terminal *term, int xkey, int ctrl);
1054 * Exports from logging.c.
1056 void *log_init(void *frontend, Conf *conf);
1057 void log_free(void *logctx);
1058 void log_reconfig(void *logctx, Conf *conf);
1059 void logfopen(void *logctx);
1060 void logfclose(void *logctx);
1061 void logtraffic(void *logctx, unsigned char c, int logmode);
1062 void logflush(void *logctx);
1063 void log_eventlog(void *logctx, const char *string);
1064 enum { PKT_INCOMING, PKT_OUTGOING };
1065 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
1071 void log_packet(void *logctx, int direction, int type,
1072 const char *texttype, const void *data, int len,
1073 int n_blanks, const struct logblank_t *blanks,
1074 const unsigned long *sequence,
1075 unsigned downstream_id, const char *additional_log_text);
1078 * Exports from testback.c
1081 extern Backend null_backend;
1082 extern Backend loop_backend;
1085 * Exports from raw.c.
1088 extern Backend raw_backend;
1091 * Exports from rlogin.c.
1094 extern Backend rlogin_backend;
1097 * Exports from telnet.c.
1100 extern Backend telnet_backend;
1103 * Exports from ssh.c.
1105 extern Backend ssh_backend;
1108 * Exports from ldisc.c.
1110 void *ldisc_create(Conf *, Terminal *, Backend *, void *, void *);
1111 void ldisc_configure(void *, Conf *);
1112 void ldisc_free(void *);
1113 void ldisc_send(void *handle, const char *buf, int len, int interactive);
1114 void ldisc_echoedit_update(void *handle);
1117 * Exports from ldiscucs.c.
1119 void lpage_send(void *, int codepage, const char *buf, int len,
1121 void luni_send(void *, const wchar_t * widebuf, int len, int interactive);
1124 * Exports from sshrand.c.
1127 void random_add_noise(void *noise, int length);
1128 int random_byte(void);
1129 void random_get_savedata(void **data, int *len);
1130 extern int random_active;
1131 /* The random number subsystem is activated if at least one other entity
1132 * within the program expresses an interest in it. So each SSH session
1133 * calls random_ref on startup and random_unref on shutdown. */
1134 void random_ref(void);
1135 void random_unref(void);
1138 * Exports from pinger.c.
1140 typedef struct pinger_tag *Pinger;
1141 Pinger pinger_new(Conf *conf, Backend *back, void *backhandle);
1142 void pinger_reconfig(Pinger, Conf *oldconf, Conf *newconf);
1143 void pinger_free(Pinger);
1146 * Exports from misc.c.
1150 int conf_launchable(Conf *conf);
1151 char const *conf_dest(Conf *conf);
1154 * Exports from sercfg.c.
1156 void ser_setup_config_box(struct controlbox *b, int midsession,
1157 int parity_mask, int flow_mask);
1160 * Exports from version.c.
1162 extern const char ver[];
1165 * Exports from unicode.c.
1168 #define CP_UTF8 65001
1170 /* void init_ucs(void); -- this is now in platform-specific headers */
1171 int is_dbcs_leadbyte(int codepage, char byte);
1172 int mb_to_wc(int codepage, int flags, const char *mbstr, int mblen,
1173 wchar_t *wcstr, int wclen);
1174 int wc_to_mb(int codepage, int flags, const wchar_t *wcstr, int wclen,
1175 char *mbstr, int mblen, const char *defchr, int *defused,
1176 struct unicode_data *ucsdata);
1177 wchar_t xlat_uskbd2cyrllic(int ch);
1178 int check_compose(int first, int second);
1179 int decode_codepage(char *cp_name);
1180 const char *cp_enumerate (int index);
1181 const char *cp_name(int codepage);
1182 void get_unitab(int codepage, wchar_t * unitab, int ftype);
1185 * Exports from wcwidth.c
1187 int mk_wcwidth(unsigned int ucs);
1188 int mk_wcswidth(const unsigned int *pwcs, size_t n);
1189 int mk_wcwidth_cjk(unsigned int ucs);
1190 int mk_wcswidth_cjk(const unsigned int *pwcs, size_t n);
1193 * Exports from mscrypto.c
1196 int crypto_startup();
1197 void crypto_wrapup();
1201 * Exports from pageantc.c.
1203 * agent_query returns NULL for here's-a-response, and non-NULL for
1204 * query-in- progress. In the latter case there will be a call to
1205 * `callback' at some future point, passing callback_ctx as the first
1206 * parameter and the actual reply data as the second and third.
1208 * The response may be a NULL pointer (in either of the synchronous
1209 * or asynchronous cases), which indicates failure to receive a
1212 * When the return from agent_query is not NULL, it identifies the
1213 * in-progress query in case it needs to be cancelled. If
1214 * agent_cancel_query is called, then the pending query is destroyed
1215 * and the callback will not be called. (E.g. if you're going to throw
1216 * away the thing you were using as callback_ctx.)
1218 * Passing a null pointer as callback forces agent_query to behave
1219 * synchronously, i.e. it will block if necessary, and guarantee to
1220 * return NULL. The wrapper function agent_query_synchronous() makes
1223 typedef struct agent_pending_query agent_pending_query;
1224 agent_pending_query *agent_query(
1225 void *in, int inlen, void **out, int *outlen,
1226 void (*callback)(void *, void *, int), void *callback_ctx);
1227 void agent_cancel_query(agent_pending_query *);
1228 void agent_query_synchronous(void *in, int inlen, void **out, int *outlen);
1229 int agent_exists(void);
1232 * Exports from wildcard.c
1234 const char *wc_error(int value);
1235 int wc_match(const char *wildcard, const char *target);
1236 int wc_unescape(char *output, const char *wildcard);
1239 * Exports from frontend (windlg.c etc)
1241 void logevent(void *frontend, const char *);
1242 void pgp_fingerprints(void);
1244 * verify_ssh_host_key() can return one of three values:
1246 * - +1 means `key was OK' (either already known or the user just
1247 * approved it) `so continue with the connection'
1249 * - 0 means `key was not OK, abandon the connection'
1251 * - -1 means `I've initiated enquiries, please wait to be called
1252 * back via the provided function with a result that's either 0
1255 int verify_ssh_host_key(void *frontend, char *host, int port,
1256 const char *keytype, char *keystr, char *fingerprint,
1257 void (*callback)(void *ctx, int result), void *ctx);
1259 * have_ssh_host_key() just returns true if a key of that type is
1260 * already cached and false otherwise.
1262 int have_ssh_host_key(const char *host, int port, const char *keytype);
1264 * askalg and askhk have the same set of return values as
1265 * verify_ssh_host_key.
1267 * (askhk is used in the case where we're using a host key below the
1268 * warning threshold because that's all we have cached, but at least
1269 * one acceptable algorithm is available that we don't have cached.)
1271 int askalg(void *frontend, const char *algtype, const char *algname,
1272 void (*callback)(void *ctx, int result), void *ctx);
1273 int askhk(void *frontend, const char *algname, const char *betteralgs,
1274 void (*callback)(void *ctx, int result), void *ctx);
1276 * askappend can return four values:
1278 * - 2 means overwrite the log file
1279 * - 1 means append to the log file
1280 * - 0 means cancel logging for this session
1281 * - -1 means please wait.
1283 int askappend(void *frontend, Filename *filename,
1284 void (*callback)(void *ctx, int result), void *ctx);
1287 * Exports from console frontends (wincons.c, uxcons.c)
1288 * that aren't equivalents to things in windlg.c et al.
1290 extern int console_batch_mode;
1291 int console_get_userpass_input(prompts_t *p, const unsigned char *in,
1293 void console_provide_logctx(void *logctx);
1294 int is_interactive(void);
1297 * Exports from printing.c.
1299 typedef struct printer_enum_tag printer_enum;
1300 typedef struct printer_job_tag printer_job;
1301 printer_enum *printer_start_enum(int *nprinters);
1302 char *printer_get_name(printer_enum *, int);
1303 void printer_finish_enum(printer_enum *);
1304 printer_job *printer_start_job(char *printer);
1305 void printer_job_data(printer_job *, void *, int);
1306 void printer_finish_job(printer_job *);
1309 * Exports from cmdline.c (and also cmdline_error(), which is
1310 * defined differently in various places and required _by_
1313 * Note that cmdline_process_param takes a const option string, but a
1314 * writable argument string. That's not a mistake - that's so it can
1315 * zero out password arguments in the hope of not having them show up
1316 * avoidably in Unix 'ps'.
1318 int cmdline_process_param(const char *, char *, int, Conf *);
1319 void cmdline_run_saved(Conf *);
1320 void cmdline_cleanup(void);
1321 int cmdline_get_passwd_input(prompts_t *p, const unsigned char *in, int inlen);
1322 #define TOOLTYPE_FILETRANSFER 1
1323 #define TOOLTYPE_NONNETWORK 2
1324 extern int cmdline_tooltype;
1326 void cmdline_error(const char *, ...);
1329 * Exports from config.c.
1333 void conf_radiobutton_handler(union control *ctrl, void *dlg,
1334 void *data, int event);
1335 #define CHECKBOX_INVERT (1<<30)
1336 void conf_checkbox_handler(union control *ctrl, void *dlg,
1337 void *data, int event);
1338 void conf_editbox_handler(union control *ctrl, void *dlg,
1339 void *data, int event);
1340 void conf_filesel_handler(union control *ctrl, void *dlg,
1341 void *data, int event);
1342 void conf_fontsel_handler(union control *ctrl, void *dlg,
1343 void *data, int event);
1344 void setup_config_box(struct controlbox *b, int midsession,
1345 int protocol, int protcfginfo);
1348 * Exports from minibidi.c.
1350 typedef struct bidi_char {
1351 unsigned int origwc, wc;
1352 unsigned short index;
1354 int do_bidi(bidi_char *line, int count);
1355 int do_shape(bidi_char *line, bidi_char *to, int count);
1359 * X11 auth mechanisms we know about.
1363 X11_MIT, /* MIT-MAGIC-COOKIE-1 */
1364 X11_XDM, /* XDM-AUTHORIZATION-1 */
1367 extern const char *const x11_authnames[]; /* declared in x11fwd.c */
1370 * Miscellaneous exports from the platform-specific code.
1372 * filename_serialise and filename_deserialise have the same semantics
1373 * as fontspec_serialise and fontspec_deserialise above.
1375 Filename *filename_from_str(const char *string);
1376 const char *filename_to_str(const Filename *fn);
1377 int filename_equal(const Filename *f1, const Filename *f2);
1378 int filename_is_null(const Filename *fn);
1379 Filename *filename_copy(const Filename *fn);
1380 void filename_free(Filename *fn);
1381 int filename_serialise(const Filename *f, void *data);
1382 Filename *filename_deserialise(void *data, int maxsize, int *used);
1383 char *get_username(void); /* return value needs freeing */
1384 char *get_random_data(int bytes, const char *device); /* used in cmdgen.c */
1385 char filename_char_sanitise(char c); /* rewrite special pathname chars */
1388 * Exports and imports from timing.c.
1390 * schedule_timer() asks the front end to schedule a callback to a
1391 * timer function in a given number of ticks. The returned value is
1392 * the time (in ticks since an arbitrary offset) at which the
1393 * callback can be expected. This value will also be passed as the
1394 * `now' parameter to the callback function. Hence, you can (for
1395 * example) schedule an event at a particular time by calling
1396 * schedule_timer() and storing the return value in your context
1397 * structure as the time when that event is due. The first time a
1398 * callback function gives you that value or more as `now', you do
1401 * expire_timer_context() drops all current timers associated with
1402 * a given value of ctx (for when you're about to free ctx).
1404 * run_timers() is called from the front end when it has reason to
1405 * think some timers have reached their moment, or when it simply
1406 * needs to know how long to wait next. We pass it the time we
1407 * think it is. It returns TRUE and places the time when the next
1408 * timer needs to go off in `next', or alternatively it returns
1409 * FALSE if there are no timers at all pending.
1411 * timer_change_notify() must be supplied by the front end; it
1412 * notifies the front end that a new timer has been added to the
1413 * list which is sooner than any existing ones. It provides the
1414 * time when that timer needs to go off.
1416 * *** FRONT END IMPLEMENTORS NOTE:
1418 * There's an important subtlety in the front-end implementation of
1419 * the timer interface. When a front end is given a `next' value,
1420 * either returned from run_timers() or via timer_change_notify(),
1421 * it should ensure that it really passes _that value_ as the `now'
1422 * parameter to its next run_timers call. It should _not_ simply
1423 * call GETTICKCOUNT() to get the `now' parameter when invoking
1426 * The reason for this is that an OS's system clock might not agree
1427 * exactly with the timing mechanisms it supplies to wait for a
1428 * given interval. I'll illustrate this by the simple example of
1429 * Unix Plink, which uses timeouts to select() in a way which for
1430 * these purposes can simply be considered to be a wait() function.
1431 * Suppose, for the sake of argument, that this wait() function
1432 * tends to return early by 1%. Then a possible sequence of actions
1435 * - run_timers() tells the front end that the next timer firing
1436 * is 10000ms from now.
1437 * - Front end calls wait(10000ms), but according to
1438 * GETTICKCOUNT() it has only waited for 9900ms.
1439 * - Front end calls run_timers() again, passing time T-100ms as
1441 * - run_timers() does nothing, and says the next timer firing is
1442 * still 100ms from now.
1443 * - Front end calls wait(100ms), which only waits for 99ms.
1444 * - Front end calls run_timers() yet again, passing time T-1ms.
1445 * - run_timers() says there's still 1ms to wait.
1446 * - Front end calls wait(1ms).
1448 * If you're _lucky_ at this point, wait(1ms) will actually wait
1449 * for 1ms and you'll only have woken the program up three times.
1450 * If you're unlucky, wait(1ms) might do nothing at all due to
1451 * being below some minimum threshold, and you might find your
1452 * program spends the whole of the last millisecond tight-looping
1453 * between wait() and run_timers().
1455 * Instead, what you should do is to _save_ the precise `next'
1456 * value provided by run_timers() or via timer_change_notify(), and
1457 * use that precise value as the input to the next run_timers()
1460 * - run_timers() tells the front end that the next timer firing
1461 * is at time T, 10000ms from now.
1462 * - Front end calls wait(10000ms).
1463 * - Front end then immediately calls run_timers() and passes it
1464 * time T, without stopping to check GETTICKCOUNT() at all.
1466 * This guarantees that the program wakes up only as many times as
1467 * there are actual timer actions to be taken, and that the timing
1468 * mechanism will never send it into a tight loop.
1470 * (It does also mean that the timer action in the above example
1471 * will occur 100ms early, but this is not generally critical. And
1472 * the hypothetical 1% error in wait() will be partially corrected
1473 * for anyway when, _after_ run_timers() returns, you call
1474 * GETTICKCOUNT() and compare the result with the returned `next'
1475 * value to find out how long you have to make your next wait().)
1477 typedef void (*timer_fn_t)(void *ctx, unsigned long now);
1478 unsigned long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
1479 void expire_timer_context(void *ctx);
1480 int run_timers(unsigned long now, unsigned long *next);
1481 void timer_change_notify(unsigned long next);
1482 unsigned long timing_last_clock(void);
1485 * Exports from callback.c.
1487 * This provides a method of queuing function calls to be run at the
1488 * earliest convenience from the top-level event loop. Use it if
1489 * you're deep in a nested chain of calls and want to trigger an
1490 * action which will probably lead to your function being re-entered
1491 * recursively if you just call the initiating function the normal
1494 * Most front ends run the queued callbacks by simply calling
1495 * run_toplevel_callbacks() after handling each event in their
1496 * top-level event loop. However, if a front end doesn't have control
1497 * over its own event loop (e.g. because it's using GTK) then it can
1498 * instead request notifications when a callback is available, so that
1499 * it knows to ask its delegate event loop to do the same thing. Also,
1500 * if a front end needs to know whether a callback is pending without
1501 * actually running it (e.g. so as to put a zero timeout on a select()
1502 * call) then it can call toplevel_callback_pending(), which will
1503 * return true if at least one callback is in the queue.
1505 typedef void (*toplevel_callback_fn_t)(void *ctx);
1506 void queue_toplevel_callback(toplevel_callback_fn_t fn, void *ctx);
1507 void run_toplevel_callbacks(void);
1508 int toplevel_callback_pending(void);
1510 typedef void (*toplevel_callback_notify_fn_t)(void *frontend);
1511 void request_callback_notifications(toplevel_callback_notify_fn_t notify,
1515 * Define no-op macros for the jump list functions, on platforms that
1516 * don't support them. (This is a bit of a hack, and it'd be nicer to
1517 * localise even the calls to those functions into the Windows front
1518 * end, but it'll do for the moment.)
1520 #ifndef JUMPLIST_SUPPORTED
1521 #define add_session_to_jumplist(x) ((void)0)
1522 #define remove_session_from_jumplist(x) ((void)0)
1525 /* SURROGATE PAIR */
1526 #define HIGH_SURROGATE_START 0xd800
1527 #define HIGH_SURROGATE_END 0xdbff
1528 #define LOW_SURROGATE_START 0xdc00
1529 #define LOW_SURROGATE_END 0xdfff
1531 /* These macros exist in the Windows API, so the environment may
1532 * provide them. If not, define them in terms of the above. */
1533 #ifndef IS_HIGH_SURROGATE
1534 #define IS_HIGH_SURROGATE(wch) (((wch) >= HIGH_SURROGATE_START) && \
1535 ((wch) <= HIGH_SURROGATE_END))
1536 #define IS_LOW_SURROGATE(wch) (((wch) >= LOW_SURROGATE_START) && \
1537 ((wch) <= LOW_SURROGATE_END))
1538 #define IS_SURROGATE_PAIR(hs, ls) (IS_HIGH_SURROGATE(hs) && \
1539 IS_LOW_SURROGATE(ls))
1543 #define IS_SURROGATE(wch) (((wch) >= HIGH_SURROGATE_START) && \
1544 ((wch) <= LOW_SURROGATE_END))
1545 #define HIGH_SURROGATE_OF(codept) \
1546 (HIGH_SURROGATE_START + (((codept) - 0x10000) >> 10))
1547 #define LOW_SURROGATE_OF(codept) \
1548 (LOW_SURROGATE_START + (((codept) - 0x10000) & 0x3FF))
1549 #define FROM_SURROGATES(wch1, wch2) \
1550 (0x10000 + (((wch1) & 0x3FF) << 10) + ((wch2) & 0x3FF))