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