]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - putty.h
Move MODULE files out of individual project directories into a
[PuTTY.git] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include <stdio.h>                     /* for FILENAME_MAX */
5
6 #include "network.h"
7
8 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
9 #define PUTTY_REG_PARENT "Software\\SimonTatham"
10 #define PUTTY_REG_PARENT_CHILD "PuTTY"
11 #define PUTTY_REG_GPARENT "Software"
12 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
13
14 /*
15  * Global variables. Most modules declare these `extern', but
16  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
17  * module, and so will get them properly defined.
18  */
19 #ifdef PUTTY_DO_GLOBALS
20 #define GLOBAL
21 #else
22 #define GLOBAL extern
23 #endif
24
25 /* Three attribute types: 
26  * The ATTRs (normal attributes) are stored with the characters in the main
27  * display arrays
28  *
29  * The TATTRs (temporary attributes) are generated on the fly, they can overlap
30  * with characters but not with normal attributes.
31  *
32  * The LATTRs (line attributes) conflict with no others and only have one
33  * value per line. But on area clears the LATTR cells are set to the erase_char
34  * (or DEFAULT_ATTR + 'E')
35  *
36  * ATTR_INVALID is an illegal colour combination.
37  */
38
39 #define TATTR_ACTCURS       0x4UL      /* active cursor (block) */
40 #define TATTR_PASCURS       0x2UL      /* passive cursor (box) */
41 #define TATTR_RIGHTCURS     0x1UL      /* cursor-on-RHS */
42
43 #define LATTR_NORM   0x00000000UL
44 #define LATTR_WIDE   0x01000000UL
45 #define LATTR_TOP    0x02000000UL
46 #define LATTR_BOT    0x03000000UL
47 #define LATTR_MODE   0x03000000UL
48 #define LATTR_WRAPPED 0x10000000UL
49
50 #define ATTR_INVALID 0x00FF0000UL
51
52 /* Like Linux use the F000 page for direct to font. */
53 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
54 #define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */
55
56 /* These are internal use overlapping with the UTF-16 surrogates */
57 #define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
58 #define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
59 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
60 #define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
61 #define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */
62
63 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
64 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
65
66 #define UCSERR       (ATTR_LINEDRW|'a') /* UCS Format error character. */
67 #define UCSWIDE      0x303F
68
69 #define ATTR_NARROW  0x20000000UL
70 #define ATTR_WIDE    0x10000000UL
71 #define ATTR_BOLD    0x01000000UL
72 #define ATTR_UNDER   0x02000000UL
73 #define ATTR_REVERSE 0x04000000UL
74 #define ATTR_BLINK   0x08000000UL
75 #define ATTR_FGMASK  0x000F0000UL
76 #define ATTR_BGMASK  0x00F00000UL
77 #define ATTR_COLOURS 0x00FF0000UL
78 #define ATTR_FGSHIFT 16
79 #define ATTR_BGSHIFT 20
80
81 #define ATTR_DEFAULT 0x00980000UL
82 #define ATTR_DEFFG   0x00080000UL
83 #define ATTR_DEFBG   0x00900000UL
84 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
85 #define ATTR_MASK    0xFFFFFF00UL
86 #define CHAR_MASK    0x000000FFUL
87
88 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
89 #define ATTR_CUR_XOR 0x00BA0000UL
90
91 typedef HDC Context;
92 #define SEL_NL { 13, 10 }
93
94 GLOBAL int rows, cols, savelines;
95
96 GLOBAL int has_focus;
97
98 GLOBAL int in_vbell;
99 GLOBAL unsigned long vbell_startpoint;
100
101 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
102 GLOBAL int repeat_off, cr_lf_return;
103
104 GLOBAL int seen_key_event;
105 GLOBAL int seen_disp_event;
106 GLOBAL int alt_pressed;
107
108 GLOBAL int session_closed;
109
110 GLOBAL int big_cursor;
111
112 GLOBAL char *help_path;
113 GLOBAL int help_has_contents;
114
115 GLOBAL int utf;
116 GLOBAL int dbcs_screenfont;
117 GLOBAL int font_codepage;
118 GLOBAL int kbd_codepage;
119 GLOBAL int line_codepage;
120 GLOBAL WCHAR unitab_scoacs[256];
121 GLOBAL WCHAR unitab_line[256];
122 GLOBAL WCHAR unitab_font[256];
123 GLOBAL WCHAR unitab_xterm[256];
124 GLOBAL WCHAR unitab_oemcp[256];
125 GLOBAL unsigned char unitab_ctrl[256];
126 #define in_utf (utf || line_codepage==CP_UTF8)
127
128 #define LGXF_OVR  1                    /* existing logfile overwrite */
129 #define LGXF_APN  0                    /* existing logfile append */
130 #define LGXF_ASK -1                    /* existing logfile ask */
131 #define LGTYP_NONE  0                  /* logmode: no logging */
132 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
133 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
134 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
135
136 /*
137  * Window handles for the dialog boxes that can be running during a
138  * PuTTY session.
139  */
140 GLOBAL HWND logbox;
141
142 /*
143  * I've just looked in the windows standard headr files for WM_USER, there
144  * are hundreds of flags defined using the form WM_USER+123 so I've 
145  * renumbered this NETEVENT value and the two in window.c
146  */
147 #define WM_XUSER     (WM_USER + 0x2000)
148 #define WM_NETEVENT  (WM_XUSER + 5)
149
150 typedef enum {
151     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
152     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
153     TS_EOL
154 } Telnet_Special;
155
156 typedef enum {
157     MBT_NOTHING,
158     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
159     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
160     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
161 } Mouse_Button;
162
163 typedef enum {
164     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
165 } Mouse_Action;
166
167 typedef enum {
168     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
169 } VT_Mode;
170
171 enum {
172     /*
173      * SSH ciphers (both SSH1 and SSH2)
174      */
175     CIPHER_WARN,                       /* pseudo 'cipher' */
176     CIPHER_3DES,
177     CIPHER_BLOWFISH,
178     CIPHER_AES,                        /* (SSH 2 only) */
179     CIPHER_DES,
180     CIPHER_MAX                         /* no. ciphers (inc warn) */
181 };
182
183 enum {
184     /*
185      * Line discipline option states: off, on, up to the backend.
186      */
187     LD_YES, LD_NO, LD_BACKEND
188 };
189
190 enum {
191     /*
192      * Line discipline options which the backend might try to control.
193      */
194     LD_EDIT,                           /* local line editing */
195     LD_ECHO                            /* local echo */
196 };
197
198 enum {
199     /*
200      * Close On Exit behaviours. (cfg.close_on_exit)
201      */
202     COE_NEVER,                         /* Never close the window */
203     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
204     COE_ALWAYS                         /* Always close the window */
205 };
206
207 typedef struct {
208     char *(*init) (char *host, int port, char **realhost, int nodelay);
209     /* back->send() returns the current amount of buffered data. */
210     int (*send) (char *buf, int len);
211     /* back->sendbuffer() does the same thing but without attempting a send */
212     int (*sendbuffer) (void);
213     void (*size) (void);
214     void (*special) (Telnet_Special code);
215     Socket(*socket) (void);
216     int (*exitcode) (void);
217     int (*sendok) (void);
218     int (*ldisc) (int);
219     /*
220      * back->unthrottle() tells the back end that the front end
221      * buffer is clearing.
222      */
223     void (*unthrottle) (int);
224     int default_port;
225 } Backend;
226
227 GLOBAL Backend *back;
228
229 extern struct backend_list {
230     int protocol;
231     char *name;
232     Backend *backend;
233 } backends[];
234
235 typedef struct {
236     /* Basic options */
237     char host[512];
238     int port;
239     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
240     int close_on_exit;
241     int warn_on_close;
242     int ping_interval;                 /* in seconds */
243     int tcp_nodelay;
244     /* Proxy options */
245     char proxy_exclude_list[512];
246     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
247     char proxy_host[512];
248     int proxy_port;
249     char proxy_username[32];
250     char proxy_password[32];
251     char proxy_telnet_command[512];
252     int proxy_socks_version;
253     /* SSH options */
254     char remote_cmd[512];
255     char remote_cmd2[512];             /* fallback if the first fails
256                                         * (used internally for scp) */
257     char *remote_cmd_ptr;              /* might point to a larger command
258                                         * but never for loading/saving */
259     char *remote_cmd_ptr2;             /* might point to a larger command
260                                         * but never for loading/saving */
261     int nopty;
262     int compression;
263     int agentfwd;
264     int change_username;               /* allow username switching in SSH2 */
265     int ssh_cipherlist[CIPHER_MAX];
266     char keyfile[FILENAME_MAX];
267     int sshprot;                       /* use v1 or v2 when both available */
268     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
269     int try_tis_auth;
270     int try_ki_auth;
271     int ssh_subsys;                    /* run a subsystem rather than a command */
272     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
273     /* Telnet options */
274     char termtype[32];
275     char termspeed[32];
276     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
277     char username[100];
278     char localusername[100];
279     int rfc_environ;
280     int passive_telnet;
281     /* Keyboard options */
282     int bksp_is_delete;
283     int rxvt_homeend;
284     int funky_type;
285     int no_applic_c;                   /* totally disable app cursor keys */
286     int no_applic_k;                   /* totally disable app keypad */
287     int no_mouse_rep;                  /* totally disable mouse reporting */
288     int no_remote_resize;              /* disable remote resizing */
289     int no_alt_screen;                 /* disable alternate screen */
290     int no_remote_wintitle;            /* disable remote retitling */
291     int no_dbackspace;                 /* disable destructive backspace */
292     int no_remote_charset;             /* disable remote charset config */
293     int app_cursor;
294     int app_keypad;
295     int nethack_keypad;
296     int telnet_keyboard;
297     int telnet_newline;
298     int alt_f4;                        /* is it special? */
299     int alt_space;                     /* is it special? */
300     int alt_only;                      /* is it special? */
301     int localecho;
302     int localedit;
303     int alwaysontop;
304     int fullscreenonaltenter;
305     int scroll_on_key;
306     int scroll_on_disp;
307     int compose_key;
308     int ctrlaltkeys;
309     char wintitle[256];                /* initial window title */
310     /* Terminal options */
311     int savelines;
312     int dec_om;
313     int wrap_mode;
314     int lfhascr;
315     int cursor_type;                   /* 0=block 1=underline 2=vertical */
316     int blink_cur;
317     enum {
318         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
319     } beep;
320     enum {
321         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
322     } beep_ind;
323     int bellovl;                       /* bell overload protection active? */
324     int bellovl_n;                     /* number of bells to cause overload */
325     int bellovl_t;                     /* time interval for overload (seconds) */
326     int bellovl_s;                     /* period of silence to re-enable bell (s) */
327     char bell_wavefile[FILENAME_MAX];
328     int scrollbar;
329     int scrollbar_in_fullscreen;
330     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
331     int bce;
332     int blinktext;
333     int win_name_always;
334     int width, height;
335     char font[64];
336     int fontisbold;
337     int fontheight;
338     int fontcharset;
339     char logfilename[FILENAME_MAX];
340     int logtype;
341     int logxfovr;
342     int hide_mouseptr;
343     int sunken_edge;
344     int window_border;
345     char answerback[256];
346     char printer[128];
347     /* Colour options */
348     int try_palette;
349     int bold_colour;
350     unsigned char colours[22][3];
351     /* Selection options */
352     int mouse_is_xterm;
353     int rect_select;
354     int rawcnp;
355     int rtf_paste;
356     int mouse_override;
357     short wordness[256];
358     /* translations */
359     VT_Mode vtmode;
360     char line_codepage[128];
361     int xlat_capslockcyr;
362     /* X11 forwarding */
363     int x11_forward;
364     char x11_display[128];
365     /* port forwarding */
366     int lport_acceptall; /* accept conns from hosts other than localhost */
367     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
368     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
369     /* SSH bug compatibility modes */
370     enum {
371         BUG_AUTO, BUG_OFF, BUG_ON
372     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
373         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
374         sshbug_dhgex2;
375 } Config;
376
377 /*
378  * You can compile with -DSSH_DEFAULT to have ssh by default.
379  */
380 #ifndef SSH_DEFAULT
381 #define DEFAULT_PROTOCOL PROT_TELNET
382 #define DEFAULT_PORT 23
383 #else
384 #define DEFAULT_PROTOCOL PROT_SSH
385 #define DEFAULT_PORT 22
386 #endif
387
388 /*
389  * Some global flags denoting the type of application.
390  * 
391  * FLAG_VERBOSE is set when the user requests verbose details.
392  * 
393  * FLAG_STDERR is set in command-line applications (which have a
394  * functioning stderr that it makes sense to write to) and not in
395  * GUI applications (which don't).
396  * 
397  * FLAG_INTERACTIVE is set when a full interactive shell session is
398  * being run, _either_ because no remote command has been provided
399  * _or_ because the application is GUI and can't run non-
400  * interactively.
401  */
402 #define FLAG_VERBOSE     0x0001
403 #define FLAG_STDERR      0x0002
404 #define FLAG_INTERACTIVE 0x0004
405 GLOBAL int flags;
406
407 GLOBAL Config cfg;
408 GLOBAL int default_protocol;
409 GLOBAL int default_port;
410
411 struct RSAKey;                         /* be a little careful of scope */
412
413 /*
414  * Exports from window.c.
415  */
416 void request_resize(int, int);
417 void do_text(Context, int, int, char *, int, unsigned long, int);
418 void do_cursor(Context, int, int, char *, int, unsigned long, int);
419 int CharWidth(Context ctx, int uc);
420 void set_title(char *);
421 void set_icon(char *);
422 void set_sbar(int, int, int);
423 Context get_ctx(void);
424 void free_ctx(Context);
425 void palette_set(int, int, int, int);
426 void palette_reset(void);
427 void write_aclip(char *, int, int);
428 void write_clip(wchar_t *, int, int);
429 void get_clip(wchar_t **, int *);
430 void optimised_move(int, int, int);
431 void set_raw_mouse_mode(int);
432 Mouse_Button translate_button(Mouse_Button b);
433 void connection_fatal(char *, ...);
434 void fatalbox(char *, ...);
435 void beep(int);
436 void begin_session(void);
437 void sys_cursor(int x, int y);
438 #define OPTIMISE_IS_SCROLL 1
439
440 void set_iconic(int iconic);
441 void move_window(int x, int y);
442 void set_zorder(int top);
443 void refresh_window(void);
444 void set_zoomed(int zoomed);
445 int is_iconic(void);
446 void get_window_pos(int *x, int *y);
447 void get_window_pixels(int *x, int *y);
448 char *get_window_title(int icon);
449
450 void cleanup_exit(int);
451
452 /*
453  * Exports from noise.c.
454  */
455 void noise_get_heavy(void (*func) (void *, int));
456 void noise_get_light(void (*func) (void *, int));
457 void noise_regular(void);
458 void noise_ultralight(DWORD data);
459 void random_save_seed(void);
460 void random_destroy_seed(void);
461
462 /*
463  * Exports from windlg.c.
464  */
465 void defuse_showwindow(void);
466 int do_config(void);
467 int do_reconfig(HWND);
468 void do_defaults(char *, Config *);
469 void logevent(char *);
470 void showeventlog(HWND);
471 void showabout(HWND);
472 void verify_ssh_host_key(char *host, int port, char *keytype,
473                          char *keystr, char *fingerprint);
474 void askcipher(char *ciphername, int cs);
475 int askappend(char *filename);
476 void registry_cleanup(void);
477 void force_normal(HWND hwnd);
478
479 GLOBAL int nsessions;
480 GLOBAL char **sessions;
481
482 /*
483  * Exports from settings.c.
484  */
485 void save_settings(char *section, int do_host, Config * cfg);
486 void load_settings(char *section, int do_host, Config * cfg);
487 void get_sesslist(int allocate);
488
489 /*
490  * Exports from terminal.c.
491  */
492
493 void term_init(void);
494 void term_size(int, int, int);
495 void term_out(void);
496 void term_paint(Context, int, int, int, int);
497 void term_scroll(int, int);
498 void term_pwron(void);
499 void term_clrsb(void);
500 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
501 void term_deselect(void);
502 void term_update(void);
503 void term_invalidate(void);
504 void term_blink(int set_cursor);
505 void term_do_paste(void);
506 void term_paste(void);
507 void term_nopaste(void);
508 int term_ldisc(int option);
509 int from_backend(int is_stderr, char *data, int len);
510 void logfopen(void);
511 void logfclose(void);
512 void term_copyall(void);
513 void term_reconfig(void);
514
515 /*
516  * Exports from logging.c.
517  */
518 void logtraffic(unsigned char c, int logmode);
519 enum { PKT_INCOMING, PKT_OUTGOING };
520 void log_eventlog(char *string);
521 void log_packet(int direction, int type, char *texttype, void *data, int len);
522
523 /*
524  * Exports from raw.c.
525  */
526
527 extern Backend raw_backend;
528
529 /*
530  * Exports from rlogin.c.
531  */
532
533 extern Backend rlogin_backend;
534
535 /*
536  * Exports from telnet.c.
537  */
538
539 extern Backend telnet_backend;
540
541 /*
542  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
543  * so that PuTTYtel will still compile - otherwise it would depend
544  * on ssh.c.)
545  */
546
547 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
548                             int is_pw);
549 GLOBAL int ssh_getline_pw_only;
550 extern Backend ssh_backend;
551
552 /*
553  * Exports from ldisc.c.
554  */
555
556 extern void ldisc_send(char *buf, int len, int interactive);
557
558 /*
559  * Exports from sshrand.c.
560  */
561
562 void random_add_noise(void *noise, int length);
563 void random_init(void);
564 int random_byte(void);
565 void random_get_savedata(void **data, int *len);
566 extern int random_active;
567
568 /*
569  * Exports from misc.c.
570  */
571
572 #include "misc.h"
573
574 /*
575  * Exports from version.c.
576  */
577 extern char ver[];
578
579 /*
580  * Exports from sizetip.c.
581  */
582 void UpdateSizeTip(HWND src, int cx, int cy);
583 void EnableSizeTip(int bEnable);
584
585 /*
586  * Exports from unicode.c.
587  */
588 #ifndef CP_UTF8
589 #define CP_UTF8 65001
590 #endif
591 void init_ucs_tables(void);
592 void lpage_send(int codepage, char *buf, int len, int interactive);
593 void luni_send(wchar_t * widebuf, int len, int interactive);
594 wchar_t xlat_uskbd2cyrllic(int ch);
595 int check_compose(int first, int second);
596 int decode_codepage(char *cp_name);
597 char *cp_enumerate (int index);
598 char *cp_name(int codepage);
599 void get_unitab(int codepage, wchar_t * unitab, int ftype);
600
601 /*
602  * Exports from mscrypto.c
603  */
604 #ifdef MSCRYPTOAPI
605 int crypto_startup();
606 void crypto_wrapup();
607 #endif
608
609 /*
610  * Exports from pageantc.c
611  */
612 void agent_query(void *in, int inlen, void **out, int *outlen);
613 int agent_exists(void);
614
615 /*
616  * Exports from wildcard.c
617  */
618 const char *wc_error(int value);
619 int wc_match(const char *wildcard, const char *target);
620 int wc_unescape(char *output, const char *wildcard);
621
622 /*
623  * Exports from console.c (that aren't equivalents to things in
624  * windlg.c).
625  */
626 extern int console_batch_mode;
627 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
628
629 /*
630  * Exports from printing.c.
631  */
632 typedef struct printer_enum_tag printer_enum;
633 typedef struct printer_job_tag printer_job;
634 printer_enum *printer_start_enum(int *nprinters);
635 char *printer_get_name(printer_enum *, int);
636 void printer_finish_enum(printer_enum *);
637 printer_job *printer_start_job(char *printer);
638 void printer_job_data(printer_job *, void *, int);
639 void printer_finish_job(printer_job *);
640
641 /*
642  * Exports from cmdline.c (and also cmdline_error(), which is
643  * defined differently in various places and required _by_
644  * cmdline.c).
645  */
646 int cmdline_process_param(char *, char *, int);
647 void cmdline_run_saved(void);
648 extern char *cmdline_password;
649 #define TOOLTYPE_FILETRANSFER 1
650 extern int cmdline_tooltype;
651
652 void cmdline_error(char *, ...);
653
654 #endif