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. |
4eeb7d09 |
39 | * |
40 | * ATTR_INVALID is an illegal colour combination. |
41 | */ |
42 | |
43 | #define TATTR_ACTCURS 0x4UL /* active cursor (block) */ |
44 | #define TATTR_PASCURS 0x2UL /* passive cursor (box) */ |
45 | #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */ |
374330e2 |
46 | |
c9def1b8 |
47 | #define LATTR_NORM 0x00000000UL |
48 | #define LATTR_WIDE 0x01000000UL |
49 | #define LATTR_TOP 0x02000000UL |
50 | #define LATTR_BOT 0x03000000UL |
51 | #define LATTR_MODE 0x03000000UL |
4eeb7d09 |
52 | #define LATTR_WRAPPED 0x10000000UL |
3c7366f8 |
53 | #define LATTR_WRAPPED2 0x20000000UL |
4eeb7d09 |
54 | |
50c1be3f |
55 | #define ATTR_INVALID 0x03FF0000UL |
4eeb7d09 |
56 | |
57 | /* Like Linux use the F000 page for direct to font. */ |
58 | #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */ |
59 | #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */ |
60 | |
61 | /* These are internal use overlapping with the UTF-16 surrogates */ |
62 | #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */ |
63 | #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */ |
d3cb5465 |
64 | #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */ |
4eeb7d09 |
65 | #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */ |
66 | #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */ |
67 | |
68 | #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800) |
69 | #define DIRECT_FONT(c) ((c&0xFE00)==0xF000) |
70 | |
71 | #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */ |
3c7366f8 |
72 | /* |
73 | * UCSWIDE is a special value used in the terminal data to signify |
74 | * the character cell containing the right-hand half of a CJK wide |
75 | * character. We use 0xDFFF because it's part of the surrogate |
76 | * range and hence won't be used for anything else (it's impossible |
77 | * to input it via UTF-8 because our UTF-8 decoder correctly |
78 | * rejects surrogates). |
79 | */ |
80 | #define UCSWIDE 0xDFFF |
4eeb7d09 |
81 | |
37ca32ed |
82 | #define ATTR_NARROW 0x80000000UL |
83 | #define ATTR_WIDE 0x40000000UL |
84 | #define ATTR_BOLD 0x04000000UL |
85 | #define ATTR_UNDER 0x08000000UL |
86 | #define ATTR_REVERSE 0x10000000UL |
87 | #define ATTR_BLINK 0x20000000UL |
88 | #define ATTR_FGMASK 0x001F0000UL |
89 | #define ATTR_BGMASK 0x03E00000UL |
90 | #define ATTR_COLOURS 0x03FF0000UL |
4eeb7d09 |
91 | #define ATTR_FGSHIFT 16 |
37ca32ed |
92 | #define ATTR_BGSHIFT 21 |
4eeb7d09 |
93 | |
50c1be3f |
94 | #define ATTR_DEFAULT 0x01280000UL /* bg 9, fg 8 */ |
4eeb7d09 |
95 | #define ATTR_DEFFG 0x00080000UL |
37ca32ed |
96 | #define ATTR_DEFBG 0x01200000UL |
8f22582c |
97 | #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ') |
374330e2 |
98 | #define ATTR_MASK 0xFFFFFF00UL |
99 | #define CHAR_MASK 0x000000FFUL |
4eeb7d09 |
100 | |
101 | #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS)) |
37ca32ed |
102 | #define ATTR_CUR_XOR 0x016A0000UL |
374330e2 |
103 | |
0b4f0bc0 |
104 | struct sesslist { |
105 | int nsessions; |
106 | char **sessions; |
107 | char *buffer; /* so memory can be freed later */ |
108 | }; |
1709795f |
109 | |
21d2b241 |
110 | struct unicode_data { |
111 | char **uni_tbl; |
112 | int dbcs_screenfont; |
113 | int font_codepage; |
114 | int line_codepage; |
115 | wchar_t unitab_scoacs[256]; |
116 | wchar_t unitab_line[256]; |
117 | wchar_t unitab_font[256]; |
118 | wchar_t unitab_xterm[256]; |
119 | wchar_t unitab_oemcp[256]; |
120 | unsigned char unitab_ctrl[256]; |
121 | }; |
4eeb7d09 |
122 | |
32874aea |
123 | #define LGXF_OVR 1 /* existing logfile overwrite */ |
124 | #define LGXF_APN 0 /* existing logfile append */ |
125 | #define LGXF_ASK -1 /* existing logfile ask */ |
126 | #define LGTYP_NONE 0 /* logmode: no logging */ |
127 | #define LGTYP_ASCII 1 /* logmode: pure ascii */ |
00db133f |
128 | #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */ |
129 | #define LGTYP_PACKETS 3 /* logmode: SSH data packets */ |
5fd04f07 |
130 | |
374330e2 |
131 | typedef enum { |
132 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
a5f3e637 |
133 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING, |
134 | TS_EOL |
374330e2 |
135 | } Telnet_Special; |
136 | |
137 | typedef enum { |
01c034ad |
138 | MBT_NOTHING, |
139 | MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */ |
140 | MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */ |
141 | MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */ |
374330e2 |
142 | } Mouse_Button; |
143 | |
144 | typedef enum { |
145 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
146 | } Mouse_Action; |
147 | |
6c50d421 |
148 | /* Keyboard modifiers -- keys the user is actually holding down */ |
149 | |
150 | #define PKM_SHIFT 0x01 |
151 | #define PKM_CONTROL 0x02 |
152 | #define PKM_META 0x04 |
153 | #define PKM_ALT 0x08 |
154 | |
155 | /* Keyboard flags that aren't really modifiers */ |
156 | #define PKF_CAPSLOCK 0x10 |
157 | #define PKF_NUMLOCK 0x20 |
158 | #define PKF_REPEAT 0x40 |
159 | |
160 | /* Stand-alone keysyms for function keys */ |
161 | |
162 | typedef enum { |
163 | PK_NULL, /* No symbol for this key */ |
164 | /* Main keypad keys */ |
165 | PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE, |
166 | /* Editing keys */ |
167 | PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN, |
168 | /* Cursor keys */ |
169 | PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST, |
170 | /* Numeric keypad */ /* Real one looks like: */ |
171 | PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */ |
172 | PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */ |
173 | PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */ |
174 | PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */ |
175 | PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */ |
176 | /* Top row */ |
177 | PK_F1, PK_F2, PK_F3, PK_F4, PK_F5, |
178 | PK_F6, PK_F7, PK_F8, PK_F9, PK_F10, |
179 | PK_F11, PK_F12, PK_F13, PK_F14, PK_F15, |
180 | PK_F16, PK_F17, PK_F18, PK_F19, PK_F20, |
181 | PK_PAUSE |
182 | } Key_Sym; |
183 | |
184 | #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN) |
185 | #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST) |
186 | #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER) |
187 | #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20) |
188 | |
5ecd7ad0 |
189 | enum { |
4eeb7d09 |
190 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE |
5ecd7ad0 |
191 | }; |
374330e2 |
192 | |
0965bee0 |
193 | enum { |
194 | /* |
ca20bfcf |
195 | * SSH ciphers (both SSH1 and SSH2) |
196 | */ |
197 | CIPHER_WARN, /* pseudo 'cipher' */ |
198 | CIPHER_3DES, |
199 | CIPHER_BLOWFISH, |
200 | CIPHER_AES, /* (SSH 2 only) */ |
7f1ae1d2 |
201 | CIPHER_DES, |
ca20bfcf |
202 | CIPHER_MAX /* no. ciphers (inc warn) */ |
203 | }; |
204 | |
205 | enum { |
206 | /* |
5ecd7ad0 |
207 | * Several different bits of the PuTTY configuration seem to be |
208 | * three-way settings whose values are `always yes', `always |
209 | * no', and `decide by some more complex automated means'. This |
210 | * is true of line discipline options (local echo and line |
211 | * editing), proxy DNS, Close On Exit, and SSH server bug |
212 | * workarounds. Accordingly I supply a single enum here to deal |
213 | * with them all. |
0965bee0 |
214 | */ |
5ecd7ad0 |
215 | FORCE_ON, FORCE_OFF, AUTO |
216 | }; |
217 | |
218 | enum { |
219 | /* |
220 | * Proxy types. |
221 | */ |
222 | PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET |
0965bee0 |
223 | }; |
224 | |
225 | enum { |
226 | /* |
227 | * Line discipline options which the backend might try to control. |
228 | */ |
32874aea |
229 | LD_EDIT, /* local line editing */ |
230 | LD_ECHO /* local echo */ |
0965bee0 |
231 | }; |
232 | |
b41069ff |
233 | enum { |
5ecd7ad0 |
234 | /* Protocol back ends. (cfg.protocol) */ |
235 | PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH |
236 | }; |
237 | |
238 | enum { |
239 | /* Bell settings (cfg.beep) */ |
240 | BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE |
241 | }; |
242 | |
243 | enum { |
244 | /* Taskbar flashing indication on bell (cfg.beep_ind) */ |
245 | B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY |
246 | }; |
247 | |
248 | enum { |
249 | /* Resize actions (cfg.resize_action) */ |
250 | RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER |
b41069ff |
251 | }; |
252 | |
6c50d421 |
253 | enum { |
254 | /* Function key types (cfg.funky_type) */ |
255 | FUNKY_TILDE, |
256 | FUNKY_LINUX, |
257 | FUNKY_XTERM, |
258 | FUNKY_VT400, |
259 | FUNKY_VT100P, |
260 | FUNKY_SCO |
261 | }; |
262 | |
1709795f |
263 | struct backend_tag { |
86916870 |
264 | char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg, |
887035a5 |
265 | char *host, int port, char **realhost, int nodelay); |
fabd1805 |
266 | void (*free) (void *handle); |
86916870 |
267 | /* back->reconfig() passes in a replacement configuration. */ |
268 | void (*reconfig) (void *handle, Config *cfg); |
5471d09a |
269 | /* back->send() returns the current amount of buffered data. */ |
51470298 |
270 | int (*send) (void *handle, char *buf, int len); |
5471d09a |
271 | /* back->sendbuffer() does the same thing but without attempting a send */ |
51470298 |
272 | int (*sendbuffer) (void *handle); |
273 | void (*size) (void *handle, int width, int height); |
274 | void (*special) (void *handle, Telnet_Special code); |
275 | Socket(*socket) (void *handle); |
276 | int (*exitcode) (void *handle); |
277 | int (*sendok) (void *handle); |
278 | int (*ldisc) (void *handle, int); |
b9d7bcad |
279 | void (*provide_ldisc) (void *handle, void *ldisc); |
a8327734 |
280 | void (*provide_logctx) (void *handle, void *logctx); |
5471d09a |
281 | /* |
282 | * back->unthrottle() tells the back end that the front end |
283 | * buffer is clearing. |
284 | */ |
51470298 |
285 | void (*unthrottle) (void *handle, int); |
97db3be4 |
286 | int default_port; |
1709795f |
287 | }; |
374330e2 |
288 | |
297d398b |
289 | extern struct backend_list { |
89ee5268 |
290 | int protocol; |
291 | char *name; |
292 | Backend *backend; |
293 | } backends[]; |
294 | |
ffa79828 |
295 | /* |
296 | * Suggested default protocol provided by the backend link module. |
297 | * The application is free to ignore this. |
298 | */ |
299 | extern const int be_default_protocol; |
300 | |
5ecd7ad0 |
301 | /* |
302 | * IMPORTANT POLICY POINT: everything in this structure which wants |
303 | * to be treated like an integer must be an actual, honest-to- |
304 | * goodness `int'. No enum-typed variables. This is because parts |
305 | * of the code will want to pass around `int *' pointers to them |
306 | * and we can't run the risk of porting to some system on which the |
307 | * enum comes out as a different size from int. |
308 | */ |
f7f27309 |
309 | struct config_tag { |
374330e2 |
310 | /* Basic options */ |
311 | char host[512]; |
312 | int port; |
5ecd7ad0 |
313 | int protocol; |
374330e2 |
314 | int close_on_exit; |
9ef49106 |
315 | int warn_on_close; |
32874aea |
316 | int ping_interval; /* in seconds */ |
2184a5d9 |
317 | int tcp_nodelay; |
8eebd221 |
318 | /* Proxy options */ |
319 | char proxy_exclude_list[512]; |
5ecd7ad0 |
320 | int proxy_dns; |
b804e1e5 |
321 | int even_proxy_localhost; |
5ecd7ad0 |
322 | int proxy_type; |
8eebd221 |
323 | char proxy_host[512]; |
324 | int proxy_port; |
325 | char proxy_username[32]; |
326 | char proxy_password[32]; |
327 | char proxy_telnet_command[512]; |
328 | int proxy_socks_version; |
fef97f43 |
329 | /* SSH options */ |
6abbf9e3 |
330 | char remote_cmd[512]; |
fd5e5847 |
331 | char remote_cmd2[512]; /* fallback if the first fails |
332 | * (used internally for scp) */ |
32874aea |
333 | char *remote_cmd_ptr; /* might point to a larger command |
334 | * but never for loading/saving */ |
fd5e5847 |
335 | char *remote_cmd_ptr2; /* might point to a larger command |
336 | * but never for loading/saving */ |
fef97f43 |
337 | int nopty; |
4ba9b64b |
338 | int compression; |
979310f1 |
339 | int agentfwd; |
5bb641e1 |
340 | int change_username; /* allow username switching in SSH2 */ |
ca20bfcf |
341 | int ssh_cipherlist[CIPHER_MAX]; |
9a30e26b |
342 | Filename keyfile; |
32874aea |
343 | int sshprot; /* use v1 or v2 when both available */ |
cb4d4768 |
344 | int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */ |
ccbfb941 |
345 | int try_tis_auth; |
f091e308 |
346 | int try_ki_auth; |
4a8fc3c4 |
347 | int ssh_subsys; /* run a subsystem rather than a command */ |
fd5e5847 |
348 | int ssh_subsys2; /* fallback to go with remote_cmd2 */ |
374330e2 |
349 | /* Telnet options */ |
350 | char termtype[32]; |
351 | char termspeed[32]; |
32874aea |
352 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
277fc55e |
353 | char username[100]; |
354 | char localusername[100]; |
374330e2 |
355 | int rfc_environ; |
8faa456c |
356 | int passive_telnet; |
374330e2 |
357 | /* Keyboard options */ |
358 | int bksp_is_delete; |
359 | int rxvt_homeend; |
c9def1b8 |
360 | int funky_type; |
32874aea |
361 | int no_applic_c; /* totally disable app cursor keys */ |
362 | int no_applic_k; /* totally disable app keypad */ |
c0d36a72 |
363 | int no_mouse_rep; /* totally disable mouse reporting */ |
0d2086c5 |
364 | int no_remote_resize; /* disable remote resizing */ |
365 | int no_alt_screen; /* disable alternate screen */ |
366 | int no_remote_wintitle; /* disable remote retitling */ |
367 | int no_dbackspace; /* disable destructive backspace */ |
368 | int no_remote_charset; /* disable remote charset config */ |
374330e2 |
369 | int app_cursor; |
370 | int app_keypad; |
c5e9c988 |
371 | int nethack_keypad; |
a5f3e637 |
372 | int telnet_keyboard; |
eee63b77 |
373 | int telnet_newline; |
c5e9c988 |
374 | int alt_f4; /* is it special? */ |
375 | int alt_space; /* is it special? */ |
a094ae43 |
376 | int alt_only; /* is it special? */ |
0965bee0 |
377 | int localecho; |
378 | int localedit; |
e95edc00 |
379 | int alwaysontop; |
8f57d753 |
380 | int fullscreenonaltenter; |
c9def1b8 |
381 | int scroll_on_key; |
a094ae43 |
382 | int scroll_on_disp; |
383 | int compose_key; |
95bbe1ae |
384 | int ctrlaltkeys; |
32874aea |
385 | char wintitle[256]; /* initial window title */ |
374330e2 |
386 | /* Terminal options */ |
387 | int savelines; |
388 | int dec_om; |
389 | int wrap_mode; |
fef97f43 |
390 | int lfhascr; |
4e30ff69 |
391 | int cursor_type; /* 0=block 1=underline 2=vertical */ |
c9def1b8 |
392 | int blink_cur; |
5ecd7ad0 |
393 | int beep; |
394 | int beep_ind; |
156686ef |
395 | int bellovl; /* bell overload protection active? */ |
396 | int bellovl_n; /* number of bells to cause overload */ |
397 | int bellovl_t; /* time interval for overload (seconds) */ |
398 | int bellovl_s; /* period of silence to re-enable bell (s) */ |
9a30e26b |
399 | Filename bell_wavefile; |
c9def1b8 |
400 | int scrollbar; |
a401e5f3 |
401 | int scrollbar_in_fullscreen; |
5ecd7ad0 |
402 | int resize_action; |
c9def1b8 |
403 | int bce; |
404 | int blinktext; |
374330e2 |
405 | int win_name_always; |
406 | int width, height; |
9a30e26b |
407 | FontSpec font; |
408 | Filename logfilename; |
e1c8e0ed |
409 | int logtype; |
9f89f96e |
410 | int logxfovr; |
554c540d |
411 | int hide_mouseptr; |
57d08f2f |
412 | int sunken_edge; |
5a73255e |
413 | int window_border; |
e7fbcdd8 |
414 | char answerback[256]; |
b44b307a |
415 | char printer[128]; |
374330e2 |
416 | /* Colour options */ |
417 | int try_palette; |
418 | int bold_colour; |
419 | unsigned char colours[22][3]; |
420 | /* Selection options */ |
421 | int mouse_is_xterm; |
6908fed7 |
422 | int rect_select; |
d3a22f79 |
423 | int rawcnp; |
a7419ea4 |
424 | int rtf_paste; |
b90840c3 |
425 | int mouse_override; |
374330e2 |
426 | short wordness[256]; |
c9def1b8 |
427 | /* translations */ |
5ecd7ad0 |
428 | int vtmode; |
8bb92a1c |
429 | char line_codepage[128]; |
a9c02454 |
430 | int xlat_capslockcyr; |
9c964e85 |
431 | /* X11 forwarding */ |
432 | int x11_forward; |
433 | char x11_display[128]; |
b3ebaa28 |
434 | int x11_auth; |
d74d141c |
435 | /* port forwarding */ |
beefa433 |
436 | int lport_acceptall; /* accept conns from hosts other than localhost */ |
437 | int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */ |
d74d141c |
438 | char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */ |
2c9c6388 |
439 | /* SSH bug compatibility modes */ |
5ecd7ad0 |
440 | int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, |
8e975795 |
441 | sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, |
dda87a28 |
442 | sshbug_dhgex2, sshbug_pksessid2; |
c8ee61b9 |
443 | /* Options for pterm. Should split out into platform-dependent part. */ |
444 | int stamp_utmp; |
445 | int login_shell; |
239b3b36 |
446 | int scrollbar_on_left; |
9a30e26b |
447 | FontSpec boldfont; |
448 | FontSpec widefont; |
449 | FontSpec wideboldfont; |
12994a99 |
450 | int shadowboldoffset; |
f7f27309 |
451 | }; |
374330e2 |
452 | |
e277c42d |
453 | /* |
4017be6d |
454 | * Some global flags denoting the type of application. |
67779be7 |
455 | * |
456 | * FLAG_VERBOSE is set when the user requests verbose details. |
457 | * |
458 | * FLAG_STDERR is set in command-line applications (which have a |
459 | * functioning stderr that it makes sense to write to) and not in |
460 | * GUI applications (which don't). |
461 | * |
462 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
463 | * being run, _either_ because no remote command has been provided |
464 | * _or_ because the application is GUI and can't run non- |
465 | * interactively. |
0b4f0bc0 |
466 | * |
467 | * These flags describe the type of _application_ - they wouldn't |
468 | * vary between individual sessions - and so it's OK to have this |
469 | * variable be GLOBAL. |
4017be6d |
470 | */ |
67779be7 |
471 | #define FLAG_VERBOSE 0x0001 |
472 | #define FLAG_STDERR 0x0002 |
473 | #define FLAG_INTERACTIVE 0x0004 |
4017be6d |
474 | GLOBAL int flags; |
475 | |
0b4f0bc0 |
476 | /* |
477 | * Likewise, these two variables are set up when the application |
478 | * initialises, and inform all default-settings accesses after |
479 | * that. |
480 | */ |
e277c42d |
481 | GLOBAL int default_protocol; |
482 | GLOBAL int default_port; |
374330e2 |
483 | |
4e23b276 |
484 | struct RSAKey; /* be a little careful of scope */ |
485 | |
374330e2 |
486 | /* |
487 | * Exports from window.c. |
488 | */ |
a8327734 |
489 | void request_resize(void *frontend, int, int); |
32874aea |
490 | void do_text(Context, int, int, char *, int, unsigned long, int); |
4eeb7d09 |
491 | void do_cursor(Context, int, int, char *, int, unsigned long, int); |
2102eb8a |
492 | int char_width(Context ctx, int uc); |
37d2a505 |
493 | #ifdef OPTIMISE_SCROLL |
341eb978 |
494 | void do_scroll(Context, int, int, int); |
37d2a505 |
495 | #endif |
a8327734 |
496 | void set_title(void *frontend, char *); |
497 | void set_icon(void *frontend, char *); |
498 | void set_sbar(void *frontend, int, int, int); |
499 | Context get_ctx(void *frontend); |
32874aea |
500 | void free_ctx(Context); |
a8327734 |
501 | void palette_set(void *frontend, int, int, int, int); |
502 | void palette_reset(void *frontend); |
503 | void write_aclip(void *frontend, char *, int, int); |
504 | void write_clip(void *frontend, wchar_t *, int, int); |
505 | void get_clip(void *frontend, wchar_t **, int *); |
506 | void optimised_move(void *frontend, int, int, int); |
507 | void set_raw_mouse_mode(void *frontend, int); |
a8327734 |
508 | void connection_fatal(void *frontend, char *, ...); |
32874aea |
509 | void fatalbox(char *, ...); |
1709795f |
510 | void modalfatalbox(char *, ...); |
4b599b6d |
511 | #ifdef macintosh |
512 | #pragma noreturn(fatalbox) |
513 | #pragma noreturn(modalfatalbox) |
514 | #endif |
a8327734 |
515 | void beep(void *frontend, int); |
516 | void begin_session(void *frontend); |
517 | void sys_cursor(void *frontend, int x, int y); |
518 | void request_paste(void *frontend); |
b9d7bcad |
519 | void frontend_keypress(void *frontend); |
520 | void ldisc_update(void *frontend, int echo, int edit); |
374330e2 |
521 | #define OPTIMISE_IS_SCROLL 1 |
522 | |
a8327734 |
523 | void set_iconic(void *frontend, int iconic); |
524 | void move_window(void *frontend, int x, int y); |
525 | void set_zorder(void *frontend, int top); |
526 | void refresh_window(void *frontend); |
527 | void set_zoomed(void *frontend, int zoomed); |
528 | int is_iconic(void *frontend); |
529 | void get_window_pos(void *frontend, int *x, int *y); |
530 | void get_window_pixels(void *frontend, int *x, int *y); |
531 | char *get_window_title(void *frontend, int icon); |
68f9b3d9 |
532 | |
93b581bd |
533 | void cleanup_exit(int); |
534 | |
374330e2 |
535 | /* |
536 | * Exports from noise.c. |
537 | */ |
32874aea |
538 | void noise_get_heavy(void (*func) (void *, int)); |
539 | void noise_get_light(void (*func) (void *, int)); |
7d6ee6ff |
540 | void noise_regular(void); |
f7f27309 |
541 | void noise_ultralight(unsigned long data); |
374330e2 |
542 | void random_save_seed(void); |
de3df031 |
543 | void random_destroy_seed(void); |
374330e2 |
544 | |
545 | /* |
a9422f39 |
546 | * Exports from settings.c. |
547 | */ |
32874aea |
548 | void save_settings(char *section, int do_host, Config * cfg); |
b537dd42 |
549 | void save_open_settings(void *sesskey, int do_host, Config *cfg); |
32874aea |
550 | void load_settings(char *section, int do_host, Config * cfg); |
ce283213 |
551 | void load_open_settings(void *sesskey, int do_host, Config *cfg); |
0b4f0bc0 |
552 | void get_sesslist(struct sesslist *, int allocate); |
1709795f |
553 | void do_defaults(char *, Config *); |
554 | void registry_cleanup(void); |
a9422f39 |
555 | |
556 | /* |
5a9eb105 |
557 | * Functions used by settings.c to provide platform-specific |
558 | * default settings. |
559 | * |
560 | * (The integer one is expected to return `def' if it has no clear |
561 | * opinion of its own. This is because there's no integer value |
562 | * which I can reliably set aside to indicate `nil'. The string |
9a30e26b |
563 | * function is perfectly all right returning NULL, of course. The |
564 | * Filename and FontSpec functions are _not allowed_ to fail to |
565 | * return, since these defaults _must_ be per-platform.) |
5a9eb105 |
566 | */ |
c85623f9 |
567 | char *platform_default_s(const char *name); |
568 | int platform_default_i(const char *name, int def); |
9a30e26b |
569 | Filename platform_default_filename(const char *name); |
570 | FontSpec platform_default_fontspec(const char *name); |
5a9eb105 |
571 | |
572 | /* |
374330e2 |
573 | * Exports from terminal.c. |
574 | */ |
575 | |
21d2b241 |
576 | Terminal *term_init(Config *, struct unicode_data *, void *); |
fabd1805 |
577 | void term_free(Terminal *); |
887035a5 |
578 | void term_size(Terminal *, int, int, int); |
579 | void term_out(Terminal *); |
c1b55581 |
580 | void term_paint(Terminal *, Context, int, int, int, int, int); |
887035a5 |
581 | void term_scroll(Terminal *, int, int); |
582 | void term_pwron(Terminal *); |
583 | void term_clrsb(Terminal *); |
fc5b0934 |
584 | void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action, |
585 | int,int,int,int,int); |
6c50d421 |
586 | void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int, |
587 | unsigned int); |
887035a5 |
588 | void term_deselect(Terminal *); |
589 | void term_update(Terminal *); |
590 | void term_invalidate(Terminal *); |
591 | void term_blink(Terminal *, int set_cursor); |
592 | void term_do_paste(Terminal *); |
593 | int term_paste_pending(Terminal *); |
594 | void term_paste(Terminal *); |
595 | void term_nopaste(Terminal *); |
596 | int term_ldisc(Terminal *, int option); |
597 | void term_copyall(Terminal *); |
64734920 |
598 | void term_reconfig(Terminal *, Config *); |
887035a5 |
599 | void term_seen_key_event(Terminal *); |
9fab77dc |
600 | int from_backend(void *, int is_stderr, const char *data, int len); |
51470298 |
601 | void term_provide_resize_fn(Terminal *term, |
602 | void (*resize_fn)(void *, int, int), |
603 | void *resize_ctx); |
a8327734 |
604 | void term_provide_logctx(Terminal *term, void *logctx); |
374330e2 |
605 | |
606 | /* |
00db133f |
607 | * Exports from logging.c. |
608 | */ |
c229ef97 |
609 | void *log_init(void *frontend, Config *cfg); |
fabd1805 |
610 | void log_free(void *logctx); |
c229ef97 |
611 | void log_reconfig(void *logctx, Config *cfg); |
a8327734 |
612 | void logfopen(void *logctx); |
613 | void logfclose(void *logctx); |
614 | void logtraffic(void *logctx, unsigned char c, int logmode); |
615 | void log_eventlog(void *logctx, char *string); |
00db133f |
616 | enum { PKT_INCOMING, PKT_OUTGOING }; |
a8327734 |
617 | void log_packet(void *logctx, int direction, int type, |
618 | char *texttype, void *data, int len); |
00db133f |
619 | |
620 | /* |
d082ac49 |
621 | * Exports from testback.c |
622 | */ |
623 | |
624 | extern Backend null_backend; |
625 | extern Backend loop_backend; |
626 | |
627 | /* |
5e1a8e27 |
628 | * Exports from raw.c. |
629 | */ |
630 | |
3d9a14c9 |
631 | extern Backend raw_backend; |
5e1a8e27 |
632 | |
633 | /* |
c91409da |
634 | * Exports from rlogin.c. |
635 | */ |
636 | |
637 | extern Backend rlogin_backend; |
638 | |
639 | /* |
374330e2 |
640 | * Exports from telnet.c. |
641 | */ |
642 | |
c14776e8 |
643 | extern Backend telnet_backend; |
374330e2 |
644 | |
645 | /* |
c0a81592 |
646 | * Exports from ssh.c. (NB the getline variables have to be GLOBAL |
647 | * so that PuTTYtel will still compile - otherwise it would depend |
648 | * on ssh.c.) |
374330e2 |
649 | */ |
650 | |
c0a81592 |
651 | GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen, |
32874aea |
652 | int is_pw); |
c0a81592 |
653 | GLOBAL int ssh_getline_pw_only; |
c14776e8 |
654 | extern Backend ssh_backend; |
374330e2 |
655 | |
656 | /* |
5bc238bb |
657 | * Exports from ldisc.c. |
658 | */ |
fe5634f6 |
659 | void *ldisc_create(Config *, Terminal *, Backend *, void *, void *); |
fabd1805 |
660 | void ldisc_free(void *); |
b9d7bcad |
661 | void ldisc_send(void *handle, char *buf, int len, int interactive); |
5bc238bb |
662 | |
663 | /* |
5def7522 |
664 | * Exports from ldiscucs.c. |
665 | */ |
666 | void lpage_send(void *, int codepage, char *buf, int len, int interactive); |
667 | void luni_send(void *, wchar_t * widebuf, int len, int interactive); |
668 | |
669 | /* |
374330e2 |
670 | * Exports from sshrand.c. |
671 | */ |
672 | |
673 | void random_add_noise(void *noise, int length); |
674 | void random_init(void); |
675 | int random_byte(void); |
676 | void random_get_savedata(void **data, int *len); |
93b581bd |
677 | extern int random_active; |
374330e2 |
678 | |
679 | /* |
680 | * Exports from misc.c. |
681 | */ |
682 | |
db9c0f86 |
683 | #include "misc.h" |
374330e2 |
684 | |
685 | /* |
067a15ea |
686 | * Exports from version.c. |
687 | */ |
688 | extern char ver[]; |
689 | |
690 | /* |
4eeb7d09 |
691 | * Exports from unicode.c. |
14963b8f |
692 | */ |
4eeb7d09 |
693 | #ifndef CP_UTF8 |
694 | #define CP_UTF8 65001 |
695 | #endif |
facd762c |
696 | /* void init_ucs(void); -- this is now in platform-specific headers */ |
5def7522 |
697 | int is_dbcs_leadbyte(int codepage, char byte); |
698 | int mb_to_wc(int codepage, int flags, char *mbstr, int mblen, |
699 | wchar_t *wcstr, int wclen); |
700 | int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, |
21d2b241 |
701 | char *mbstr, int mblen, char *defchr, int *defused, |
702 | struct unicode_data *ucsdata); |
a9c02454 |
703 | wchar_t xlat_uskbd2cyrllic(int ch); |
4eeb7d09 |
704 | int check_compose(int first, int second); |
705 | int decode_codepage(char *cp_name); |
875b193f |
706 | char *cp_enumerate (int index); |
4eeb7d09 |
707 | char *cp_name(int codepage); |
a7419ea4 |
708 | void get_unitab(int codepage, wchar_t * unitab, int ftype); |
14963b8f |
709 | |
710 | /* |
5f6fe27e |
711 | * Exports from wcwidth.c |
712 | */ |
713 | int wcwidth(wchar_t ucs); |
714 | int wcswidth(const wchar_t *pwcs, size_t n); |
715 | |
716 | /* |
8f203108 |
717 | * Exports from mscrypto.c |
718 | */ |
719 | #ifdef MSCRYPTOAPI |
720 | int crypto_startup(); |
721 | void crypto_wrapup(); |
722 | #endif |
723 | |
724 | /* |
5c58ad2d |
725 | * Exports from pageantc.c |
726 | */ |
727 | void agent_query(void *in, int inlen, void **out, int *outlen); |
728 | int agent_exists(void); |
729 | |
4eb24e3a |
730 | /* |
731 | * Exports from wildcard.c |
732 | */ |
733 | const char *wc_error(int value); |
734 | int wc_match(const char *wildcard, const char *target); |
735 | int wc_unescape(char *output, const char *wildcard); |
374330e2 |
736 | |
ff2ae367 |
737 | /* |
1709795f |
738 | * Exports from windlg.c |
739 | */ |
a8327734 |
740 | void logevent(void *frontend, char *); |
741 | void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, |
1709795f |
742 | char *keystr, char *fingerprint); |
a8327734 |
743 | void askcipher(void *frontend, char *ciphername, int cs); |
9a30e26b |
744 | int askappend(void *frontend, Filename filename); |
1709795f |
745 | |
746 | /* |
ff2ae367 |
747 | * Exports from console.c (that aren't equivalents to things in |
748 | * windlg.c). |
749 | */ |
750 | extern int console_batch_mode; |
ff2ae367 |
751 | int console_get_line(const char *prompt, char *str, int maxlen, int is_pw); |
d3fef4a5 |
752 | void console_provide_logctx(void *logctx); |
ff2ae367 |
753 | |
b44b307a |
754 | /* |
755 | * Exports from printing.c. |
756 | */ |
757 | typedef struct printer_enum_tag printer_enum; |
758 | typedef struct printer_job_tag printer_job; |
759 | printer_enum *printer_start_enum(int *nprinters); |
760 | char *printer_get_name(printer_enum *, int); |
761 | void printer_finish_enum(printer_enum *); |
762 | printer_job *printer_start_job(char *printer); |
763 | void printer_job_data(printer_job *, void *, int); |
764 | void printer_finish_job(printer_job *); |
765 | |
c0a81592 |
766 | /* |
767 | * Exports from cmdline.c (and also cmdline_error(), which is |
768 | * defined differently in various places and required _by_ |
769 | * cmdline.c). |
770 | */ |
5555d393 |
771 | int cmdline_process_param(char *, char *, int, Config *); |
772 | void cmdline_run_saved(Config *); |
c0a81592 |
773 | extern char *cmdline_password; |
774 | #define TOOLTYPE_FILETRANSFER 1 |
775 | extern int cmdline_tooltype; |
776 | |
777 | void cmdline_error(char *, ...); |
778 | |
e0e7dff8 |
779 | /* |
780 | * X11 auth mechanisms we know about. |
781 | */ |
782 | enum { |
783 | X11_NO_AUTH, |
784 | X11_MIT, /* MIT-MAGIC-COOKIE-1 */ |
2f92b717 |
785 | X11_XDM, /* XDM-AUTHORIZATION-1 */ |
e0e7dff8 |
786 | X11_NAUTHS |
787 | }; |
788 | extern const char *const x11_authnames[]; /* declared in x11fwd.c */ |
789 | |
9a30e26b |
790 | /* |
791 | * Miscellaneous exports from the platform-specific code. |
792 | */ |
9fab77dc |
793 | Filename filename_from_str(const char *string); |
794 | const char *filename_to_str(const Filename *fn); |
9a30e26b |
795 | int filename_equal(Filename f1, Filename f2); |
796 | int filename_is_null(Filename fn); |
797 | |
374330e2 |
798 | #endif |