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