]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - putty.h
Line discipline module now uses dynamically allocated data. Also
[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     void (*provide_ldisc) (void *handle, void *ldisc);
204     /*
205      * back->unthrottle() tells the back end that the front end
206      * buffer is clearing.
207      */
208     void (*unthrottle) (void *handle, int);
209     int default_port;
210 };
211
212 GLOBAL Backend *back;
213 GLOBAL void *backhandle;
214
215 extern struct backend_list {
216     int protocol;
217     char *name;
218     Backend *backend;
219 } backends[];
220
221 struct config_tag {
222     /* Basic options */
223     char host[512];
224     int port;
225     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
226     int close_on_exit;
227     int warn_on_close;
228     int ping_interval;                 /* in seconds */
229     int tcp_nodelay;
230     /* Proxy options */
231     char proxy_exclude_list[512];
232     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
233     char proxy_host[512];
234     int proxy_port;
235     char proxy_username[32];
236     char proxy_password[32];
237     char proxy_telnet_command[512];
238     int proxy_socks_version;
239     /* SSH options */
240     char remote_cmd[512];
241     char remote_cmd2[512];             /* fallback if the first fails
242                                         * (used internally for scp) */
243     char *remote_cmd_ptr;              /* might point to a larger command
244                                         * but never for loading/saving */
245     char *remote_cmd_ptr2;             /* might point to a larger command
246                                         * but never for loading/saving */
247     int nopty;
248     int compression;
249     int agentfwd;
250     int change_username;               /* allow username switching in SSH2 */
251     int ssh_cipherlist[CIPHER_MAX];
252     char keyfile[FILENAME_MAX];
253     int sshprot;                       /* use v1 or v2 when both available */
254     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
255     int try_tis_auth;
256     int try_ki_auth;
257     int ssh_subsys;                    /* run a subsystem rather than a command */
258     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
259     /* Telnet options */
260     char termtype[32];
261     char termspeed[32];
262     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
263     char username[100];
264     char localusername[100];
265     int rfc_environ;
266     int passive_telnet;
267     /* Keyboard options */
268     int bksp_is_delete;
269     int rxvt_homeend;
270     int funky_type;
271     int no_applic_c;                   /* totally disable app cursor keys */
272     int no_applic_k;                   /* totally disable app keypad */
273     int no_mouse_rep;                  /* totally disable mouse reporting */
274     int no_remote_resize;              /* disable remote resizing */
275     int no_alt_screen;                 /* disable alternate screen */
276     int no_remote_wintitle;            /* disable remote retitling */
277     int no_dbackspace;                 /* disable destructive backspace */
278     int no_remote_charset;             /* disable remote charset config */
279     int app_cursor;
280     int app_keypad;
281     int nethack_keypad;
282     int telnet_keyboard;
283     int telnet_newline;
284     int alt_f4;                        /* is it special? */
285     int alt_space;                     /* is it special? */
286     int alt_only;                      /* is it special? */
287     int localecho;
288     int localedit;
289     int alwaysontop;
290     int fullscreenonaltenter;
291     int scroll_on_key;
292     int scroll_on_disp;
293     int compose_key;
294     int ctrlaltkeys;
295     char wintitle[256];                /* initial window title */
296     /* Terminal options */
297     int savelines;
298     int dec_om;
299     int wrap_mode;
300     int lfhascr;
301     int cursor_type;                   /* 0=block 1=underline 2=vertical */
302     int blink_cur;
303     enum {
304         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
305     } beep;
306     enum {
307         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
308     } beep_ind;
309     int bellovl;                       /* bell overload protection active? */
310     int bellovl_n;                     /* number of bells to cause overload */
311     int bellovl_t;                     /* time interval for overload (seconds) */
312     int bellovl_s;                     /* period of silence to re-enable bell (s) */
313     char bell_wavefile[FILENAME_MAX];
314     int scrollbar;
315     int scrollbar_in_fullscreen;
316     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
317     int bce;
318     int blinktext;
319     int win_name_always;
320     int width, height;
321     char font[64];
322     int fontisbold;
323     int fontheight;
324     int fontcharset;
325     char logfilename[FILENAME_MAX];
326     int logtype;
327     int logxfovr;
328     int hide_mouseptr;
329     int sunken_edge;
330     int window_border;
331     char answerback[256];
332     char printer[128];
333     /* Colour options */
334     int try_palette;
335     int bold_colour;
336     unsigned char colours[22][3];
337     /* Selection options */
338     int mouse_is_xterm;
339     int rect_select;
340     int rawcnp;
341     int rtf_paste;
342     int mouse_override;
343     short wordness[256];
344     /* translations */
345     VT_Mode vtmode;
346     char line_codepage[128];
347     int xlat_capslockcyr;
348     /* X11 forwarding */
349     int x11_forward;
350     char x11_display[128];
351     /* port forwarding */
352     int lport_acceptall; /* accept conns from hosts other than localhost */
353     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
354     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
355     /* SSH bug compatibility modes */
356     enum {
357         BUG_AUTO, BUG_OFF, BUG_ON
358     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
359         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
360         sshbug_dhgex2;
361     /* Options for pterm. Should split out into platform-dependent part. */
362     int stamp_utmp;
363     int login_shell;
364     int scrollbar_on_left;
365     char boldfont[64];
366     int shadowboldoffset;
367 };
368
369 /*
370  * You can compile with -DSSH_DEFAULT to have ssh by default.
371  */
372 #ifndef SSH_DEFAULT
373 #define DEFAULT_PROTOCOL PROT_TELNET
374 #define DEFAULT_PORT 23
375 #else
376 #define DEFAULT_PROTOCOL PROT_SSH
377 #define DEFAULT_PORT 22
378 #endif
379
380 /*
381  * Some global flags denoting the type of application.
382  * 
383  * FLAG_VERBOSE is set when the user requests verbose details.
384  * 
385  * FLAG_STDERR is set in command-line applications (which have a
386  * functioning stderr that it makes sense to write to) and not in
387  * GUI applications (which don't).
388  * 
389  * FLAG_INTERACTIVE is set when a full interactive shell session is
390  * being run, _either_ because no remote command has been provided
391  * _or_ because the application is GUI and can't run non-
392  * interactively.
393  */
394 #define FLAG_VERBOSE     0x0001
395 #define FLAG_STDERR      0x0002
396 #define FLAG_INTERACTIVE 0x0004
397 GLOBAL int flags;
398
399 GLOBAL Config cfg;
400 GLOBAL int default_protocol;
401 GLOBAL int default_port;
402
403 GLOBAL Terminal *term;                 /* temporary while changes are made */
404
405 struct RSAKey;                         /* be a little careful of scope */
406
407 /*
408  * Exports from window.c.
409  */
410 void request_resize(int, int);
411 void do_text(Context, int, int, char *, int, unsigned long, int);
412 void do_cursor(Context, int, int, char *, int, unsigned long, int);
413 int CharWidth(Context ctx, int uc);
414 void set_title(char *);
415 void set_icon(char *);
416 void set_sbar(int, int, int);
417 Context get_ctx(void);
418 void free_ctx(Context);
419 void palette_set(int, int, int, int);
420 void palette_reset(void);
421 void write_aclip(char *, int, int);
422 void write_clip(wchar_t *, int, int);
423 void get_clip(wchar_t **, int *);
424 void optimised_move(int, int, int);
425 void set_raw_mouse_mode(int);
426 Mouse_Button translate_button(Mouse_Button b);
427 void connection_fatal(char *, ...);
428 void fatalbox(char *, ...);
429 void modalfatalbox(char *, ...);
430 void beep(int);
431 void begin_session(void);
432 void sys_cursor(int x, int y);
433 void request_paste(void);
434 void frontend_keypress(void *frontend);
435 void ldisc_update(void *frontend, int echo, int edit);
436 #define OPTIMISE_IS_SCROLL 1
437
438 void set_iconic(int iconic);
439 void move_window(int x, int y);
440 void set_zorder(int top);
441 void refresh_window(void);
442 void set_zoomed(int zoomed);
443 int is_iconic(void);
444 void get_window_pos(int *x, int *y);
445 void get_window_pixels(int *x, int *y);
446 char *get_window_title(int icon);
447
448 void cleanup_exit(int);
449
450 /*
451  * Exports from noise.c.
452  */
453 void noise_get_heavy(void (*func) (void *, int));
454 void noise_get_light(void (*func) (void *, int));
455 void noise_regular(void);
456 void noise_ultralight(unsigned long data);
457 void random_save_seed(void);
458 void random_destroy_seed(void);
459
460 /*
461  * Exports from settings.c.
462  */
463 void save_settings(char *section, int do_host, Config * cfg);
464 void load_settings(char *section, int do_host, Config * cfg);
465 void get_sesslist(int allocate);
466 void do_defaults(char *, Config *);
467 void registry_cleanup(void);
468
469 /*
470  * Exports from terminal.c.
471  */
472
473 Terminal *term_init(void);
474 void term_size(Terminal *, int, int, int);
475 void term_out(Terminal *);
476 void term_paint(Terminal *, Context, int, int, int, int);
477 void term_scroll(Terminal *, int, int);
478 void term_pwron(Terminal *);
479 void term_clrsb(Terminal *);
480 void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
481 void term_deselect(Terminal *);
482 void term_update(Terminal *);
483 void term_invalidate(Terminal *);
484 void term_blink(Terminal *, int set_cursor);
485 void term_do_paste(Terminal *);
486 int term_paste_pending(Terminal *);
487 void term_paste(Terminal *);
488 void term_nopaste(Terminal *);
489 int term_ldisc(Terminal *, int option);
490 void term_copyall(Terminal *);
491 void term_reconfig(Terminal *);
492 void term_seen_key_event(Terminal *); 
493 int from_backend(void *, int is_stderr, char *data, int len);
494 void term_provide_resize_fn(Terminal *term,
495                             void (*resize_fn)(void *, int, int),
496                             void *resize_ctx);
497
498 /*
499  * Exports from logging.c.
500  */
501 void logfopen();
502 void logfclose();
503 void logtraffic(unsigned char c, int logmode);
504 enum { PKT_INCOMING, PKT_OUTGOING };
505 void log_eventlog(char *string);
506 void log_packet(int direction, int type, char *texttype, void *data, int len);
507
508 /*
509  * Exports from raw.c.
510  */
511
512 extern Backend raw_backend;
513
514 /*
515  * Exports from rlogin.c.
516  */
517
518 extern Backend rlogin_backend;
519
520 /*
521  * Exports from telnet.c.
522  */
523
524 extern Backend telnet_backend;
525
526 /*
527  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
528  * so that PuTTYtel will still compile - otherwise it would depend
529  * on ssh.c.)
530  */
531
532 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
533                             int is_pw);
534 GLOBAL int ssh_getline_pw_only;
535 extern Backend ssh_backend;
536
537 /*
538  * Exports from ldisc.c.
539  */
540
541 void *ldisc_create(Terminal *, Backend *, void *, void *);
542 void ldisc_send(void *handle, char *buf, int len, int interactive);
543
544 /*
545  * Exports from sshrand.c.
546  */
547
548 void random_add_noise(void *noise, int length);
549 void random_init(void);
550 int random_byte(void);
551 void random_get_savedata(void **data, int *len);
552 extern int random_active;
553
554 /*
555  * Exports from misc.c.
556  */
557
558 #include "misc.h"
559
560 /*
561  * Exports from version.c.
562  */
563 extern char ver[];
564
565 /*
566  * Exports from unicode.c.
567  */
568 #ifndef CP_UTF8
569 #define CP_UTF8 65001
570 #endif
571 void init_ucs_tables(void);
572 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
573 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
574 wchar_t xlat_uskbd2cyrllic(int ch);
575 int check_compose(int first, int second);
576 int decode_codepage(char *cp_name);
577 char *cp_enumerate (int index);
578 char *cp_name(int codepage);
579 void get_unitab(int codepage, wchar_t * unitab, int ftype);
580
581 /*
582  * Exports from mscrypto.c
583  */
584 #ifdef MSCRYPTOAPI
585 int crypto_startup();
586 void crypto_wrapup();
587 #endif
588
589 /*
590  * Exports from pageantc.c
591  */
592 void agent_query(void *in, int inlen, void **out, int *outlen);
593 int agent_exists(void);
594
595 /*
596  * Exports from wildcard.c
597  */
598 const char *wc_error(int value);
599 int wc_match(const char *wildcard, const char *target);
600 int wc_unescape(char *output, const char *wildcard);
601
602 /*
603  * Exports from windlg.c
604  */
605 void logevent(char *);
606 void verify_ssh_host_key(char *host, int port, char *keytype,
607                          char *keystr, char *fingerprint);
608 void askcipher(char *ciphername, int cs);
609 int askappend(char *filename);
610
611 /*
612  * Exports from console.c (that aren't equivalents to things in
613  * windlg.c).
614  */
615 extern int console_batch_mode;
616 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
617
618 /*
619  * Exports from printing.c.
620  */
621 typedef struct printer_enum_tag printer_enum;
622 typedef struct printer_job_tag printer_job;
623 printer_enum *printer_start_enum(int *nprinters);
624 char *printer_get_name(printer_enum *, int);
625 void printer_finish_enum(printer_enum *);
626 printer_job *printer_start_job(char *printer);
627 void printer_job_data(printer_job *, void *, int);
628 void printer_finish_job(printer_job *);
629
630 /*
631  * Exports from cmdline.c (and also cmdline_error(), which is
632  * defined differently in various places and required _by_
633  * cmdline.c).
634  */
635 int cmdline_process_param(char *, char *, int);
636 void cmdline_run_saved(void);
637 extern char *cmdline_password;
638 #define TOOLTYPE_FILETRANSFER 1
639 extern int cmdline_tooltype;
640
641 void cmdline_error(char *, ...);
642
643 #endif