Keyboard handling patch from RDB: the Windows Application key is now
[sgt/putty] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include "network.h"
5
6 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
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"
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
27 #define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */
28
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
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
42 #define ATTR_BLINK 0x00000800UL
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
55 #define CSET_MASK 0x00F00000UL /* mask for character set */
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
65 GLOBAL unsigned char inbuf[INBUF_SIZE];
66 GLOBAL int inbuf_head;
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
75 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
76 GLOBAL int repeat_off, cr_lf_return;
77
78 GLOBAL int seen_key_event;
79 GLOBAL int seen_disp_event;
80
81 GLOBAL int session_closed;
82
83 #define LGTYP_NONE 0 /* logmode: no logging */
84 #define LGTYP_ASCII 1 /* logmode: pure ascii */
85 #define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
86 GLOBAL char *logfile;
87
88 /*
89 * Window handles for the dialog boxes that can be running during a
90 * PuTTY session.
91 */
92 GLOBAL HWND logbox;
93
94 /*
95 * I've just looked in the windows standard headr files for WM_USER, there
96 * are hundreds of flags defined using the form WM_USER+123 so I've
97 * renumbered this NETEVENT value and the two in window.c
98 */
99 #define WM_XUSER (WM_USER + 0x2000)
100 #define WM_NETEVENT (WM_XUSER + 5)
101
102 typedef enum {
103 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
104 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
105 } Telnet_Special;
106
107 typedef enum {
108 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
109 } Mouse_Button;
110
111 typedef enum {
112 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
113 } Mouse_Action;
114
115 typedef enum {
116 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
117 } VT_Mode;
118
119 enum {
120 /*
121 * Line discipline option states: off, on, up to the backend.
122 */
123 LD_YES, LD_NO, LD_BACKEND
124 };
125
126 enum {
127 /*
128 * Line discipline options which the backend might try to control.
129 */
130 LD_EDIT, /* local line editing */
131 LD_ECHO /* local echo */
132 };
133
134 enum {
135 /*
136 * Close On Exit behaviours. (cfg.close_on_exit)
137 */
138 COE_NEVER, /* Never close the window */
139 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
140 COE_ALWAYS /* Always close the window */
141 };
142
143 typedef struct {
144 char *(*init) (char *host, int port, char **realhost);
145 void (*send) (char *buf, int len);
146 void (*size) (void);
147 void (*special) (Telnet_Special code);
148 Socket (*socket) (void);
149 int (*sendok) (void);
150 int (*ldisc) (int);
151 int default_port;
152 } Backend;
153
154 GLOBAL Backend *back;
155
156 extern struct backend_list {
157 int protocol;
158 char *name;
159 Backend *backend;
160 } backends[];
161
162 typedef struct {
163 /* Basic options */
164 char host[512];
165 int port;
166 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
167 int close_on_exit;
168 int warn_on_close;
169 int ping_interval; /* in seconds */
170 /* SSH options */
171 char remote_cmd[512];
172 char *remote_cmd_ptr; /* might point to a larger command
173 * but never for loading/saving */
174 int nopty;
175 int compression;
176 int agentfwd;
177 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
178 char keyfile[FILENAME_MAX];
179 int sshprot; /* use v1 or v2 when both available */
180 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
181 int try_tis_auth;
182 int ssh_subsys; /* run a subsystem rather than a command */
183 /* Telnet options */
184 char termtype[32];
185 char termspeed[32];
186 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
187 char username[32];
188 char localusername[32];
189 int rfc_environ;
190 /* Keyboard options */
191 int bksp_is_delete;
192 int rxvt_homeend;
193 int funky_type;
194 int no_applic_c; /* totally disable app cursor keys */
195 int no_applic_k; /* totally disable app keypad */
196 int app_cursor;
197 int app_keypad;
198 int nethack_keypad;
199 int alt_f4; /* is it special? */
200 int alt_space; /* is it special? */
201 int alt_only; /* is it special? */
202 int localecho;
203 int localedit;
204 int alwaysontop;
205 int scroll_on_key;
206 int scroll_on_disp;
207 int compose_key;
208 int ctrlaltkeys;
209 char wintitle[256]; /* initial window title */
210 /* Terminal options */
211 int savelines;
212 int dec_om;
213 int wrap_mode;
214 int lfhascr;
215 int cursor_type; /* 0=block 1=underline 2=vertical */
216 int blink_cur;
217 int beep;
218 int scrollbar;
219 int locksize;
220 int bce;
221 int blinktext;
222 int win_name_always;
223 int width, height;
224 char font[64];
225 int fontisbold;
226 int fontheight;
227 int fontcharset;
228 char logfilename[FILENAME_MAX];
229 int logtype;
230 int hide_mouseptr;
231 char answerback[256];
232 /* Colour options */
233 int try_palette;
234 int bold_colour;
235 unsigned char colours[22][3];
236 /* Selection options */
237 int mouse_is_xterm;
238 int rawcnp;
239 short wordness[256];
240 /* translations */
241 VT_Mode vtmode;
242 int xlat_enablekoiwin;
243 int xlat_88592w1250;
244 int xlat_88592cp852;
245 int xlat_capslockcyr;
246 /* X11 forwarding */
247 int x11_forward;
248 char x11_display[128];
249 } Config;
250
251 /*
252 * You can compile with -DSSH_DEFAULT to have ssh by default.
253 */
254 #ifndef SSH_DEFAULT
255 #define DEFAULT_PROTOCOL PROT_TELNET
256 #define DEFAULT_PORT 23
257 #else
258 #define DEFAULT_PROTOCOL PROT_SSH
259 #define DEFAULT_PORT 22
260 #endif
261
262 /*
263 * Some global flags denoting the type of application.
264 *
265 * FLAG_VERBOSE is set when the user requests verbose details.
266 *
267 * FLAG_STDERR is set in command-line applications (which have a
268 * functioning stderr that it makes sense to write to) and not in
269 * GUI applications (which don't).
270 *
271 * FLAG_INTERACTIVE is set when a full interactive shell session is
272 * being run, _either_ because no remote command has been provided
273 * _or_ because the application is GUI and can't run non-
274 * interactively.
275 */
276 #define FLAG_VERBOSE 0x0001
277 #define FLAG_STDERR 0x0002
278 #define FLAG_INTERACTIVE 0x0004
279 GLOBAL int flags;
280
281 GLOBAL Config cfg;
282 GLOBAL int default_protocol;
283 GLOBAL int default_port;
284
285 struct RSAKey; /* be a little careful of scope */
286
287 /*
288 * Exports from window.c.
289 */
290 void request_resize (int, int, int);
291 void do_text (Context, int, int, char *, int, unsigned long, int);
292 void set_title (char *);
293 void set_icon (char *);
294 void set_sbar (int, int, int);
295 Context get_ctx(void);
296 void free_ctx (Context);
297 void palette_set (int, int, int, int);
298 void palette_reset (void);
299 void write_clip (void *, int, int);
300 void get_clip (void **, int *);
301 void optimised_move (int, int, int);
302 void connection_fatal(char *, ...);
303 void fatalbox (char *, ...);
304 void beep (int);
305 void begin_session(void);
306 void sys_cursor(int x, int y);
307 #define OPTIMISE_IS_SCROLL 1
308
309 /*
310 * Exports from noise.c.
311 */
312 void noise_get_heavy(void (*func)(void *, int));
313 void noise_get_light(void (*func)(void *, int));
314 void noise_regular(void);
315 void noise_ultralight(DWORD data);
316 void random_save_seed(void);
317 void random_destroy_seed(void);
318
319 /*
320 * Exports from windlg.c.
321 */
322 void defuse_showwindow(void);
323 int do_config (void);
324 int do_reconfig (HWND);
325 void do_defaults (char *, Config *);
326 void logevent (char *);
327 void showeventlog (HWND);
328 void showabout (HWND);
329 void verify_ssh_host_key(char *host, int port, char *keytype,
330 char *keystr, char *fingerprint);
331 int askappend(char *filename);
332 void registry_cleanup(void);
333 void force_normal(HWND hwnd);
334
335 GLOBAL int nsessions;
336 GLOBAL char **sessions;
337
338 /*
339 * Exports from settings.c.
340 */
341 void save_settings (char *section, int do_host, Config *cfg);
342 void load_settings (char *section, int do_host, Config *cfg);
343 void get_sesslist(int allocate);
344
345 /*
346 * Exports from terminal.c.
347 */
348
349 void term_init (void);
350 void term_size (int, int, int);
351 void term_out (void);
352 void term_paint (Context, int, int, int, int);
353 void term_scroll (int, int);
354 void term_pwron (void);
355 void term_clrsb (void);
356 void term_mouse (Mouse_Button, Mouse_Action, int, int);
357 void term_deselect (void);
358 void term_update (void);
359 void term_invalidate(void);
360 void term_blink(int set_cursor);
361 void term_paste(void);
362 void term_nopaste(void);
363 int term_ldisc(int option);
364 void from_backend(int is_stderr, char *data, int len);
365 void logfopen (void);
366 void logfclose (void);
367 void term_copyall(void);
368
369 /*
370 * Exports from raw.c.
371 */
372
373 extern Backend raw_backend;
374
375 /*
376 * Exports from rlogin.c.
377 */
378
379 extern Backend rlogin_backend;
380
381 /*
382 * Exports from telnet.c.
383 */
384
385 extern Backend telnet_backend;
386
387 /*
388 * Exports from ssh.c.
389 */
390
391 extern int (*ssh_get_line)(const char *prompt, char *str, int maxlen,
392 int is_pw);
393 extern Backend ssh_backend;
394
395 /*
396 * Exports from ldisc.c.
397 */
398
399 extern void ldisc_send(char *buf, int len);
400
401 /*
402 * Exports from sshrand.c.
403 */
404
405 void random_add_noise(void *noise, int length);
406 void random_init(void);
407 int random_byte(void);
408 void random_get_savedata(void **data, int *len);
409
410 /*
411 * Exports from misc.c.
412 */
413
414 #include "puttymem.h"
415
416 /*
417 * Exports from version.c.
418 */
419 extern char ver[];
420
421 /*
422 * Exports from sizetip.c.
423 */
424 void UpdateSizeTip(HWND src, int cx, int cy);
425 void EnableSizeTip(int bEnable);
426
427 /*
428 * Exports from xlat.c.
429 */
430 unsigned char xlat_kbd2tty(unsigned char c);
431 unsigned char xlat_tty2scr(unsigned char c);
432 unsigned char xlat_latkbd2win(unsigned char c);
433
434 /*
435 * Exports from mscrypto.c
436 */
437 #ifdef MSCRYPTOAPI
438 int crypto_startup();
439 void crypto_wrapup();
440 #endif
441
442 /*
443 * Exports from pageantc.c
444 */
445 void agent_query(void *in, int inlen, void **out, int *outlen);
446 int agent_exists(void);
447
448 #ifdef DEBUG
449 void dprintf(char *fmt, ...);
450 #define debug(x) (dprintf x)
451 #else
452 #define debug(x)
453 #endif
454
455 #endif