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