374330e2 |
1 | #ifndef PUTTY_PUTTY_H |
2 | #define PUTTY_PUTTY_H |
3 | |
8df7a775 |
4 | #include "network.h" |
5 | |
374330e2 |
6 | #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY" |
de3df031 |
7 | #define PUTTY_REG_PARENT "Software\\SimonTatham" |
8 | #define PUTTY_REG_PARENT_CHILD "PuTTY" |
9 | #define PUTTY_REG_GPARENT "Software" |
10 | #define PUTTY_REG_GPARENT_CHILD "SimonTatham" |
374330e2 |
11 | |
12 | /* |
13 | * Global variables. Most modules declare these `extern', but |
14 | * window.c will do `#define PUTTY_DO_GLOBALS' before including this |
15 | * module, and so will get them properly defined. |
16 | */ |
17 | #ifdef PUTTY_DO_GLOBALS |
18 | #define GLOBAL |
19 | #else |
20 | #define GLOBAL extern |
21 | #endif |
22 | |
23 | #define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */ |
24 | #define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */ |
25 | #define ATTR_INVALID 0x20000000UL |
26 | #define ATTR_WRAPPED 0x10000000UL |
4e30ff69 |
27 | #define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */ |
374330e2 |
28 | |
c9def1b8 |
29 | #define LATTR_NORM 0x00000000UL |
30 | #define LATTR_WIDE 0x01000000UL |
31 | #define LATTR_TOP 0x02000000UL |
32 | #define LATTR_BOT 0x03000000UL |
33 | #define LATTR_MODE 0x03000000UL |
34 | |
374330e2 |
35 | #define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */ |
36 | #define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */ |
37 | #define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */ |
38 | |
39 | #define ATTR_BOLD 0x00000100UL |
40 | #define ATTR_UNDER 0x00000200UL |
41 | #define ATTR_REVERSE 0x00000400UL |
e14a5a13 |
42 | #define ATTR_BLINK 0x00000800UL |
374330e2 |
43 | #define ATTR_FGMASK 0x0000F000UL |
44 | #define ATTR_BGMASK 0x000F0000UL |
45 | #define ATTR_FGSHIFT 12 |
46 | #define ATTR_BGSHIFT 16 |
47 | |
48 | #define ATTR_DEFAULT 0x00098000UL |
49 | #define ATTR_DEFFG 0x00008000UL |
50 | #define ATTR_DEFBG 0x00090000UL |
51 | #define ATTR_CUR_XOR 0x000BA000UL |
52 | #define ERASE_CHAR (ATTR_DEFAULT | ' ') |
53 | #define ATTR_MASK 0xFFFFFF00UL |
54 | #define CHAR_MASK 0x000000FFUL |
d3a22f79 |
55 | #define CSET_MASK 0x00F00000UL /* mask for character set */ |
374330e2 |
56 | |
57 | typedef HDC Context; |
58 | #define SEL_NL { 13, 10 } |
59 | |
60 | GLOBAL int rows, cols, savelines; |
61 | |
62 | GLOBAL int font_width, font_height; |
63 | |
64 | #define INBUF_SIZE 2048 |
374330e2 |
65 | GLOBAL unsigned char inbuf[INBUF_SIZE]; |
c9def1b8 |
66 | GLOBAL int inbuf_head; |
374330e2 |
67 | |
68 | #define OUTBUF_SIZE 2048 |
69 | #define OUTBUF_MASK (OUTBUF_SIZE-1) |
70 | GLOBAL unsigned char outbuf[OUTBUF_SIZE]; |
71 | GLOBAL int outbuf_head, outbuf_reap; |
72 | |
73 | GLOBAL int has_focus; |
74 | |
156686ef |
75 | GLOBAL int in_vbell; |
76 | GLOBAL long vbell_timeout; |
77 | |
c9def1b8 |
78 | GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode; |
79 | GLOBAL int repeat_off, cr_lf_return; |
374330e2 |
80 | |
cabfd08c |
81 | GLOBAL int seen_key_event; |
82 | GLOBAL int seen_disp_event; |
83 | |
d85548fe |
84 | GLOBAL int session_closed; |
85 | |
e1c8e0ed |
86 | #define LGTYP_NONE 0 /* logmode: no logging */ |
87 | #define LGTYP_ASCII 1 /* logmode: pure ascii */ |
88 | #define LGTYP_DEBUG 2 /* logmode: all chars of taffic */ |
5fd04f07 |
89 | GLOBAL char *logfile; |
90 | |
e14a5a13 |
91 | /* |
475eebf9 |
92 | * Window handles for the dialog boxes that can be running during a |
93 | * PuTTY session. |
94 | */ |
95 | GLOBAL HWND logbox; |
96 | |
97 | /* |
e14a5a13 |
98 | * I've just looked in the windows standard headr files for WM_USER, there |
99 | * are hundreds of flags defined using the form WM_USER+123 so I've |
100 | * renumbered this NETEVENT value and the two in window.c |
101 | */ |
102 | #define WM_XUSER (WM_USER + 0x2000) |
103 | #define WM_NETEVENT (WM_XUSER + 5) |
374330e2 |
104 | |
105 | typedef enum { |
106 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
ec55b220 |
107 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING |
374330e2 |
108 | } Telnet_Special; |
109 | |
110 | typedef enum { |
111 | MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE |
112 | } Mouse_Button; |
113 | |
114 | typedef enum { |
115 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
116 | } Mouse_Action; |
117 | |
118 | typedef enum { |
119 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN |
120 | } VT_Mode; |
121 | |
0965bee0 |
122 | enum { |
123 | /* |
124 | * Line discipline option states: off, on, up to the backend. |
125 | */ |
126 | LD_YES, LD_NO, LD_BACKEND |
127 | }; |
128 | |
129 | enum { |
130 | /* |
131 | * Line discipline options which the backend might try to control. |
132 | */ |
133 | LD_EDIT, /* local line editing */ |
134 | LD_ECHO /* local echo */ |
135 | }; |
136 | |
b41069ff |
137 | enum { |
138 | /* |
139 | * Close On Exit behaviours. (cfg.close_on_exit) |
140 | */ |
141 | COE_NEVER, /* Never close the window */ |
1cd48051 |
142 | COE_NORMAL, /* Close window on "normal" (non-error) exits only */ |
143 | COE_ALWAYS /* Always close the window */ |
b41069ff |
144 | }; |
145 | |
374330e2 |
146 | typedef struct { |
8df7a775 |
147 | char *(*init) (char *host, int port, char **realhost); |
374330e2 |
148 | void (*send) (char *buf, int len); |
149 | void (*size) (void); |
150 | void (*special) (Telnet_Special code); |
8df7a775 |
151 | Socket (*socket) (void); |
8ccc75b0 |
152 | int (*sendok) (void); |
0965bee0 |
153 | int (*ldisc) (int); |
97db3be4 |
154 | int default_port; |
374330e2 |
155 | } Backend; |
156 | |
157 | GLOBAL Backend *back; |
158 | |
297d398b |
159 | extern struct backend_list { |
89ee5268 |
160 | int protocol; |
161 | char *name; |
162 | Backend *backend; |
163 | } backends[]; |
164 | |
374330e2 |
165 | typedef struct { |
166 | /* Basic options */ |
167 | char host[512]; |
168 | int port; |
c91409da |
169 | enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol; |
374330e2 |
170 | int close_on_exit; |
9ef49106 |
171 | int warn_on_close; |
edce8e45 |
172 | int ping_interval; /* in seconds */ |
fef97f43 |
173 | /* SSH options */ |
6abbf9e3 |
174 | char remote_cmd[512]; |
96621a84 |
175 | char *remote_cmd_ptr; /* might point to a larger command |
176 | * but never for loading/saving */ |
fef97f43 |
177 | int nopty; |
4ba9b64b |
178 | int compression; |
979310f1 |
179 | int agentfwd; |
0a3f1d48 |
180 | enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher; |
7cca0d81 |
181 | char keyfile[FILENAME_MAX]; |
adf799dd |
182 | int sshprot; /* use v1 or v2 when both available */ |
7591b9ff |
183 | int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */ |
ccbfb941 |
184 | int try_tis_auth; |
4a8fc3c4 |
185 | int ssh_subsys; /* run a subsystem rather than a command */ |
374330e2 |
186 | /* Telnet options */ |
187 | char termtype[32]; |
188 | char termspeed[32]; |
37508af4 |
189 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
374330e2 |
190 | char username[32]; |
c91409da |
191 | char localusername[32]; |
374330e2 |
192 | int rfc_environ; |
193 | /* Keyboard options */ |
194 | int bksp_is_delete; |
195 | int rxvt_homeend; |
c9def1b8 |
196 | int funky_type; |
b00f8b34 |
197 | int no_applic_c; /* totally disable app cursor keys */ |
198 | int no_applic_k; /* totally disable app keypad */ |
374330e2 |
199 | int app_cursor; |
200 | int app_keypad; |
c5e9c988 |
201 | int nethack_keypad; |
202 | int alt_f4; /* is it special? */ |
203 | int alt_space; /* is it special? */ |
a094ae43 |
204 | int alt_only; /* is it special? */ |
0965bee0 |
205 | int localecho; |
206 | int localedit; |
e95edc00 |
207 | int alwaysontop; |
c9def1b8 |
208 | int scroll_on_key; |
a094ae43 |
209 | int scroll_on_disp; |
210 | int compose_key; |
95bbe1ae |
211 | int ctrlaltkeys; |
9ca5da42 |
212 | char wintitle[256]; /* initial window title */ |
374330e2 |
213 | /* Terminal options */ |
214 | int savelines; |
215 | int dec_om; |
216 | int wrap_mode; |
fef97f43 |
217 | int lfhascr; |
4e30ff69 |
218 | int cursor_type; /* 0=block 1=underline 2=vertical */ |
c9def1b8 |
219 | int blink_cur; |
156686ef |
220 | int beep; /* 0=none 1=defaultsound 2=visual */ |
221 | int bellovl; /* bell overload protection active? */ |
222 | int bellovl_n; /* number of bells to cause overload */ |
223 | int bellovl_t; /* time interval for overload (seconds) */ |
224 | int bellovl_s; /* period of silence to re-enable bell (s) */ |
c9def1b8 |
225 | int scrollbar; |
226 | int locksize; |
227 | int bce; |
228 | int blinktext; |
374330e2 |
229 | int win_name_always; |
230 | int width, height; |
231 | char font[64]; |
232 | int fontisbold; |
233 | int fontheight; |
14963b8f |
234 | int fontcharset; |
e1c8e0ed |
235 | char logfilename[FILENAME_MAX]; |
236 | int logtype; |
554c540d |
237 | int hide_mouseptr; |
e7fbcdd8 |
238 | char answerback[256]; |
374330e2 |
239 | /* Colour options */ |
240 | int try_palette; |
241 | int bold_colour; |
242 | unsigned char colours[22][3]; |
243 | /* Selection options */ |
244 | int mouse_is_xterm; |
d3a22f79 |
245 | int rawcnp; |
374330e2 |
246 | short wordness[256]; |
c9def1b8 |
247 | /* translations */ |
248 | VT_Mode vtmode; |
14963b8f |
249 | int xlat_enablekoiwin; |
d3d16feb |
250 | int xlat_88592w1250; |
b0faa571 |
251 | int xlat_88592cp852; |
14963b8f |
252 | int xlat_capslockcyr; |
9c964e85 |
253 | /* X11 forwarding */ |
254 | int x11_forward; |
255 | char x11_display[128]; |
374330e2 |
256 | } Config; |
257 | |
e277c42d |
258 | /* |
259 | * You can compile with -DSSH_DEFAULT to have ssh by default. |
260 | */ |
261 | #ifndef SSH_DEFAULT |
262 | #define DEFAULT_PROTOCOL PROT_TELNET |
263 | #define DEFAULT_PORT 23 |
264 | #else |
265 | #define DEFAULT_PROTOCOL PROT_SSH |
266 | #define DEFAULT_PORT 22 |
267 | #endif |
268 | |
4017be6d |
269 | /* |
270 | * Some global flags denoting the type of application. |
67779be7 |
271 | * |
272 | * FLAG_VERBOSE is set when the user requests verbose details. |
273 | * |
274 | * FLAG_STDERR is set in command-line applications (which have a |
275 | * functioning stderr that it makes sense to write to) and not in |
276 | * GUI applications (which don't). |
277 | * |
278 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
279 | * being run, _either_ because no remote command has been provided |
280 | * _or_ because the application is GUI and can't run non- |
281 | * interactively. |
4017be6d |
282 | */ |
67779be7 |
283 | #define FLAG_VERBOSE 0x0001 |
284 | #define FLAG_STDERR 0x0002 |
285 | #define FLAG_INTERACTIVE 0x0004 |
4017be6d |
286 | GLOBAL int flags; |
287 | |
374330e2 |
288 | GLOBAL Config cfg; |
e277c42d |
289 | GLOBAL int default_protocol; |
290 | GLOBAL int default_port; |
374330e2 |
291 | |
4e23b276 |
292 | struct RSAKey; /* be a little careful of scope */ |
293 | |
374330e2 |
294 | /* |
295 | * Exports from window.c. |
296 | */ |
e14a5a13 |
297 | void request_resize (int, int, int); |
c9def1b8 |
298 | void do_text (Context, int, int, char *, int, unsigned long, int); |
374330e2 |
299 | void set_title (char *); |
300 | void set_icon (char *); |
301 | void set_sbar (int, int, int); |
f67b4e85 |
302 | Context get_ctx(void); |
374330e2 |
303 | void free_ctx (Context); |
304 | void palette_set (int, int, int, int); |
305 | void palette_reset (void); |
f0df44da |
306 | void write_clip (void *, int, int); |
374330e2 |
307 | void get_clip (void **, int *); |
308 | void optimised_move (int, int, int); |
8d5de777 |
309 | void connection_fatal(char *, ...); |
374330e2 |
310 | void fatalbox (char *, ...); |
c9def1b8 |
311 | void beep (int); |
6f34e365 |
312 | void begin_session(void); |
ec8679e9 |
313 | void sys_cursor(int x, int y); |
374330e2 |
314 | #define OPTIMISE_IS_SCROLL 1 |
315 | |
316 | /* |
317 | * Exports from noise.c. |
318 | */ |
7d6ee6ff |
319 | void noise_get_heavy(void (*func)(void *, int)); |
320 | void noise_get_light(void (*func)(void *, int)); |
321 | void noise_regular(void); |
374330e2 |
322 | void noise_ultralight(DWORD data); |
323 | void random_save_seed(void); |
de3df031 |
324 | void random_destroy_seed(void); |
374330e2 |
325 | |
326 | /* |
327 | * Exports from windlg.c. |
328 | */ |
8c3cd914 |
329 | void defuse_showwindow(void); |
374330e2 |
330 | int do_config (void); |
331 | int do_reconfig (HWND); |
a9422f39 |
332 | void do_defaults (char *, Config *); |
c5e9c988 |
333 | void logevent (char *); |
334 | void showeventlog (HWND); |
374330e2 |
335 | void showabout (HWND); |
d4857987 |
336 | void verify_ssh_host_key(char *host, int port, char *keytype, |
d5859615 |
337 | char *keystr, char *fingerprint); |
e1c8e0ed |
338 | int askappend(char *filename); |
de3df031 |
339 | void registry_cleanup(void); |
3da0b1d2 |
340 | void force_normal(HWND hwnd); |
0a4aa984 |
341 | |
7393a137 |
342 | GLOBAL int nsessions; |
343 | GLOBAL char **sessions; |
374330e2 |
344 | |
345 | /* |
a9422f39 |
346 | * Exports from settings.c. |
347 | */ |
348 | void save_settings (char *section, int do_host, Config *cfg); |
349 | void load_settings (char *section, int do_host, Config *cfg); |
350 | void get_sesslist(int allocate); |
351 | |
352 | /* |
374330e2 |
353 | * Exports from terminal.c. |
354 | */ |
355 | |
356 | void term_init (void); |
357 | void term_size (int, int, int); |
358 | void term_out (void); |
359 | void term_paint (Context, int, int, int, int); |
360 | void term_scroll (int, int); |
361 | void term_pwron (void); |
362 | void term_clrsb (void); |
363 | void term_mouse (Mouse_Button, Mouse_Action, int, int); |
364 | void term_deselect (void); |
365 | void term_update (void); |
366 | void term_invalidate(void); |
e14a5a13 |
367 | void term_blink(int set_cursor); |
c9def1b8 |
368 | void term_paste(void); |
369 | void term_nopaste(void); |
feb7fdfe |
370 | int term_ldisc(int option); |
fe50e814 |
371 | void from_backend(int is_stderr, char *data, int len); |
e1c8e0ed |
372 | void logfopen (void); |
373 | void logfclose (void); |
bc1235d4 |
374 | void term_copyall(void); |
374330e2 |
375 | |
376 | /* |
5e1a8e27 |
377 | * Exports from raw.c. |
378 | */ |
379 | |
3d9a14c9 |
380 | extern Backend raw_backend; |
5e1a8e27 |
381 | |
382 | /* |
c91409da |
383 | * Exports from rlogin.c. |
384 | */ |
385 | |
386 | extern Backend rlogin_backend; |
387 | |
388 | /* |
374330e2 |
389 | * Exports from telnet.c. |
390 | */ |
391 | |
c14776e8 |
392 | extern Backend telnet_backend; |
374330e2 |
393 | |
394 | /* |
395 | * Exports from ssh.c. |
396 | */ |
397 | |
fa17a66e |
398 | extern int (*ssh_get_line)(const char *prompt, char *str, int maxlen, |
399 | int is_pw); |
c14776e8 |
400 | extern Backend ssh_backend; |
374330e2 |
401 | |
402 | /* |
5bc238bb |
403 | * Exports from ldisc.c. |
404 | */ |
405 | |
0965bee0 |
406 | extern void ldisc_send(char *buf, int len); |
5bc238bb |
407 | |
408 | /* |
374330e2 |
409 | * Exports from sshrand.c. |
410 | */ |
411 | |
412 | void random_add_noise(void *noise, int length); |
413 | void random_init(void); |
414 | int random_byte(void); |
415 | void random_get_savedata(void **data, int *len); |
416 | |
417 | /* |
418 | * Exports from misc.c. |
419 | */ |
420 | |
dcbde236 |
421 | #include "puttymem.h" |
374330e2 |
422 | |
423 | /* |
067a15ea |
424 | * Exports from version.c. |
425 | */ |
426 | extern char ver[]; |
427 | |
428 | /* |
b73fd1b1 |
429 | * Exports from sizetip.c. |
430 | */ |
431 | void UpdateSizeTip(HWND src, int cx, int cy); |
432 | void EnableSizeTip(int bEnable); |
433 | |
434 | /* |
14963b8f |
435 | * Exports from xlat.c. |
436 | */ |
437 | unsigned char xlat_kbd2tty(unsigned char c); |
438 | unsigned char xlat_tty2scr(unsigned char c); |
439 | unsigned char xlat_latkbd2win(unsigned char c); |
440 | |
441 | /* |
8f203108 |
442 | * Exports from mscrypto.c |
443 | */ |
444 | #ifdef MSCRYPTOAPI |
445 | int crypto_startup(); |
446 | void crypto_wrapup(); |
447 | #endif |
448 | |
449 | /* |
5c58ad2d |
450 | * Exports from pageantc.c |
451 | */ |
452 | void agent_query(void *in, int inlen, void **out, int *outlen); |
453 | int agent_exists(void); |
454 | |
374330e2 |
455 | #ifdef DEBUG |
c82bda52 |
456 | void dprintf(char *fmt, ...); |
374330e2 |
457 | #define debug(x) (dprintf x) |
374330e2 |
458 | #else |
459 | #define debug(x) |
460 | #endif |
461 | |
462 | #endif |