374330e2 |
1 | #ifndef PUTTY_PUTTY_H |
2 | #define PUTTY_PUTTY_H |
3 | |
4 | #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY" |
de3df031 |
5 | #define PUTTY_REG_PARENT "Software\\SimonTatham" |
6 | #define PUTTY_REG_PARENT_CHILD "PuTTY" |
7 | #define PUTTY_REG_GPARENT "Software" |
8 | #define PUTTY_REG_GPARENT_CHILD "SimonTatham" |
374330e2 |
9 | |
10 | /* |
11 | * Global variables. Most modules declare these `extern', but |
12 | * window.c will do `#define PUTTY_DO_GLOBALS' before including this |
13 | * module, and so will get them properly defined. |
14 | */ |
15 | #ifdef PUTTY_DO_GLOBALS |
16 | #define GLOBAL |
17 | #else |
18 | #define GLOBAL extern |
19 | #endif |
20 | |
73251d5d |
21 | GLOBAL HINSTANCE putty_inst; |
22 | |
374330e2 |
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 |
27 | |
c9def1b8 |
28 | #define LATTR_NORM 0x00000000UL |
29 | #define LATTR_WIDE 0x01000000UL |
30 | #define LATTR_TOP 0x02000000UL |
31 | #define LATTR_BOT 0x03000000UL |
32 | #define LATTR_MODE 0x03000000UL |
33 | |
374330e2 |
34 | #define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */ |
35 | #define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */ |
36 | #define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */ |
37 | |
38 | #define ATTR_BOLD 0x00000100UL |
39 | #define ATTR_UNDER 0x00000200UL |
40 | #define ATTR_REVERSE 0x00000400UL |
e14a5a13 |
41 | #define ATTR_BLINK 0x00000800UL |
374330e2 |
42 | #define ATTR_FGMASK 0x0000F000UL |
43 | #define ATTR_BGMASK 0x000F0000UL |
44 | #define ATTR_FGSHIFT 12 |
45 | #define ATTR_BGSHIFT 16 |
46 | |
47 | #define ATTR_DEFAULT 0x00098000UL |
48 | #define ATTR_DEFFG 0x00008000UL |
49 | #define ATTR_DEFBG 0x00090000UL |
50 | #define ATTR_CUR_XOR 0x000BA000UL |
51 | #define ERASE_CHAR (ATTR_DEFAULT | ' ') |
52 | #define ATTR_MASK 0xFFFFFF00UL |
53 | #define CHAR_MASK 0x000000FFUL |
54 | |
55 | typedef HDC Context; |
56 | #define SEL_NL { 13, 10 } |
57 | |
58 | GLOBAL int rows, cols, savelines; |
59 | |
60 | GLOBAL int font_width, font_height; |
61 | |
c9def1b8 |
62 | #define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \ |
63 | inbuf[inbuf_head++] = (_C) ; } while(0) |
374330e2 |
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 | |
c9def1b8 |
75 | GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode; |
76 | GLOBAL int repeat_off, cr_lf_return; |
374330e2 |
77 | |
cabfd08c |
78 | GLOBAL int seen_key_event; |
79 | GLOBAL int seen_disp_event; |
80 | |
d85548fe |
81 | GLOBAL int session_closed; |
82 | |
5fd04f07 |
83 | GLOBAL char *logfile; |
84 | |
e14a5a13 |
85 | /* |
86 | * I've just looked in the windows standard headr files for WM_USER, there |
87 | * are hundreds of flags defined using the form WM_USER+123 so I've |
88 | * renumbered this NETEVENT value and the two in window.c |
89 | */ |
90 | #define WM_XUSER (WM_USER + 0x2000) |
91 | #define WM_NETEVENT (WM_XUSER + 5) |
374330e2 |
92 | |
93 | typedef enum { |
94 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
ec55b220 |
95 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING |
374330e2 |
96 | } Telnet_Special; |
97 | |
98 | typedef enum { |
99 | MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE |
100 | } Mouse_Button; |
101 | |
102 | typedef enum { |
103 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
104 | } Mouse_Action; |
105 | |
106 | typedef enum { |
107 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN |
108 | } VT_Mode; |
109 | |
110 | typedef struct { |
111 | char *(*init) (HWND hwnd, char *host, int port, char **realhost); |
112 | int (*msg) (WPARAM wParam, LPARAM lParam); |
113 | void (*send) (char *buf, int len); |
114 | void (*size) (void); |
115 | void (*special) (Telnet_Special code); |
4017be6d |
116 | SOCKET (*socket) (void); |
8ccc75b0 |
117 | int (*sendok) (void); |
97db3be4 |
118 | int default_port; |
374330e2 |
119 | } Backend; |
120 | |
121 | GLOBAL Backend *back; |
122 | |
297d398b |
123 | extern struct backend_list { |
89ee5268 |
124 | int protocol; |
125 | char *name; |
126 | Backend *backend; |
127 | } backends[]; |
128 | |
374330e2 |
129 | typedef struct { |
5bc238bb |
130 | void (*send) (char *buf, int len); |
131 | } Ldisc; |
132 | |
133 | GLOBAL Ldisc *ldisc; |
134 | |
135 | typedef struct { |
374330e2 |
136 | /* Basic options */ |
137 | char host[512]; |
138 | int port; |
5e1a8e27 |
139 | enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol; |
374330e2 |
140 | int close_on_exit; |
9ef49106 |
141 | int warn_on_close; |
ec55b220 |
142 | int ping_interval; |
fef97f43 |
143 | /* SSH options */ |
6abbf9e3 |
144 | char remote_cmd[512]; |
fef97f43 |
145 | int nopty; |
979310f1 |
146 | int agentfwd; |
9697bfd2 |
147 | enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher; |
7cca0d81 |
148 | char keyfile[FILENAME_MAX]; |
adf799dd |
149 | int sshprot; /* use v1 or v2 when both available */ |
ccbfb941 |
150 | int try_tis_auth; |
374330e2 |
151 | /* Telnet options */ |
152 | char termtype[32]; |
153 | char termspeed[32]; |
37508af4 |
154 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
374330e2 |
155 | char username[32]; |
156 | int rfc_environ; |
157 | /* Keyboard options */ |
158 | int bksp_is_delete; |
159 | int rxvt_homeend; |
c9def1b8 |
160 | int funky_type; |
374330e2 |
161 | int app_cursor; |
162 | int app_keypad; |
c5e9c988 |
163 | int nethack_keypad; |
164 | int alt_f4; /* is it special? */ |
165 | int alt_space; /* is it special? */ |
5bc238bb |
166 | int ldisc_term; |
c9def1b8 |
167 | int scroll_on_key; |
9ca5da42 |
168 | char wintitle[256]; /* initial window title */ |
374330e2 |
169 | /* Terminal options */ |
170 | int savelines; |
171 | int dec_om; |
172 | int wrap_mode; |
fef97f43 |
173 | int lfhascr; |
c9def1b8 |
174 | int blink_cur; |
175 | int beep; |
176 | int scrollbar; |
177 | int locksize; |
178 | int bce; |
179 | int blinktext; |
374330e2 |
180 | int win_name_always; |
181 | int width, height; |
182 | char font[64]; |
183 | int fontisbold; |
184 | int fontheight; |
14963b8f |
185 | int fontcharset; |
374330e2 |
186 | /* Colour options */ |
187 | int try_palette; |
188 | int bold_colour; |
189 | unsigned char colours[22][3]; |
190 | /* Selection options */ |
191 | int mouse_is_xterm; |
192 | short wordness[256]; |
c9def1b8 |
193 | /* translations */ |
194 | VT_Mode vtmode; |
14963b8f |
195 | int xlat_enablekoiwin; |
d3d16feb |
196 | int xlat_88592w1250; |
14963b8f |
197 | int xlat_capslockcyr; |
374330e2 |
198 | } Config; |
199 | |
e277c42d |
200 | /* |
201 | * You can compile with -DSSH_DEFAULT to have ssh by default. |
202 | */ |
203 | #ifndef SSH_DEFAULT |
204 | #define DEFAULT_PROTOCOL PROT_TELNET |
205 | #define DEFAULT_PORT 23 |
206 | #else |
207 | #define DEFAULT_PROTOCOL PROT_SSH |
208 | #define DEFAULT_PORT 22 |
209 | #endif |
210 | |
4017be6d |
211 | /* |
212 | * Some global flags denoting the type of application. |
67779be7 |
213 | * |
214 | * FLAG_VERBOSE is set when the user requests verbose details. |
215 | * |
216 | * FLAG_STDERR is set in command-line applications (which have a |
217 | * functioning stderr that it makes sense to write to) and not in |
218 | * GUI applications (which don't). |
219 | * |
220 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
221 | * being run, _either_ because no remote command has been provided |
222 | * _or_ because the application is GUI and can't run non- |
223 | * interactively. |
4017be6d |
224 | */ |
67779be7 |
225 | #define FLAG_VERBOSE 0x0001 |
226 | #define FLAG_STDERR 0x0002 |
227 | #define FLAG_INTERACTIVE 0x0004 |
4017be6d |
228 | GLOBAL int flags; |
229 | |
374330e2 |
230 | GLOBAL Config cfg; |
e277c42d |
231 | GLOBAL int default_protocol; |
232 | GLOBAL int default_port; |
374330e2 |
233 | |
4e23b276 |
234 | struct RSAKey; /* be a little careful of scope */ |
235 | |
374330e2 |
236 | /* |
237 | * Exports from window.c. |
238 | */ |
e14a5a13 |
239 | void request_resize (int, int, int); |
c9def1b8 |
240 | void do_text (Context, int, int, char *, int, unsigned long, int); |
374330e2 |
241 | void set_title (char *); |
242 | void set_icon (char *); |
243 | void set_sbar (int, int, int); |
f67b4e85 |
244 | Context get_ctx(void); |
374330e2 |
245 | void free_ctx (Context); |
246 | void palette_set (int, int, int, int); |
247 | void palette_reset (void); |
f0df44da |
248 | void write_clip (void *, int, int); |
374330e2 |
249 | void get_clip (void **, int *); |
250 | void optimised_move (int, int, int); |
8d5de777 |
251 | void connection_fatal(char *, ...); |
374330e2 |
252 | void fatalbox (char *, ...); |
c9def1b8 |
253 | void beep (int); |
6f34e365 |
254 | void begin_session(void); |
ec8679e9 |
255 | void sys_cursor(int x, int y); |
374330e2 |
256 | #define OPTIMISE_IS_SCROLL 1 |
257 | |
258 | /* |
259 | * Exports from noise.c. |
260 | */ |
261 | void noise_get_heavy(void (*func) (void *, int)); |
262 | void noise_get_light(void (*func) (void *, int)); |
263 | void noise_ultralight(DWORD data); |
264 | void random_save_seed(void); |
de3df031 |
265 | void random_destroy_seed(void); |
374330e2 |
266 | |
267 | /* |
268 | * Exports from windlg.c. |
269 | */ |
270 | int do_config (void); |
271 | int do_reconfig (HWND); |
a9422f39 |
272 | void do_defaults (char *, Config *); |
c5e9c988 |
273 | void logevent (char *); |
274 | void showeventlog (HWND); |
374330e2 |
275 | void showabout (HWND); |
d4857987 |
276 | void verify_ssh_host_key(char *host, int port, char *keytype, |
d5859615 |
277 | char *keystr, char *fingerprint); |
de3df031 |
278 | void registry_cleanup(void); |
0a4aa984 |
279 | |
7393a137 |
280 | GLOBAL int nsessions; |
281 | GLOBAL char **sessions; |
374330e2 |
282 | |
283 | /* |
a9422f39 |
284 | * Exports from settings.c. |
285 | */ |
286 | void save_settings (char *section, int do_host, Config *cfg); |
287 | void load_settings (char *section, int do_host, Config *cfg); |
288 | void get_sesslist(int allocate); |
289 | |
290 | /* |
374330e2 |
291 | * Exports from terminal.c. |
292 | */ |
293 | |
294 | void term_init (void); |
295 | void term_size (int, int, int); |
296 | void term_out (void); |
297 | void term_paint (Context, int, int, int, int); |
298 | void term_scroll (int, int); |
299 | void term_pwron (void); |
300 | void term_clrsb (void); |
301 | void term_mouse (Mouse_Button, Mouse_Action, int, int); |
302 | void term_deselect (void); |
303 | void term_update (void); |
304 | void term_invalidate(void); |
e14a5a13 |
305 | void term_blink(int set_cursor); |
c9def1b8 |
306 | void term_paste(void); |
307 | void term_nopaste(void); |
374330e2 |
308 | |
309 | /* |
5e1a8e27 |
310 | * Exports from raw.c. |
311 | */ |
312 | |
3d9a14c9 |
313 | extern Backend raw_backend; |
5e1a8e27 |
314 | |
315 | /* |
374330e2 |
316 | * Exports from telnet.c. |
317 | */ |
318 | |
c14776e8 |
319 | extern Backend telnet_backend; |
374330e2 |
320 | |
321 | /* |
322 | * Exports from ssh.c. |
323 | */ |
324 | |
67779be7 |
325 | extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen); |
c14776e8 |
326 | extern Backend ssh_backend; |
374330e2 |
327 | |
328 | /* |
5bc238bb |
329 | * Exports from ldisc.c. |
330 | */ |
331 | |
332 | extern Ldisc ldisc_term, ldisc_simple; |
333 | |
334 | /* |
374330e2 |
335 | * Exports from sshrand.c. |
336 | */ |
337 | |
338 | void random_add_noise(void *noise, int length); |
339 | void random_init(void); |
340 | int random_byte(void); |
341 | void random_get_savedata(void **data, int *len); |
342 | |
343 | /* |
344 | * Exports from misc.c. |
345 | */ |
346 | |
347 | /* #define MALLOC_LOG do this if you suspect putty of leaking memory */ |
348 | #ifdef MALLOC_LOG |
349 | #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z)) |
350 | #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z)) |
351 | #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z)) |
352 | void mlog(char *, int); |
353 | #else |
354 | #define smalloc safemalloc |
355 | #define srealloc saferealloc |
356 | #define sfree safefree |
357 | #endif |
358 | |
359 | void *safemalloc(size_t); |
360 | void *saferealloc(void *, size_t); |
361 | void safefree(void *); |
362 | |
363 | /* |
067a15ea |
364 | * Exports from version.c. |
365 | */ |
366 | extern char ver[]; |
367 | |
368 | /* |
b73fd1b1 |
369 | * Exports from sizetip.c. |
370 | */ |
371 | void UpdateSizeTip(HWND src, int cx, int cy); |
372 | void EnableSizeTip(int bEnable); |
373 | |
374 | /* |
14963b8f |
375 | * Exports from xlat.c. |
376 | */ |
377 | unsigned char xlat_kbd2tty(unsigned char c); |
378 | unsigned char xlat_tty2scr(unsigned char c); |
379 | unsigned char xlat_latkbd2win(unsigned char c); |
380 | |
381 | /* |
8f203108 |
382 | * Exports from mscrypto.c |
383 | */ |
384 | #ifdef MSCRYPTOAPI |
385 | int crypto_startup(); |
386 | void crypto_wrapup(); |
387 | #endif |
388 | |
389 | /* |
5c58ad2d |
390 | * Exports from pageantc.c |
391 | */ |
392 | void agent_query(void *in, int inlen, void **out, int *outlen); |
393 | int agent_exists(void); |
394 | |
395 | /* |
374330e2 |
396 | * A debug system. |
397 | */ |
398 | #ifdef DEBUG |
399 | #include <stdarg.h> |
400 | #define debug(x) (dprintf x) |
401 | static void dprintf(char *fmt, ...) { |
402 | char buf[2048]; |
403 | DWORD dw; |
404 | va_list ap; |
405 | static int gotconsole = 0; |
406 | |
407 | if (!gotconsole) { |
408 | AllocConsole(); |
409 | gotconsole = 1; |
410 | } |
411 | |
412 | va_start(ap, fmt); |
413 | vsprintf(buf, fmt, ap); |
414 | WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL); |
415 | va_end(ap); |
416 | } |
417 | #else |
418 | #define debug(x) |
419 | #endif |
420 | |
421 | #endif |