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