]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - putty.h
First attempt at a platform-independent keyboard handler. This isn't complete
[PuTTY.git] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include <stdio.h>                     /* for FILENAME_MAX */
5 #include <stddef.h>                    /* for wchar_t */
6
7 /*
8  * Global variables. Most modules declare these `extern', but
9  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
10  * module, and so will get them properly defined.
11  */
12 #ifndef GLOBAL
13 #ifdef PUTTY_DO_GLOBALS
14 #define GLOBAL
15 #else
16 #define GLOBAL extern
17 #endif
18 #endif
19
20 #ifndef DONE_TYPEDEFS
21 #define DONE_TYPEDEFS
22 typedef struct config_tag Config;
23 typedef struct backend_tag Backend;
24 typedef struct terminal_tag Terminal;
25 #endif
26
27 #include "puttyps.h"
28 #include "network.h"
29
30 /* Three attribute types: 
31  * The ATTRs (normal attributes) are stored with the characters in the main
32  * display arrays
33  *
34  * The TATTRs (temporary attributes) are generated on the fly, they can overlap
35  * with characters but not with normal attributes.
36  *
37  * The LATTRs (line attributes) conflict with no others and only have one
38  * value per line. But on area clears the LATTR cells are set to the erase_char
39  * (or DEFAULT_ATTR + 'E')
40  *
41  * ATTR_INVALID is an illegal colour combination.
42  */
43
44 #define TATTR_ACTCURS       0x4UL      /* active cursor (block) */
45 #define TATTR_PASCURS       0x2UL      /* passive cursor (box) */
46 #define TATTR_RIGHTCURS     0x1UL      /* cursor-on-RHS */
47
48 #define LATTR_NORM   0x00000000UL
49 #define LATTR_WIDE   0x01000000UL
50 #define LATTR_TOP    0x02000000UL
51 #define LATTR_BOT    0x03000000UL
52 #define LATTR_MODE   0x03000000UL
53 #define LATTR_WRAPPED 0x10000000UL
54 #define LATTR_WRAPPED2 0x20000000UL
55
56 #define ATTR_INVALID 0x00FF0000UL
57
58 /* Like Linux use the F000 page for direct to font. */
59 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
60 #define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */
61
62 /* These are internal use overlapping with the UTF-16 surrogates */
63 #define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
64 #define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
65 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
66 #define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
67 #define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */
68
69 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
70 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
71
72 #define UCSERR       (ATTR_LINEDRW|'a') /* UCS Format error character. */
73 /*
74  * UCSWIDE is a special value used in the terminal data to signify
75  * the character cell containing the right-hand half of a CJK wide
76  * character. We use 0xDFFF because it's part of the surrogate
77  * range and hence won't be used for anything else (it's impossible
78  * to input it via UTF-8 because our UTF-8 decoder correctly
79  * rejects surrogates).
80  */
81 #define UCSWIDE      0xDFFF
82
83 #define ATTR_NARROW  0x20000000UL
84 #define ATTR_WIDE    0x10000000UL
85 #define ATTR_BOLD    0x01000000UL
86 #define ATTR_UNDER   0x02000000UL
87 #define ATTR_REVERSE 0x04000000UL
88 #define ATTR_BLINK   0x08000000UL
89 #define ATTR_FGMASK  0x000F0000UL
90 #define ATTR_BGMASK  0x00F00000UL
91 #define ATTR_COLOURS 0x00FF0000UL
92 #define ATTR_FGSHIFT 16
93 #define ATTR_BGSHIFT 20
94
95 #define ATTR_DEFAULT 0x00980000UL
96 #define ATTR_DEFFG   0x00080000UL
97 #define ATTR_DEFBG   0x00900000UL
98 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
99 #define ATTR_MASK    0xFFFFFF00UL
100 #define CHAR_MASK    0x000000FFUL
101
102 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
103 #define ATTR_CUR_XOR 0x00BA0000UL
104
105 struct sesslist {
106     int nsessions;
107     char **sessions;
108     char *buffer;                      /* so memory can be freed later */
109 };
110
111 struct unicode_data {
112     char **uni_tbl;
113     int dbcs_screenfont;
114     int font_codepage;
115     int line_codepage;
116     wchar_t unitab_scoacs[256];
117     wchar_t unitab_line[256];
118     wchar_t unitab_font[256];
119     wchar_t unitab_xterm[256];
120     wchar_t unitab_oemcp[256];
121     unsigned char unitab_ctrl[256];
122 };
123
124 #define LGXF_OVR  1                    /* existing logfile overwrite */
125 #define LGXF_APN  0                    /* existing logfile append */
126 #define LGXF_ASK -1                    /* existing logfile ask */
127 #define LGTYP_NONE  0                  /* logmode: no logging */
128 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
129 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
130 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
131
132 typedef enum {
133     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
134     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
135     TS_EOL
136 } Telnet_Special;
137
138 typedef enum {
139     MBT_NOTHING,
140     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
141     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
142     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
143 } Mouse_Button;
144
145 typedef enum {
146     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
147 } Mouse_Action;
148
149 /* Keyboard modifiers -- keys the user is actually holding down */
150
151 #define PKM_SHIFT       0x01
152 #define PKM_CONTROL     0x02
153 #define PKM_META        0x04
154 #define PKM_ALT         0x08
155
156 /* Keyboard flags that aren't really modifiers */
157 #define PKF_CAPSLOCK    0x10
158 #define PKF_NUMLOCK     0x20
159 #define PKF_REPEAT      0x40
160
161 /* Stand-alone keysyms for function keys */
162
163 typedef enum {
164     PK_NULL,            /* No symbol for this key */
165     /* Main keypad keys */
166     PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
167     /* Editing keys */
168     PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
169     /* Cursor keys */
170     PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
171     /* Numeric keypad */                        /* Real one looks like: */
172     PK_PF1, PK_PF2, PK_PF3, PK_PF4,             /* PF1 PF2 PF3 PF4 */
173     PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL,       /*  7   8   9   -  */
174     PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4,     /*  4   5   6   ,  */
175     PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9,     /*  1   2   3  en- */
176     PK_KPBIGPLUS, PK_KPENTER,                   /*    0     .  ter */
177     /* Top row */
178     PK_F1,  PK_F2,  PK_F3,  PK_F4,  PK_F5,
179     PK_F6,  PK_F7,  PK_F8,  PK_F9,  PK_F10,
180     PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
181     PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
182     PK_PAUSE
183 } Key_Sym;
184
185 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
186 #define PK_ISCURSOR(k)  ((k) >= PK_UP && (k) <= PK_REST)
187 #define PK_ISKEYPAD(k)  ((k) >= PK_PF1 && (k) <= PK_KPENTER)
188 #define PK_ISFKEY(k)    ((k) >= PK_F1 && (k) <= PK_F20)
189
190 typedef enum {
191     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
192 } VT_Mode;
193
194 enum {
195     /*
196      * SSH ciphers (both SSH1 and SSH2)
197      */
198     CIPHER_WARN,                       /* pseudo 'cipher' */
199     CIPHER_3DES,
200     CIPHER_BLOWFISH,
201     CIPHER_AES,                        /* (SSH 2 only) */
202     CIPHER_DES,
203     CIPHER_MAX                         /* no. ciphers (inc warn) */
204 };
205
206 enum {
207     /*
208      * Line discipline option states: off, on, up to the backend.
209      */
210     LD_YES, LD_NO, LD_BACKEND
211 };
212
213 enum {
214     /*
215      * Line discipline options which the backend might try to control.
216      */
217     LD_EDIT,                           /* local line editing */
218     LD_ECHO                            /* local echo */
219 };
220
221 enum {
222     /*
223      * Close On Exit behaviours. (cfg.close_on_exit)
224      */
225     COE_NEVER,                         /* Never close the window */
226     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
227     COE_ALWAYS                         /* Always close the window */
228 };
229
230 enum {
231     /* Function key types (cfg.funky_type) */
232     FUNKY_TILDE,
233     FUNKY_LINUX,
234     FUNKY_XTERM,
235     FUNKY_VT400,
236     FUNKY_VT100P,
237     FUNKY_SCO
238 };
239
240 struct backend_tag {
241     char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg,
242                    char *host, int port, char **realhost, int nodelay);
243     void (*free) (void *handle);
244     /* back->reconfig() passes in a replacement configuration. */
245     void (*reconfig) (void *handle, Config *cfg);
246     /* back->send() returns the current amount of buffered data. */
247     int (*send) (void *handle, char *buf, int len);
248     /* back->sendbuffer() does the same thing but without attempting a send */
249     int (*sendbuffer) (void *handle);
250     void (*size) (void *handle, int width, int height);
251     void (*special) (void *handle, Telnet_Special code);
252     Socket(*socket) (void *handle);
253     int (*exitcode) (void *handle);
254     int (*sendok) (void *handle);
255     int (*ldisc) (void *handle, int);
256     void (*provide_ldisc) (void *handle, void *ldisc);
257     void (*provide_logctx) (void *handle, void *logctx);
258     /*
259      * back->unthrottle() tells the back end that the front end
260      * buffer is clearing.
261      */
262     void (*unthrottle) (void *handle, int);
263     int default_port;
264 };
265
266 extern struct backend_list {
267     int protocol;
268     char *name;
269     Backend *backend;
270 } backends[];
271
272 /*
273  * Suggested default protocol provided by the backend link module.
274  * The application is free to ignore this.
275  */
276 extern const int be_default_protocol;
277
278 struct config_tag {
279     /* Basic options */
280     char host[512];
281     int port;
282     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
283     int close_on_exit;
284     int warn_on_close;
285     int ping_interval;                 /* in seconds */
286     int tcp_nodelay;
287     /* Proxy options */
288     char proxy_exclude_list[512];
289     enum { PROXYDNS_NO, PROXYDNS_AUTO, PROXYDNS_YES } proxy_dns;
290     int even_proxy_localhost;
291     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
292     char proxy_host[512];
293     int proxy_port;
294     char proxy_username[32];
295     char proxy_password[32];
296     char proxy_telnet_command[512];
297     int proxy_socks_version;
298     /* SSH options */
299     char remote_cmd[512];
300     char remote_cmd2[512];             /* fallback if the first fails
301                                         * (used internally for scp) */
302     char *remote_cmd_ptr;              /* might point to a larger command
303                                         * but never for loading/saving */
304     char *remote_cmd_ptr2;             /* might point to a larger command
305                                         * but never for loading/saving */
306     int nopty;
307     int compression;
308     int agentfwd;
309     int change_username;               /* allow username switching in SSH2 */
310     int ssh_cipherlist[CIPHER_MAX];
311     char keyfile[FILENAME_MAX];
312     int sshprot;                       /* use v1 or v2 when both available */
313     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
314     int try_tis_auth;
315     int try_ki_auth;
316     int ssh_subsys;                    /* run a subsystem rather than a command */
317     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
318     /* Telnet options */
319     char termtype[32];
320     char termspeed[32];
321     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
322     char username[100];
323     char localusername[100];
324     int rfc_environ;
325     int passive_telnet;
326     /* Keyboard options */
327     int bksp_is_delete;
328     int rxvt_homeend;
329     int funky_type;
330     int no_applic_c;                   /* totally disable app cursor keys */
331     int no_applic_k;                   /* totally disable app keypad */
332     int no_mouse_rep;                  /* totally disable mouse reporting */
333     int no_remote_resize;              /* disable remote resizing */
334     int no_alt_screen;                 /* disable alternate screen */
335     int no_remote_wintitle;            /* disable remote retitling */
336     int no_dbackspace;                 /* disable destructive backspace */
337     int no_remote_charset;             /* disable remote charset config */
338     int app_cursor;
339     int app_keypad;
340     int nethack_keypad;
341     int telnet_keyboard;
342     int telnet_newline;
343     int alt_f4;                        /* is it special? */
344     int alt_space;                     /* is it special? */
345     int alt_only;                      /* is it special? */
346     int localecho;
347     int localedit;
348     int alwaysontop;
349     int fullscreenonaltenter;
350     int scroll_on_key;
351     int scroll_on_disp;
352     int compose_key;
353     int ctrlaltkeys;
354     char wintitle[256];                /* initial window title */
355     /* Terminal options */
356     int savelines;
357     int dec_om;
358     int wrap_mode;
359     int lfhascr;
360     int cursor_type;                   /* 0=block 1=underline 2=vertical */
361     int blink_cur;
362     enum {
363         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
364     } beep;
365     enum {
366         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
367     } beep_ind;
368     int bellovl;                       /* bell overload protection active? */
369     int bellovl_n;                     /* number of bells to cause overload */
370     int bellovl_t;                     /* time interval for overload (seconds) */
371     int bellovl_s;                     /* period of silence to re-enable bell (s) */
372     char bell_wavefile[FILENAME_MAX];
373     int scrollbar;
374     int scrollbar_in_fullscreen;
375     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
376     int bce;
377     int blinktext;
378     int win_name_always;
379     int width, height;
380     char font[256];
381     int fontisbold;
382     int fontheight;
383     int fontcharset;
384     char logfilename[FILENAME_MAX];
385     int logtype;
386     int logxfovr;
387     int hide_mouseptr;
388     int sunken_edge;
389     int window_border;
390     char answerback[256];
391     char printer[128];
392     /* Colour options */
393     int try_palette;
394     int bold_colour;
395     unsigned char colours[22][3];
396     /* Selection options */
397     int mouse_is_xterm;
398     int rect_select;
399     int rawcnp;
400     int rtf_paste;
401     int mouse_override;
402     short wordness[256];
403     /* translations */
404     VT_Mode vtmode;
405     char line_codepage[128];
406     int xlat_capslockcyr;
407     /* X11 forwarding */
408     int x11_forward;
409     char x11_display[128];
410     int x11_auth;
411     /* port forwarding */
412     int lport_acceptall; /* accept conns from hosts other than localhost */
413     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
414     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
415     /* SSH bug compatibility modes */
416     enum {
417         BUG_AUTO, BUG_OFF, BUG_ON
418     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
419         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
420         sshbug_dhgex2;
421     /* Options for pterm. Should split out into platform-dependent part. */
422     int stamp_utmp;
423     int login_shell;
424     int scrollbar_on_left;
425     char boldfont[256];
426     char widefont[256];
427     char wideboldfont[256];
428     int shadowboldoffset;
429 };
430
431 /*
432  * Some global flags denoting the type of application.
433  * 
434  * FLAG_VERBOSE is set when the user requests verbose details.
435  * 
436  * FLAG_STDERR is set in command-line applications (which have a
437  * functioning stderr that it makes sense to write to) and not in
438  * GUI applications (which don't).
439  * 
440  * FLAG_INTERACTIVE is set when a full interactive shell session is
441  * being run, _either_ because no remote command has been provided
442  * _or_ because the application is GUI and can't run non-
443  * interactively.
444  * 
445  * These flags describe the type of _application_ - they wouldn't
446  * vary between individual sessions - and so it's OK to have this
447  * variable be GLOBAL.
448  */
449 #define FLAG_VERBOSE     0x0001
450 #define FLAG_STDERR      0x0002
451 #define FLAG_INTERACTIVE 0x0004
452 GLOBAL int flags;
453
454 /*
455  * Likewise, these two variables are set up when the application
456  * initialises, and inform all default-settings accesses after
457  * that.
458  */
459 GLOBAL int default_protocol;
460 GLOBAL int default_port;
461
462 struct RSAKey;                         /* be a little careful of scope */
463
464 /*
465  * Exports from window.c.
466  */
467 void request_resize(void *frontend, int, int);
468 void do_text(Context, int, int, char *, int, unsigned long, int);
469 void do_cursor(Context, int, int, char *, int, unsigned long, int);
470 int char_width(Context ctx, int uc);
471 #ifdef OPTIMISE_SCROLL
472 void do_scroll(void *, int, int, int);
473 #endif
474 void set_title(void *frontend, char *);
475 void set_icon(void *frontend, char *);
476 void set_sbar(void *frontend, int, int, int);
477 Context get_ctx(void *frontend);
478 void free_ctx(Context);
479 void palette_set(void *frontend, int, int, int, int);
480 void palette_reset(void *frontend);
481 void write_aclip(void *frontend, char *, int, int);
482 void write_clip(void *frontend, wchar_t *, int, int);
483 void get_clip(void *frontend, wchar_t **, int *);
484 void optimised_move(void *frontend, int, int, int);
485 void set_raw_mouse_mode(void *frontend, int);
486 void connection_fatal(void *frontend, char *, ...);
487 void fatalbox(char *, ...);
488 void modalfatalbox(char *, ...);
489 #ifdef macintosh
490 #pragma noreturn(fatalbox)
491 #pragma noreturn(modalfatalbox)
492 #endif
493 void beep(void *frontend, int);
494 void begin_session(void *frontend);
495 void sys_cursor(void *frontend, int x, int y);
496 void request_paste(void *frontend);
497 void frontend_keypress(void *frontend);
498 void ldisc_update(void *frontend, int echo, int edit);
499 #define OPTIMISE_IS_SCROLL 1
500
501 void set_iconic(void *frontend, int iconic);
502 void move_window(void *frontend, int x, int y);
503 void set_zorder(void *frontend, int top);
504 void refresh_window(void *frontend);
505 void set_zoomed(void *frontend, int zoomed);
506 int is_iconic(void *frontend);
507 void get_window_pos(void *frontend, int *x, int *y);
508 void get_window_pixels(void *frontend, int *x, int *y);
509 char *get_window_title(void *frontend, int icon);
510
511 void cleanup_exit(int);
512
513 /*
514  * Exports from noise.c.
515  */
516 void noise_get_heavy(void (*func) (void *, int));
517 void noise_get_light(void (*func) (void *, int));
518 void noise_regular(void);
519 void noise_ultralight(unsigned long data);
520 void random_save_seed(void);
521 void random_destroy_seed(void);
522
523 /*
524  * Exports from settings.c.
525  */
526 void save_settings(char *section, int do_host, Config * cfg);
527 void save_open_settings(void *sesskey, int do_host, Config *cfg);
528 void load_settings(char *section, int do_host, Config * cfg);
529 void load_open_settings(void *sesskey, int do_host, Config *cfg);
530 void get_sesslist(struct sesslist *, int allocate);
531 void do_defaults(char *, Config *);
532 void registry_cleanup(void);
533
534 /*
535  * Functions used by settings.c to provide platform-specific
536  * default settings.
537  * 
538  * (The integer one is expected to return `def' if it has no clear
539  * opinion of its own. This is because there's no integer value
540  * which I can reliably set aside to indicate `nil'. The string
541  * function is perfectly all right returning NULL, of course.)
542  */
543 char *platform_default_s(const char *name);
544 int platform_default_i(const char *name, int def);
545
546 /*
547  * Exports from terminal.c.
548  */
549
550 Terminal *term_init(Config *, struct unicode_data *, void *);
551 void term_free(Terminal *);
552 void term_size(Terminal *, int, int, int);
553 void term_out(Terminal *);
554 void term_paint(Terminal *, Context, int, int, int, int, int);
555 void term_scroll(Terminal *, int, int);
556 void term_pwron(Terminal *);
557 void term_clrsb(Terminal *);
558 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
559                 int,int,int,int,int);
560 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
561               unsigned int);
562 void term_deselect(Terminal *);
563 void term_update(Terminal *);
564 void term_invalidate(Terminal *);
565 void term_blink(Terminal *, int set_cursor);
566 void term_do_paste(Terminal *);
567 int term_paste_pending(Terminal *);
568 void term_paste(Terminal *);
569 void term_nopaste(Terminal *);
570 int term_ldisc(Terminal *, int option);
571 void term_copyall(Terminal *);
572 void term_reconfig(Terminal *, Config *);
573 void term_seen_key_event(Terminal *); 
574 int from_backend(void *, int is_stderr, char *data, int len);
575 void term_provide_resize_fn(Terminal *term,
576                             void (*resize_fn)(void *, int, int),
577                             void *resize_ctx);
578 void term_provide_logctx(Terminal *term, void *logctx);
579
580 /*
581  * Exports from logging.c.
582  */
583 void *log_init(void *frontend, Config *cfg);
584 void log_free(void *logctx);
585 void log_reconfig(void *logctx, Config *cfg);
586 void logfopen(void *logctx);
587 void logfclose(void *logctx);
588 void logtraffic(void *logctx, unsigned char c, int logmode);
589 void log_eventlog(void *logctx, char *string);
590 enum { PKT_INCOMING, PKT_OUTGOING };
591 void log_packet(void *logctx, int direction, int type,
592                 char *texttype, void *data, int len);
593
594 /*
595  * Exports from testback.c
596  */
597
598 extern Backend null_backend;
599 extern Backend loop_backend;
600
601 /*
602  * Exports from raw.c.
603  */
604
605 extern Backend raw_backend;
606
607 /*
608  * Exports from rlogin.c.
609  */
610
611 extern Backend rlogin_backend;
612
613 /*
614  * Exports from telnet.c.
615  */
616
617 extern Backend telnet_backend;
618
619 /*
620  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
621  * so that PuTTYtel will still compile - otherwise it would depend
622  * on ssh.c.)
623  */
624
625 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
626                             int is_pw);
627 GLOBAL int ssh_getline_pw_only;
628 extern Backend ssh_backend;
629
630 /*
631  * Exports from ldisc.c.
632  */
633 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
634 void ldisc_free(void *);
635 void ldisc_send(void *handle, char *buf, int len, int interactive);
636
637 /*
638  * Exports from ldiscucs.c.
639  */
640 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
641 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
642
643 /*
644  * Exports from sshrand.c.
645  */
646
647 void random_add_noise(void *noise, int length);
648 void random_init(void);
649 int random_byte(void);
650 void random_get_savedata(void **data, int *len);
651 extern int random_active;
652
653 /*
654  * Exports from misc.c.
655  */
656
657 #include "misc.h"
658
659 /*
660  * Exports from version.c.
661  */
662 extern char ver[];
663
664 /*
665  * Exports from unicode.c.
666  */
667 #ifndef CP_UTF8
668 #define CP_UTF8 65001
669 #endif
670 /* void init_ucs(void); -- this is now in platform-specific headers */
671 int is_dbcs_leadbyte(int codepage, char byte);
672 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
673              wchar_t *wcstr, int wclen);
674 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
675              char *mbstr, int mblen, char *defchr, int *defused,
676              struct unicode_data *ucsdata);
677 wchar_t xlat_uskbd2cyrllic(int ch);
678 int check_compose(int first, int second);
679 int decode_codepage(char *cp_name);
680 char *cp_enumerate (int index);
681 char *cp_name(int codepage);
682 void get_unitab(int codepage, wchar_t * unitab, int ftype);
683
684 /*
685  * Exports from wcwidth.c
686  */
687 int wcwidth(wchar_t ucs);
688 int wcswidth(const wchar_t *pwcs, size_t n);
689
690 /*
691  * Exports from mscrypto.c
692  */
693 #ifdef MSCRYPTOAPI
694 int crypto_startup();
695 void crypto_wrapup();
696 #endif
697
698 /*
699  * Exports from pageantc.c
700  */
701 void agent_query(void *in, int inlen, void **out, int *outlen);
702 int agent_exists(void);
703
704 /*
705  * Exports from wildcard.c
706  */
707 const char *wc_error(int value);
708 int wc_match(const char *wildcard, const char *target);
709 int wc_unescape(char *output, const char *wildcard);
710
711 /*
712  * Exports from windlg.c
713  */
714 void logevent(void *frontend, char *);
715 void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
716                          char *keystr, char *fingerprint);
717 void askcipher(void *frontend, char *ciphername, int cs);
718 int askappend(void *frontend, char *filename);
719
720 /*
721  * Exports from console.c (that aren't equivalents to things in
722  * windlg.c).
723  */
724 extern int console_batch_mode;
725 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
726 void console_provide_logctx(void *logctx);
727
728 /*
729  * Exports from printing.c.
730  */
731 typedef struct printer_enum_tag printer_enum;
732 typedef struct printer_job_tag printer_job;
733 printer_enum *printer_start_enum(int *nprinters);
734 char *printer_get_name(printer_enum *, int);
735 void printer_finish_enum(printer_enum *);
736 printer_job *printer_start_job(char *printer);
737 void printer_job_data(printer_job *, void *, int);
738 void printer_finish_job(printer_job *);
739
740 /*
741  * Exports from cmdline.c (and also cmdline_error(), which is
742  * defined differently in various places and required _by_
743  * cmdline.c).
744  */
745 int cmdline_process_param(char *, char *, int, Config *);
746 void cmdline_run_saved(Config *);
747 extern char *cmdline_password;
748 #define TOOLTYPE_FILETRANSFER 1
749 extern int cmdline_tooltype;
750
751 void cmdline_error(char *, ...);
752
753 /*
754  * X11 auth mechanisms we know about.
755  */
756 enum {
757     X11_NO_AUTH,
758     X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
759     X11_XDM,                           /* XDM-AUTHORIZATION-1 */
760     X11_NAUTHS
761 };
762 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
763
764 #endif