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 |
f7f27309 |
21 | typedef struct config_tag Config; |
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 | |
4eeb7d09 |
30 | /* Three attribute types: |
50c1be3f |
31 | * The ATTRs (normal attributes) are stored with the characters in |
32 | * the main display arrays |
4eeb7d09 |
33 | * |
50c1be3f |
34 | * The TATTRs (temporary attributes) are generated on the fly, they |
35 | * can overlap with characters but not with normal attributes. |
4eeb7d09 |
36 | * |
50c1be3f |
37 | * The LATTRs (line attributes) are an entirely disjoint space of |
38 | * flags. |
fd59420d |
39 | * |
40 | * The DATTRs (display attributes) are internal to terminal.c (but |
41 | * defined here because their values have to match the others |
42 | * here); they reuse the TATTR_* space but are always masked off |
43 | * before sending to the front end. |
4eeb7d09 |
44 | * |
45 | * ATTR_INVALID is an illegal colour combination. |
46 | */ |
47 | |
36566009 |
48 | #define TATTR_ACTCURS 0x40000000UL /* active cursor (block) */ |
49 | #define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */ |
50 | #define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */ |
c6958dfe |
51 | #define TATTR_COMBINING 0x80000000UL /* combining characters */ |
374330e2 |
52 | |
fd59420d |
53 | #define DATTR_STARTRUN 0x80000000UL /* start of redraw run */ |
54 | |
55 | #define TDATTR_MASK 0xF0000000UL |
56 | #define TATTR_MASK (TDATTR_MASK) |
57 | #define DATTR_MASK (TDATTR_MASK) |
58 | |
c9def1b8 |
59 | #define LATTR_NORM 0x00000000UL |
36566009 |
60 | #define LATTR_WIDE 0x00000001UL |
61 | #define LATTR_TOP 0x00000002UL |
62 | #define LATTR_BOT 0x00000003UL |
63 | #define LATTR_MODE 0x00000003UL |
64 | #define LATTR_WRAPPED 0x00000010UL |
65 | #define LATTR_WRAPPED2 0x00000020UL |
4eeb7d09 |
66 | |
fd59420d |
67 | #define ATTR_INVALID 0x03FFFFU |
4eeb7d09 |
68 | |
69 | /* Like Linux use the F000 page for direct to font. */ |
36566009 |
70 | #define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */ |
71 | #define CSET_ACP 0x0000F100UL /* Ansi Codepage DTF */ |
4eeb7d09 |
72 | |
73 | /* These are internal use overlapping with the UTF-16 surrogates */ |
36566009 |
74 | #define CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */ |
75 | #define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */ |
76 | #define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */ |
77 | #define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */ |
78 | #define CSET_MASK 0xFFFFFF00UL /* Character set mask */ |
4eeb7d09 |
79 | |
36566009 |
80 | #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800) |
81 | #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000) |
4eeb7d09 |
82 | |
36566009 |
83 | #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */ |
3c7366f8 |
84 | /* |
85 | * UCSWIDE is a special value used in the terminal data to signify |
86 | * the character cell containing the right-hand half of a CJK wide |
87 | * character. We use 0xDFFF because it's part of the surrogate |
88 | * range and hence won't be used for anything else (it's impossible |
89 | * to input it via UTF-8 because our UTF-8 decoder correctly |
90 | * rejects surrogates). |
91 | */ |
92 | #define UCSWIDE 0xDFFF |
4eeb7d09 |
93 | |
cecb13f6 |
94 | #define ATTR_NARROW 0x800000U |
95 | #define ATTR_WIDE 0x400000U |
96 | #define ATTR_BOLD 0x040000U |
97 | #define ATTR_UNDER 0x080000U |
98 | #define ATTR_REVERSE 0x100000U |
99 | #define ATTR_BLINK 0x200000U |
100 | #define ATTR_FGMASK 0x0001FFU |
101 | #define ATTR_BGMASK 0x03FE00U |
102 | #define ATTR_COLOURS 0x03FFFFU |
36566009 |
103 | #define ATTR_FGSHIFT 0 |
cecb13f6 |
104 | #define ATTR_BGSHIFT 9 |
36566009 |
105 | |
cecb13f6 |
106 | /* |
107 | * The definitive list of colour numbers stored in terminal |
108 | * attribute words is kept here. It is: |
109 | * |
110 | * - 0-7 are ANSI colours (KRGYBMCW). |
111 | * - 8-15 are the bold versions of those colours. |
112 | * - 16-255 are the remains of the xterm 256-colour mode (a |
113 | * 216-colour cube with R at most significant and B at least, |
114 | * followed by a uniform series of grey shades running between |
115 | * black and white but not including either on grounds of |
116 | * redundancy). |
117 | * - 256 is default foreground |
118 | * - 257 is default bold foreground |
119 | * - 258 is default background |
120 | * - 259 is default bold background |
121 | * - 260 is cursor foreground |
122 | * - 261 is cursor background |
123 | */ |
4eeb7d09 |
124 | |
cecb13f6 |
125 | #define ATTR_DEFFG (256 << ATTR_FGSHIFT) |
126 | #define ATTR_DEFBG (258 << ATTR_BGSHIFT) |
127 | #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG) |
374330e2 |
128 | |
0b4f0bc0 |
129 | struct sesslist { |
130 | int nsessions; |
131 | char **sessions; |
132 | char *buffer; /* so memory can be freed later */ |
133 | }; |
1709795f |
134 | |
21d2b241 |
135 | struct unicode_data { |
136 | char **uni_tbl; |
137 | int dbcs_screenfont; |
138 | int font_codepage; |
139 | int line_codepage; |
140 | wchar_t unitab_scoacs[256]; |
141 | wchar_t unitab_line[256]; |
142 | wchar_t unitab_font[256]; |
143 | wchar_t unitab_xterm[256]; |
144 | wchar_t unitab_oemcp[256]; |
145 | unsigned char unitab_ctrl[256]; |
146 | }; |
4eeb7d09 |
147 | |
32874aea |
148 | #define LGXF_OVR 1 /* existing logfile overwrite */ |
149 | #define LGXF_APN 0 /* existing logfile append */ |
150 | #define LGXF_ASK -1 /* existing logfile ask */ |
151 | #define LGTYP_NONE 0 /* logmode: no logging */ |
152 | #define LGTYP_ASCII 1 /* logmode: pure ascii */ |
00db133f |
153 | #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */ |
154 | #define LGTYP_PACKETS 3 /* logmode: SSH data packets */ |
5fd04f07 |
155 | |
374330e2 |
156 | typedef enum { |
6f2d0cde |
157 | /* Actual special commands. Originally Telnet, but some codes have |
158 | * been re-used for similar specials in other protocols. */ |
374330e2 |
159 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
a5f3e637 |
160 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING, |
6f2d0cde |
161 | TS_EOL, |
4423d5c7 |
162 | /* Special command for SSH. */ |
163 | TS_REKEY, |
6f2d0cde |
164 | /* POSIX-style signals. (not Telnet) */ |
165 | TS_SIGABRT, TS_SIGALRM, TS_SIGFPE, TS_SIGHUP, TS_SIGILL, |
166 | TS_SIGINT, TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV, |
167 | TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2, |
168 | /* Pseudo-specials used for constructing the specials menu. */ |
169 | TS_SEP, /* Separator */ |
170 | TS_SUBMENU, /* Start a new submenu with specified name */ |
171 | TS_EXITMENU /* Exit current submenu or end of specials */ |
374330e2 |
172 | } Telnet_Special; |
173 | |
125105d1 |
174 | struct telnet_special { |
6f2d0cde |
175 | const char *name; |
125105d1 |
176 | int code; |
177 | }; |
178 | |
374330e2 |
179 | typedef enum { |
01c034ad |
180 | MBT_NOTHING, |
181 | MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */ |
182 | MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */ |
183 | MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */ |
374330e2 |
184 | } Mouse_Button; |
185 | |
186 | typedef enum { |
187 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
188 | } Mouse_Action; |
189 | |
6c50d421 |
190 | /* Keyboard modifiers -- keys the user is actually holding down */ |
191 | |
192 | #define PKM_SHIFT 0x01 |
193 | #define PKM_CONTROL 0x02 |
194 | #define PKM_META 0x04 |
195 | #define PKM_ALT 0x08 |
196 | |
197 | /* Keyboard flags that aren't really modifiers */ |
198 | #define PKF_CAPSLOCK 0x10 |
199 | #define PKF_NUMLOCK 0x20 |
200 | #define PKF_REPEAT 0x40 |
201 | |
202 | /* Stand-alone keysyms for function keys */ |
203 | |
204 | typedef enum { |
205 | PK_NULL, /* No symbol for this key */ |
206 | /* Main keypad keys */ |
207 | PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE, |
208 | /* Editing keys */ |
209 | PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN, |
210 | /* Cursor keys */ |
211 | PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST, |
212 | /* Numeric keypad */ /* Real one looks like: */ |
213 | PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */ |
214 | PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */ |
215 | PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */ |
216 | PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */ |
217 | PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */ |
218 | /* Top row */ |
219 | PK_F1, PK_F2, PK_F3, PK_F4, PK_F5, |
220 | PK_F6, PK_F7, PK_F8, PK_F9, PK_F10, |
221 | PK_F11, PK_F12, PK_F13, PK_F14, PK_F15, |
222 | PK_F16, PK_F17, PK_F18, PK_F19, PK_F20, |
223 | PK_PAUSE |
224 | } Key_Sym; |
225 | |
226 | #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN) |
227 | #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST) |
228 | #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER) |
229 | #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20) |
230 | |
5ecd7ad0 |
231 | enum { |
4eeb7d09 |
232 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE |
5ecd7ad0 |
233 | }; |
374330e2 |
234 | |
0965bee0 |
235 | enum { |
236 | /* |
83e7d008 |
237 | * SSH-2 key exchange algorithms |
238 | */ |
239 | KEX_WARN, |
240 | KEX_DHGROUP1, |
241 | KEX_DHGROUP14, |
242 | KEX_DHGEX, |
243 | KEX_MAX |
244 | }; |
245 | |
246 | enum { |
247 | /* |
ca20bfcf |
248 | * SSH ciphers (both SSH1 and SSH2) |
249 | */ |
250 | CIPHER_WARN, /* pseudo 'cipher' */ |
251 | CIPHER_3DES, |
252 | CIPHER_BLOWFISH, |
253 | CIPHER_AES, /* (SSH 2 only) */ |
7f1ae1d2 |
254 | CIPHER_DES, |
ca20bfcf |
255 | CIPHER_MAX /* no. ciphers (inc warn) */ |
256 | }; |
257 | |
258 | enum { |
259 | /* |
5ecd7ad0 |
260 | * Several different bits of the PuTTY configuration seem to be |
261 | * three-way settings whose values are `always yes', `always |
262 | * no', and `decide by some more complex automated means'. This |
263 | * is true of line discipline options (local echo and line |
264 | * editing), proxy DNS, Close On Exit, and SSH server bug |
265 | * workarounds. Accordingly I supply a single enum here to deal |
266 | * with them all. |
0965bee0 |
267 | */ |
5ecd7ad0 |
268 | FORCE_ON, FORCE_OFF, AUTO |
269 | }; |
270 | |
271 | enum { |
272 | /* |
273 | * Proxy types. |
274 | */ |
10068a0b |
275 | PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5, |
276 | PROXY_HTTP, PROXY_TELNET, PROXY_CMD |
0965bee0 |
277 | }; |
278 | |
279 | enum { |
280 | /* |
281 | * Line discipline options which the backend might try to control. |
282 | */ |
32874aea |
283 | LD_EDIT, /* local line editing */ |
284 | LD_ECHO /* local echo */ |
0965bee0 |
285 | }; |
286 | |
b41069ff |
287 | enum { |
5ecd7ad0 |
288 | /* Protocol back ends. (cfg.protocol) */ |
289 | PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH |
290 | }; |
291 | |
292 | enum { |
293 | /* Bell settings (cfg.beep) */ |
85f6b361 |
294 | BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER |
5ecd7ad0 |
295 | }; |
296 | |
297 | enum { |
298 | /* Taskbar flashing indication on bell (cfg.beep_ind) */ |
299 | B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY |
300 | }; |
301 | |
302 | enum { |
303 | /* Resize actions (cfg.resize_action) */ |
304 | RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER |
b41069ff |
305 | }; |
306 | |
6c50d421 |
307 | enum { |
308 | /* Function key types (cfg.funky_type) */ |
309 | FUNKY_TILDE, |
310 | FUNKY_LINUX, |
311 | FUNKY_XTERM, |
312 | FUNKY_VT400, |
313 | FUNKY_VT100P, |
314 | FUNKY_SCO |
315 | }; |
316 | |
05581745 |
317 | enum { |
318 | /* |
319 | * Network address types. Used for specifying choice of IPv4/v6 |
320 | * in config; also used in proxy.c to indicate whether a given |
321 | * host name has already been resolved or will be resolved at |
322 | * the proxy end. |
323 | */ |
324 | ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME |
325 | }; |
326 | |
1709795f |
327 | struct backend_tag { |
cbe2d68f |
328 | const char *(*init) (void *frontend_handle, void **backend_handle, |
329 | Config *cfg, |
79bf227b |
330 | char *host, int port, char **realhost, int nodelay, |
331 | int keepalive); |
fabd1805 |
332 | void (*free) (void *handle); |
86916870 |
333 | /* back->reconfig() passes in a replacement configuration. */ |
334 | void (*reconfig) (void *handle, Config *cfg); |
5471d09a |
335 | /* back->send() returns the current amount of buffered data. */ |
51470298 |
336 | int (*send) (void *handle, char *buf, int len); |
5471d09a |
337 | /* back->sendbuffer() does the same thing but without attempting a send */ |
51470298 |
338 | int (*sendbuffer) (void *handle); |
339 | void (*size) (void *handle, int width, int height); |
340 | void (*special) (void *handle, Telnet_Special code); |
125105d1 |
341 | const struct telnet_special *(*get_specials) (void *handle); |
51470298 |
342 | Socket(*socket) (void *handle); |
343 | int (*exitcode) (void *handle); |
344 | int (*sendok) (void *handle); |
345 | int (*ldisc) (void *handle, int); |
b9d7bcad |
346 | void (*provide_ldisc) (void *handle, void *ldisc); |
a8327734 |
347 | void (*provide_logctx) (void *handle, void *logctx); |
5471d09a |
348 | /* |
349 | * back->unthrottle() tells the back end that the front end |
350 | * buffer is clearing. |
351 | */ |
51470298 |
352 | void (*unthrottle) (void *handle, int); |
f89c3294 |
353 | int (*cfg_info) (void *handle); |
97db3be4 |
354 | int default_port; |
1709795f |
355 | }; |
374330e2 |
356 | |
297d398b |
357 | extern struct backend_list { |
89ee5268 |
358 | int protocol; |
359 | char *name; |
360 | Backend *backend; |
361 | } backends[]; |
362 | |
ffa79828 |
363 | /* |
364 | * Suggested default protocol provided by the backend link module. |
365 | * The application is free to ignore this. |
366 | */ |
367 | extern const int be_default_protocol; |
368 | |
5ecd7ad0 |
369 | /* |
47e4e735 |
370 | * Name of this particular application, for use in the config box |
371 | * and other pieces of text. |
372 | */ |
373 | extern const char *const appname; |
374 | |
375 | /* |
5ecd7ad0 |
376 | * IMPORTANT POLICY POINT: everything in this structure which wants |
377 | * to be treated like an integer must be an actual, honest-to- |
378 | * goodness `int'. No enum-typed variables. This is because parts |
379 | * of the code will want to pass around `int *' pointers to them |
380 | * and we can't run the risk of porting to some system on which the |
381 | * enum comes out as a different size from int. |
382 | */ |
f7f27309 |
383 | struct config_tag { |
374330e2 |
384 | /* Basic options */ |
385 | char host[512]; |
386 | int port; |
5ecd7ad0 |
387 | int protocol; |
05581745 |
388 | int addressfamily; |
374330e2 |
389 | int close_on_exit; |
9ef49106 |
390 | int warn_on_close; |
32874aea |
391 | int ping_interval; /* in seconds */ |
2184a5d9 |
392 | int tcp_nodelay; |
79bf227b |
393 | int tcp_keepalives; |
8eebd221 |
394 | /* Proxy options */ |
395 | char proxy_exclude_list[512]; |
5ecd7ad0 |
396 | int proxy_dns; |
b804e1e5 |
397 | int even_proxy_localhost; |
5ecd7ad0 |
398 | int proxy_type; |
8eebd221 |
399 | char proxy_host[512]; |
400 | int proxy_port; |
f33ba69e |
401 | char proxy_username[128]; |
402 | char proxy_password[128]; |
8eebd221 |
403 | char proxy_telnet_command[512]; |
fef97f43 |
404 | /* SSH options */ |
6abbf9e3 |
405 | char remote_cmd[512]; |
fd5e5847 |
406 | char remote_cmd2[512]; /* fallback if the first fails |
407 | * (used internally for scp) */ |
32874aea |
408 | char *remote_cmd_ptr; /* might point to a larger command |
409 | * but never for loading/saving */ |
fd5e5847 |
410 | char *remote_cmd_ptr2; /* might point to a larger command |
411 | * but never for loading/saving */ |
fef97f43 |
412 | int nopty; |
4ba9b64b |
413 | int compression; |
83e7d008 |
414 | int ssh_kexlist[KEX_MAX]; |
d57f70af |
415 | int ssh_rekey_time; /* in minutes */ |
416 | char ssh_rekey_data[16]; |
979310f1 |
417 | int agentfwd; |
5bb641e1 |
418 | int change_username; /* allow username switching in SSH2 */ |
ca20bfcf |
419 | int ssh_cipherlist[CIPHER_MAX]; |
9a30e26b |
420 | Filename keyfile; |
32874aea |
421 | int sshprot; /* use v1 or v2 when both available */ |
cb4d4768 |
422 | int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */ |
ccbfb941 |
423 | int try_tis_auth; |
f091e308 |
424 | int try_ki_auth; |
4a8fc3c4 |
425 | int ssh_subsys; /* run a subsystem rather than a command */ |
fd5e5847 |
426 | int ssh_subsys2; /* fallback to go with remote_cmd2 */ |
0ed48730 |
427 | int ssh_no_shell; /* avoid running a shell */ |
374330e2 |
428 | /* Telnet options */ |
429 | char termtype[32]; |
430 | char termspeed[32]; |
32874aea |
431 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
277fc55e |
432 | char username[100]; |
433 | char localusername[100]; |
374330e2 |
434 | int rfc_environ; |
8faa456c |
435 | int passive_telnet; |
374330e2 |
436 | /* Keyboard options */ |
437 | int bksp_is_delete; |
438 | int rxvt_homeend; |
c9def1b8 |
439 | int funky_type; |
32874aea |
440 | int no_applic_c; /* totally disable app cursor keys */ |
441 | int no_applic_k; /* totally disable app keypad */ |
c0d36a72 |
442 | int no_mouse_rep; /* totally disable mouse reporting */ |
0d2086c5 |
443 | int no_remote_resize; /* disable remote resizing */ |
444 | int no_alt_screen; /* disable alternate screen */ |
445 | int no_remote_wintitle; /* disable remote retitling */ |
446 | int no_dbackspace; /* disable destructive backspace */ |
447 | int no_remote_charset; /* disable remote charset config */ |
7fcdebd3 |
448 | int no_remote_qtitle; /* disable remote win title query */ |
374330e2 |
449 | int app_cursor; |
450 | int app_keypad; |
c5e9c988 |
451 | int nethack_keypad; |
a5f3e637 |
452 | int telnet_keyboard; |
eee63b77 |
453 | int telnet_newline; |
c5e9c988 |
454 | int alt_f4; /* is it special? */ |
455 | int alt_space; /* is it special? */ |
a094ae43 |
456 | int alt_only; /* is it special? */ |
0965bee0 |
457 | int localecho; |
458 | int localedit; |
e95edc00 |
459 | int alwaysontop; |
8f57d753 |
460 | int fullscreenonaltenter; |
c9def1b8 |
461 | int scroll_on_key; |
a094ae43 |
462 | int scroll_on_disp; |
876e5d5e |
463 | int erase_to_scrollback; |
a094ae43 |
464 | int compose_key; |
95bbe1ae |
465 | int ctrlaltkeys; |
32874aea |
466 | char wintitle[256]; /* initial window title */ |
374330e2 |
467 | /* Terminal options */ |
468 | int savelines; |
469 | int dec_om; |
470 | int wrap_mode; |
fef97f43 |
471 | int lfhascr; |
4e30ff69 |
472 | int cursor_type; /* 0=block 1=underline 2=vertical */ |
c9def1b8 |
473 | int blink_cur; |
5ecd7ad0 |
474 | int beep; |
475 | int beep_ind; |
156686ef |
476 | int bellovl; /* bell overload protection active? */ |
477 | int bellovl_n; /* number of bells to cause overload */ |
478 | int bellovl_t; /* time interval for overload (seconds) */ |
479 | int bellovl_s; /* period of silence to re-enable bell (s) */ |
9a30e26b |
480 | Filename bell_wavefile; |
c9def1b8 |
481 | int scrollbar; |
a401e5f3 |
482 | int scrollbar_in_fullscreen; |
5ecd7ad0 |
483 | int resize_action; |
c9def1b8 |
484 | int bce; |
485 | int blinktext; |
374330e2 |
486 | int win_name_always; |
487 | int width, height; |
9a30e26b |
488 | FontSpec font; |
489 | Filename logfilename; |
e1c8e0ed |
490 | int logtype; |
9f89f96e |
491 | int logxfovr; |
6d60c791 |
492 | int logflush; |
9a10ecf4 |
493 | int logomitpass; |
494 | int logomitdata; |
554c540d |
495 | int hide_mouseptr; |
57d08f2f |
496 | int sunken_edge; |
5a73255e |
497 | int window_border; |
e7fbcdd8 |
498 | char answerback[256]; |
b44b307a |
499 | char printer[128]; |
f0fccd51 |
500 | int arabicshaping; |
501 | int bidi; |
374330e2 |
502 | /* Colour options */ |
c6f1b8ed |
503 | int ansi_colour; |
cecb13f6 |
504 | int xterm_256_colour; |
26d1da7b |
505 | int system_colour; |
374330e2 |
506 | int try_palette; |
507 | int bold_colour; |
508 | unsigned char colours[22][3]; |
509 | /* Selection options */ |
510 | int mouse_is_xterm; |
6908fed7 |
511 | int rect_select; |
d3a22f79 |
512 | int rawcnp; |
a7419ea4 |
513 | int rtf_paste; |
b90840c3 |
514 | int mouse_override; |
374330e2 |
515 | short wordness[256]; |
c9def1b8 |
516 | /* translations */ |
5ecd7ad0 |
517 | int vtmode; |
8bb92a1c |
518 | char line_codepage[128]; |
6ac7f054 |
519 | int utf8_override; |
a9c02454 |
520 | int xlat_capslockcyr; |
9c964e85 |
521 | /* X11 forwarding */ |
522 | int x11_forward; |
523 | char x11_display[128]; |
b3ebaa28 |
524 | int x11_auth; |
d74d141c |
525 | /* port forwarding */ |
beefa433 |
526 | int lport_acceptall; /* accept conns from hosts other than localhost */ |
527 | int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */ |
820ebe3b |
528 | /* |
529 | * The port forwarding string contains a number of |
530 | * NUL-terminated substrings, terminated in turn by an empty |
531 | * string (i.e. a second NUL immediately after the previous |
532 | * one). Each string can be of one of the following forms: |
533 | * |
534 | * [LR]localport\thost:port |
535 | * [LR]localaddr:localport\thost:port |
536 | * Dlocalport |
537 | * Dlocaladdr:localport |
538 | */ |
539 | char portfwd[1024]; |
2c9c6388 |
540 | /* SSH bug compatibility modes */ |
5ecd7ad0 |
541 | int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, |
8e975795 |
542 | sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, |
83e7d008 |
543 | sshbug_pksessid2; |
c8ee61b9 |
544 | /* Options for pterm. Should split out into platform-dependent part. */ |
545 | int stamp_utmp; |
546 | int login_shell; |
239b3b36 |
547 | int scrollbar_on_left; |
bf133a73 |
548 | int shadowbold; |
9a30e26b |
549 | FontSpec boldfont; |
550 | FontSpec widefont; |
551 | FontSpec wideboldfont; |
12994a99 |
552 | int shadowboldoffset; |
f7f27309 |
553 | }; |
374330e2 |
554 | |
e277c42d |
555 | /* |
4017be6d |
556 | * Some global flags denoting the type of application. |
67779be7 |
557 | * |
558 | * FLAG_VERBOSE is set when the user requests verbose details. |
559 | * |
560 | * FLAG_STDERR is set in command-line applications (which have a |
561 | * functioning stderr that it makes sense to write to) and not in |
562 | * GUI applications (which don't). |
563 | * |
564 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
565 | * being run, _either_ because no remote command has been provided |
566 | * _or_ because the application is GUI and can't run non- |
567 | * interactively. |
0b4f0bc0 |
568 | * |
569 | * These flags describe the type of _application_ - they wouldn't |
570 | * vary between individual sessions - and so it's OK to have this |
571 | * variable be GLOBAL. |
c44bf5bd |
572 | * |
573 | * Note that additional flags may be defined in platform-specific |
574 | * headers. It's probably best if those ones start from 0x1000, to |
575 | * avoid collision. |
4017be6d |
576 | */ |
67779be7 |
577 | #define FLAG_VERBOSE 0x0001 |
578 | #define FLAG_STDERR 0x0002 |
579 | #define FLAG_INTERACTIVE 0x0004 |
4017be6d |
580 | GLOBAL int flags; |
581 | |
0b4f0bc0 |
582 | /* |
583 | * Likewise, these two variables are set up when the application |
584 | * initialises, and inform all default-settings accesses after |
585 | * that. |
586 | */ |
e277c42d |
587 | GLOBAL int default_protocol; |
588 | GLOBAL int default_port; |
374330e2 |
589 | |
18e62ad8 |
590 | /* |
591 | * This is set TRUE by cmdline.c iff a session is loaded with "-load". |
592 | */ |
593 | GLOBAL int loaded_session; |
594 | |
4e23b276 |
595 | struct RSAKey; /* be a little careful of scope */ |
596 | |
374330e2 |
597 | /* |
598 | * Exports from window.c. |
599 | */ |
a8327734 |
600 | void request_resize(void *frontend, int, int); |
36566009 |
601 | void do_text(Context, int, int, wchar_t *, int, unsigned long, int); |
602 | void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int); |
2102eb8a |
603 | int char_width(Context ctx, int uc); |
37d2a505 |
604 | #ifdef OPTIMISE_SCROLL |
341eb978 |
605 | void do_scroll(Context, int, int, int); |
37d2a505 |
606 | #endif |
a8327734 |
607 | void set_title(void *frontend, char *); |
608 | void set_icon(void *frontend, char *); |
609 | void set_sbar(void *frontend, int, int, int); |
610 | Context get_ctx(void *frontend); |
32874aea |
611 | void free_ctx(Context); |
a8327734 |
612 | void palette_set(void *frontend, int, int, int, int); |
613 | void palette_reset(void *frontend); |
614 | void write_aclip(void *frontend, char *, int, int); |
615 | void write_clip(void *frontend, wchar_t *, int, int); |
616 | void get_clip(void *frontend, wchar_t **, int *); |
617 | void optimised_move(void *frontend, int, int, int); |
618 | void set_raw_mouse_mode(void *frontend, int); |
a8327734 |
619 | void connection_fatal(void *frontend, char *, ...); |
32874aea |
620 | void fatalbox(char *, ...); |
1709795f |
621 | void modalfatalbox(char *, ...); |
4b599b6d |
622 | #ifdef macintosh |
623 | #pragma noreturn(fatalbox) |
624 | #pragma noreturn(modalfatalbox) |
625 | #endif |
a8327734 |
626 | void beep(void *frontend, int); |
627 | void begin_session(void *frontend); |
628 | void sys_cursor(void *frontend, int x, int y); |
629 | void request_paste(void *frontend); |
b9d7bcad |
630 | void frontend_keypress(void *frontend); |
631 | void ldisc_update(void *frontend, int echo, int edit); |
533b1743 |
632 | /* It's the backend's responsibility to invoke this at the start of a |
633 | * connection, if necessary; it can also invoke it later if the set of |
634 | * special commands changes. It does not need to invoke it at session |
635 | * shutdown. */ |
125105d1 |
636 | void update_specials_menu(void *frontend); |
fbf6cb3b |
637 | int from_backend(void *frontend, int is_stderr, const char *data, int len); |
39934deb |
638 | void notify_remote_exit(void *frontend); |
374330e2 |
639 | #define OPTIMISE_IS_SCROLL 1 |
640 | |
a8327734 |
641 | void set_iconic(void *frontend, int iconic); |
642 | void move_window(void *frontend, int x, int y); |
643 | void set_zorder(void *frontend, int top); |
644 | void refresh_window(void *frontend); |
645 | void set_zoomed(void *frontend, int zoomed); |
646 | int is_iconic(void *frontend); |
647 | void get_window_pos(void *frontend, int *x, int *y); |
648 | void get_window_pixels(void *frontend, int *x, int *y); |
649 | char *get_window_title(void *frontend, int icon); |
68f9b3d9 |
650 | |
93b581bd |
651 | void cleanup_exit(int); |
652 | |
374330e2 |
653 | /* |
654 | * Exports from noise.c. |
655 | */ |
32874aea |
656 | void noise_get_heavy(void (*func) (void *, int)); |
657 | void noise_get_light(void (*func) (void *, int)); |
7d6ee6ff |
658 | void noise_regular(void); |
f7f27309 |
659 | void noise_ultralight(unsigned long data); |
374330e2 |
660 | void random_save_seed(void); |
de3df031 |
661 | void random_destroy_seed(void); |
374330e2 |
662 | |
663 | /* |
a9422f39 |
664 | * Exports from settings.c. |
665 | */ |
3f935d5b |
666 | char *save_settings(char *section, int do_host, Config * cfg); |
b537dd42 |
667 | void save_open_settings(void *sesskey, int do_host, Config *cfg); |
32874aea |
668 | void load_settings(char *section, int do_host, Config * cfg); |
ce283213 |
669 | void load_open_settings(void *sesskey, int do_host, Config *cfg); |
0b4f0bc0 |
670 | void get_sesslist(struct sesslist *, int allocate); |
1709795f |
671 | void do_defaults(char *, Config *); |
672 | void registry_cleanup(void); |
a9422f39 |
673 | |
674 | /* |
5a9eb105 |
675 | * Functions used by settings.c to provide platform-specific |
676 | * default settings. |
677 | * |
678 | * (The integer one is expected to return `def' if it has no clear |
679 | * opinion of its own. This is because there's no integer value |
680 | * which I can reliably set aside to indicate `nil'. The string |
9a30e26b |
681 | * function is perfectly all right returning NULL, of course. The |
682 | * Filename and FontSpec functions are _not allowed_ to fail to |
683 | * return, since these defaults _must_ be per-platform.) |
5a9eb105 |
684 | */ |
c85623f9 |
685 | char *platform_default_s(const char *name); |
686 | int platform_default_i(const char *name, int def); |
9a30e26b |
687 | Filename platform_default_filename(const char *name); |
688 | FontSpec platform_default_fontspec(const char *name); |
5a9eb105 |
689 | |
690 | /* |
374330e2 |
691 | * Exports from terminal.c. |
692 | */ |
693 | |
21d2b241 |
694 | Terminal *term_init(Config *, struct unicode_data *, void *); |
fabd1805 |
695 | void term_free(Terminal *); |
887035a5 |
696 | void term_size(Terminal *, int, int, int); |
c1b55581 |
697 | void term_paint(Terminal *, Context, int, int, int, int, int); |
887035a5 |
698 | void term_scroll(Terminal *, int, int); |
699 | void term_pwron(Terminal *); |
700 | void term_clrsb(Terminal *); |
fc5b0934 |
701 | void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action, |
702 | int,int,int,int,int); |
6c50d421 |
703 | void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int, |
704 | unsigned int); |
887035a5 |
705 | void term_deselect(Terminal *); |
706 | void term_update(Terminal *); |
707 | void term_invalidate(Terminal *); |
708 | void term_blink(Terminal *, int set_cursor); |
709 | void term_do_paste(Terminal *); |
710 | int term_paste_pending(Terminal *); |
711 | void term_paste(Terminal *); |
712 | void term_nopaste(Terminal *); |
713 | int term_ldisc(Terminal *, int option); |
714 | void term_copyall(Terminal *); |
64734920 |
715 | void term_reconfig(Terminal *, Config *); |
887035a5 |
716 | void term_seen_key_event(Terminal *); |
fbf6cb3b |
717 | int term_data(Terminal *, int is_stderr, const char *data, int len); |
51470298 |
718 | void term_provide_resize_fn(Terminal *term, |
719 | void (*resize_fn)(void *, int, int), |
720 | void *resize_ctx); |
a8327734 |
721 | void term_provide_logctx(Terminal *term, void *logctx); |
1cff1320 |
722 | void term_set_focus(Terminal *term, int has_focus); |
374330e2 |
723 | |
724 | /* |
00db133f |
725 | * Exports from logging.c. |
726 | */ |
c229ef97 |
727 | void *log_init(void *frontend, Config *cfg); |
fabd1805 |
728 | void log_free(void *logctx); |
c229ef97 |
729 | void log_reconfig(void *logctx, Config *cfg); |
a8327734 |
730 | void logfopen(void *logctx); |
731 | void logfclose(void *logctx); |
732 | void logtraffic(void *logctx, unsigned char c, int logmode); |
11cc5e30 |
733 | void logflush(void *logctx); |
cbe2d68f |
734 | void log_eventlog(void *logctx, const char *string); |
00db133f |
735 | enum { PKT_INCOMING, PKT_OUTGOING }; |
9a10ecf4 |
736 | enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT }; |
737 | struct logblank_t { |
738 | int offset; |
739 | int len; |
740 | int type; |
741 | }; |
a8327734 |
742 | void log_packet(void *logctx, int direction, int type, |
9a10ecf4 |
743 | char *texttype, void *data, int len, |
744 | int n_blanks, const struct logblank_t *blanks); |
00db133f |
745 | |
746 | /* |
d082ac49 |
747 | * Exports from testback.c |
748 | */ |
749 | |
750 | extern Backend null_backend; |
751 | extern Backend loop_backend; |
752 | |
753 | /* |
5e1a8e27 |
754 | * Exports from raw.c. |
755 | */ |
756 | |
3d9a14c9 |
757 | extern Backend raw_backend; |
5e1a8e27 |
758 | |
759 | /* |
c91409da |
760 | * Exports from rlogin.c. |
761 | */ |
762 | |
763 | extern Backend rlogin_backend; |
764 | |
765 | /* |
374330e2 |
766 | * Exports from telnet.c. |
767 | */ |
768 | |
c14776e8 |
769 | extern Backend telnet_backend; |
374330e2 |
770 | |
771 | /* |
c0a81592 |
772 | * Exports from ssh.c. (NB the getline variables have to be GLOBAL |
773 | * so that PuTTYtel will still compile - otherwise it would depend |
774 | * on ssh.c.) |
374330e2 |
775 | */ |
776 | |
c0a81592 |
777 | GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen, |
32874aea |
778 | int is_pw); |
c0a81592 |
779 | GLOBAL int ssh_getline_pw_only; |
c14776e8 |
780 | extern Backend ssh_backend; |
374330e2 |
781 | |
782 | /* |
5bc238bb |
783 | * Exports from ldisc.c. |
784 | */ |
fe5634f6 |
785 | void *ldisc_create(Config *, Terminal *, Backend *, void *, void *); |
fabd1805 |
786 | void ldisc_free(void *); |
b9d7bcad |
787 | void ldisc_send(void *handle, char *buf, int len, int interactive); |
5bc238bb |
788 | |
789 | /* |
5def7522 |
790 | * Exports from ldiscucs.c. |
791 | */ |
792 | void lpage_send(void *, int codepage, char *buf, int len, int interactive); |
793 | void luni_send(void *, wchar_t * widebuf, int len, int interactive); |
794 | |
795 | /* |
374330e2 |
796 | * Exports from sshrand.c. |
797 | */ |
798 | |
799 | void random_add_noise(void *noise, int length); |
374330e2 |
800 | int random_byte(void); |
801 | void random_get_savedata(void **data, int *len); |
93b581bd |
802 | extern int random_active; |
5d17ccfc |
803 | /* The random number subsystem is activated if at least one other entity |
804 | * within the program expresses an interest in it. So each SSH session |
805 | * calls random_ref on startup and random_unref on shutdown. */ |
806 | void random_ref(void); |
807 | void random_unref(void); |
374330e2 |
808 | |
809 | /* |
39934deb |
810 | * Exports from pinger.c. |
811 | */ |
812 | typedef struct pinger_tag *Pinger; |
813 | Pinger pinger_new(Config *cfg, Backend *back, void *backhandle); |
814 | void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg); |
815 | void pinger_free(Pinger); |
816 | |
817 | /* |
374330e2 |
818 | * Exports from misc.c. |
819 | */ |
820 | |
db9c0f86 |
821 | #include "misc.h" |
374330e2 |
822 | |
823 | /* |
067a15ea |
824 | * Exports from version.c. |
825 | */ |
826 | extern char ver[]; |
827 | |
828 | /* |
4eeb7d09 |
829 | * Exports from unicode.c. |
14963b8f |
830 | */ |
4eeb7d09 |
831 | #ifndef CP_UTF8 |
832 | #define CP_UTF8 65001 |
833 | #endif |
facd762c |
834 | /* void init_ucs(void); -- this is now in platform-specific headers */ |
5def7522 |
835 | int is_dbcs_leadbyte(int codepage, char byte); |
836 | int mb_to_wc(int codepage, int flags, char *mbstr, int mblen, |
837 | wchar_t *wcstr, int wclen); |
838 | int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, |
21d2b241 |
839 | char *mbstr, int mblen, char *defchr, int *defused, |
840 | struct unicode_data *ucsdata); |
a9c02454 |
841 | wchar_t xlat_uskbd2cyrllic(int ch); |
4eeb7d09 |
842 | int check_compose(int first, int second); |
843 | int decode_codepage(char *cp_name); |
d4413bd2 |
844 | const char *cp_enumerate (int index); |
845 | const char *cp_name(int codepage); |
a7419ea4 |
846 | void get_unitab(int codepage, wchar_t * unitab, int ftype); |
14963b8f |
847 | |
848 | /* |
5f6fe27e |
849 | * Exports from wcwidth.c |
850 | */ |
851 | int wcwidth(wchar_t ucs); |
852 | int wcswidth(const wchar_t *pwcs, size_t n); |
853 | |
854 | /* |
8f203108 |
855 | * Exports from mscrypto.c |
856 | */ |
857 | #ifdef MSCRYPTOAPI |
858 | int crypto_startup(); |
859 | void crypto_wrapup(); |
860 | #endif |
861 | |
862 | /* |
839f10db |
863 | * Exports from pageantc.c. |
864 | * |
865 | * agent_query returns 1 for here's-a-response, and 0 for query-in- |
866 | * progress. In the latter case there will be a call to `callback' |
867 | * at some future point, passing callback_ctx as the first |
868 | * parameter and the actual reply data as the second and third. |
869 | * |
870 | * The response may be a NULL pointer (in either of the synchronous |
871 | * or asynchronous cases), which indicates failure to receive a |
872 | * response. |
5c58ad2d |
873 | */ |
839f10db |
874 | int agent_query(void *in, int inlen, void **out, int *outlen, |
875 | void (*callback)(void *, void *, int), void *callback_ctx); |
5c58ad2d |
876 | int agent_exists(void); |
877 | |
4eb24e3a |
878 | /* |
879 | * Exports from wildcard.c |
880 | */ |
881 | const char *wc_error(int value); |
882 | int wc_match(const char *wildcard, const char *target); |
883 | int wc_unescape(char *output, const char *wildcard); |
374330e2 |
884 | |
ff2ae367 |
885 | /* |
1709795f |
886 | * Exports from windlg.c |
887 | */ |
cbe2d68f |
888 | void logevent(void *frontend, const char *); |
a8327734 |
889 | void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, |
1709795f |
890 | char *keystr, char *fingerprint); |
83e7d008 |
891 | void askalg(void *frontend, const char *algtype, const char *algname); |
9a30e26b |
892 | int askappend(void *frontend, Filename filename); |
1709795f |
893 | |
894 | /* |
ff2ae367 |
895 | * Exports from console.c (that aren't equivalents to things in |
896 | * windlg.c). |
897 | */ |
898 | extern int console_batch_mode; |
ff2ae367 |
899 | int console_get_line(const char *prompt, char *str, int maxlen, int is_pw); |
d3fef4a5 |
900 | void console_provide_logctx(void *logctx); |
47a6b94c |
901 | int is_interactive(void); |
ff2ae367 |
902 | |
b44b307a |
903 | /* |
904 | * Exports from printing.c. |
905 | */ |
906 | typedef struct printer_enum_tag printer_enum; |
907 | typedef struct printer_job_tag printer_job; |
908 | printer_enum *printer_start_enum(int *nprinters); |
909 | char *printer_get_name(printer_enum *, int); |
910 | void printer_finish_enum(printer_enum *); |
911 | printer_job *printer_start_job(char *printer); |
912 | void printer_job_data(printer_job *, void *, int); |
913 | void printer_finish_job(printer_job *); |
914 | |
c0a81592 |
915 | /* |
916 | * Exports from cmdline.c (and also cmdline_error(), which is |
917 | * defined differently in various places and required _by_ |
918 | * cmdline.c). |
919 | */ |
5555d393 |
920 | int cmdline_process_param(char *, char *, int, Config *); |
921 | void cmdline_run_saved(Config *); |
679539d7 |
922 | void cmdline_cleanup(void); |
c0a81592 |
923 | extern char *cmdline_password; |
924 | #define TOOLTYPE_FILETRANSFER 1 |
46a3419b |
925 | #define TOOLTYPE_NONNETWORK 2 |
c0a81592 |
926 | extern int cmdline_tooltype; |
927 | |
928 | void cmdline_error(char *, ...); |
929 | |
e0e7dff8 |
930 | /* |
d1582b2e |
931 | * Exports from config.c. |
932 | */ |
1a602f03 |
933 | struct controlbox; |
d1582b2e |
934 | void setup_config_box(struct controlbox *b, struct sesslist *sesslist, |
f89c3294 |
935 | int midsession, int protocol, int protcfginfo); |
d1582b2e |
936 | |
937 | /* |
f0fccd51 |
938 | * Exports from minibidi.c. |
939 | */ |
940 | typedef struct bidi_char { |
941 | wchar_t origwc, wc; |
942 | unsigned short index; |
943 | } bidi_char; |
944 | int do_bidi(bidi_char *line, int count); |
945 | int do_shape(bidi_char *line, bidi_char *to, int count); |
946 | |
947 | /* |
e0e7dff8 |
948 | * X11 auth mechanisms we know about. |
949 | */ |
950 | enum { |
951 | X11_NO_AUTH, |
952 | X11_MIT, /* MIT-MAGIC-COOKIE-1 */ |
2f92b717 |
953 | X11_XDM, /* XDM-AUTHORIZATION-1 */ |
e0e7dff8 |
954 | X11_NAUTHS |
955 | }; |
956 | extern const char *const x11_authnames[]; /* declared in x11fwd.c */ |
957 | |
9a30e26b |
958 | /* |
959 | * Miscellaneous exports from the platform-specific code. |
960 | */ |
9fab77dc |
961 | Filename filename_from_str(const char *string); |
962 | const char *filename_to_str(const Filename *fn); |
9a30e26b |
963 | int filename_equal(Filename f1, Filename f2); |
964 | int filename_is_null(Filename fn); |
799dfcfa |
965 | char *get_username(void); /* return value needs freeing */ |
47a6b94c |
966 | char *get_random_data(int bytes); /* used in cmdgen.c */ |
9a30e26b |
967 | |
39934deb |
968 | /* |
969 | * Exports and imports from timing.c. |
970 | * |
971 | * schedule_timer() asks the front end to schedule a callback to a |
972 | * timer function in a given number of ticks. The returned value is |
973 | * the time (in ticks since an arbitrary offset) at which the |
974 | * callback can be expected. This value will also be passed as the |
975 | * `now' parameter to the callback function. Hence, you can (for |
976 | * example) schedule an event at a particular time by calling |
977 | * schedule_timer() and storing the return value in your context |
978 | * structure as the time when that event is due. The first time a |
979 | * callback function gives you that value or more as `now', you do |
980 | * the thing. |
981 | * |
982 | * expire_timer_context() drops all current timers associated with |
983 | * a given value of ctx (for when you're about to free ctx). |
984 | * |
985 | * run_timers() is called from the front end when it has reason to |
986 | * think some timers have reached their moment, or when it simply |
987 | * needs to know how long to wait next. We pass it the time we |
988 | * think it is. It returns TRUE and places the time when the next |
989 | * timer needs to go off in `next', or alternatively it returns |
990 | * FALSE if there are no timers at all pending. |
991 | * |
992 | * timer_change_notify() must be supplied by the front end; it |
993 | * notifies the front end that a new timer has been added to the |
994 | * list which is sooner than any existing ones. It provides the |
995 | * time when that timer needs to go off. |
996 | */ |
997 | typedef void (*timer_fn_t)(void *ctx, long now); |
998 | long schedule_timer(int ticks, timer_fn_t fn, void *ctx); |
999 | void expire_timer_context(void *ctx); |
1000 | int run_timers(long now, long *next); |
1001 | void timer_change_notify(long next); |
1002 | |
374330e2 |
1003 | #endif |