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