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