psftp now works as part of the PuTTY suite
[u/mdw/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
8df7a775 4#include "network.h"
5
374330e2 6#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
de3df031 7#define PUTTY_REG_PARENT "Software\\SimonTatham"
8#define PUTTY_REG_PARENT_CHILD "PuTTY"
9#define PUTTY_REG_GPARENT "Software"
10#define PUTTY_REG_GPARENT_CHILD "SimonTatham"
374330e2 11
12/*
13 * Global variables. Most modules declare these `extern', but
14 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
15 * module, and so will get them properly defined.
16 */
17#ifdef PUTTY_DO_GLOBALS
18#define GLOBAL
19#else
20#define GLOBAL extern
21#endif
22
23#define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */
24#define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */
25#define ATTR_INVALID 0x20000000UL
26#define ATTR_WRAPPED 0x10000000UL
4e30ff69 27#define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */
374330e2 28
c9def1b8 29#define LATTR_NORM 0x00000000UL
30#define LATTR_WIDE 0x01000000UL
31#define LATTR_TOP 0x02000000UL
32#define LATTR_BOT 0x03000000UL
33#define LATTR_MODE 0x03000000UL
34
374330e2 35#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
36#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
37#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
38
39#define ATTR_BOLD 0x00000100UL
40#define ATTR_UNDER 0x00000200UL
41#define ATTR_REVERSE 0x00000400UL
e14a5a13 42#define ATTR_BLINK 0x00000800UL
374330e2 43#define ATTR_FGMASK 0x0000F000UL
44#define ATTR_BGMASK 0x000F0000UL
45#define ATTR_FGSHIFT 12
46#define ATTR_BGSHIFT 16
47
48#define ATTR_DEFAULT 0x00098000UL
49#define ATTR_DEFFG 0x00008000UL
50#define ATTR_DEFBG 0x00090000UL
51#define ATTR_CUR_XOR 0x000BA000UL
52#define ERASE_CHAR (ATTR_DEFAULT | ' ')
53#define ATTR_MASK 0xFFFFFF00UL
54#define CHAR_MASK 0x000000FFUL
55
56typedef HDC Context;
57#define SEL_NL { 13, 10 }
58
59GLOBAL int rows, cols, savelines;
60
61GLOBAL int font_width, font_height;
62
63#define INBUF_SIZE 2048
374330e2 64GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 65GLOBAL int inbuf_head;
374330e2 66
67#define OUTBUF_SIZE 2048
68#define OUTBUF_MASK (OUTBUF_SIZE-1)
69GLOBAL unsigned char outbuf[OUTBUF_SIZE];
70GLOBAL int outbuf_head, outbuf_reap;
71
72GLOBAL int has_focus;
73
c9def1b8 74GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
75GLOBAL int repeat_off, cr_lf_return;
374330e2 76
cabfd08c 77GLOBAL int seen_key_event;
78GLOBAL int seen_disp_event;
79
d85548fe 80GLOBAL int session_closed;
81
e1c8e0ed 82#define LGTYP_NONE 0 /* logmode: no logging */
83#define LGTYP_ASCII 1 /* logmode: pure ascii */
84#define LGTYP_DEBUG 2 /* logmode: all chars of taffic */
5fd04f07 85GLOBAL char *logfile;
86
e14a5a13 87/*
475eebf9 88 * Window handles for the dialog boxes that can be running during a
89 * PuTTY session.
90 */
91GLOBAL HWND logbox;
92
93/*
e14a5a13 94 * I've just looked in the windows standard headr files for WM_USER, there
95 * are hundreds of flags defined using the form WM_USER+123 so I've
96 * renumbered this NETEVENT value and the two in window.c
97 */
98#define WM_XUSER (WM_USER + 0x2000)
99#define WM_NETEVENT (WM_XUSER + 5)
374330e2 100
101typedef enum {
102 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
ec55b220 103 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
374330e2 104} Telnet_Special;
105
106typedef enum {
107 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
108} Mouse_Button;
109
110typedef enum {
111 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
112} Mouse_Action;
113
114typedef enum {
115 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
116} VT_Mode;
117
0965bee0 118enum {
119 /*
120 * Line discipline option states: off, on, up to the backend.
121 */
122 LD_YES, LD_NO, LD_BACKEND
123};
124
125enum {
126 /*
127 * Line discipline options which the backend might try to control.
128 */
129 LD_EDIT, /* local line editing */
130 LD_ECHO /* local echo */
131};
132
b41069ff 133enum {
134 /*
135 * Close On Exit behaviours. (cfg.close_on_exit)
136 */
137 COE_NEVER, /* Never close the window */
1cd48051 138 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
139 COE_ALWAYS /* Always close the window */
b41069ff 140};
141
374330e2 142typedef struct {
8df7a775 143 char *(*init) (char *host, int port, char **realhost);
374330e2 144 void (*send) (char *buf, int len);
145 void (*size) (void);
146 void (*special) (Telnet_Special code);
8df7a775 147 Socket (*socket) (void);
8ccc75b0 148 int (*sendok) (void);
0965bee0 149 int (*ldisc) (int);
97db3be4 150 int default_port;
374330e2 151} Backend;
152
153GLOBAL Backend *back;
154
297d398b 155extern struct backend_list {
89ee5268 156 int protocol;
157 char *name;
158 Backend *backend;
159} backends[];
160
374330e2 161typedef struct {
162 /* Basic options */
163 char host[512];
164 int port;
c91409da 165 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 166 int close_on_exit;
9ef49106 167 int warn_on_close;
edce8e45 168 int ping_interval; /* in seconds */
fef97f43 169 /* SSH options */
6abbf9e3 170 char remote_cmd[512];
fef97f43 171 int nopty;
4ba9b64b 172 int compression;
979310f1 173 int agentfwd;
9697bfd2 174 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 175 char keyfile[FILENAME_MAX];
adf799dd 176 int sshprot; /* use v1 or v2 when both available */
7591b9ff 177 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 178 int try_tis_auth;
4a8fc3c4 179 int ssh_subsys; /* run a subsystem rather than a command */
374330e2 180 /* Telnet options */
181 char termtype[32];
182 char termspeed[32];
37508af4 183 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 184 char username[32];
c91409da 185 char localusername[32];
374330e2 186 int rfc_environ;
187 /* Keyboard options */
188 int bksp_is_delete;
189 int rxvt_homeend;
c9def1b8 190 int funky_type;
b00f8b34 191 int no_applic_c; /* totally disable app cursor keys */
192 int no_applic_k; /* totally disable app keypad */
374330e2 193 int app_cursor;
194 int app_keypad;
c5e9c988 195 int nethack_keypad;
196 int alt_f4; /* is it special? */
197 int alt_space; /* is it special? */
a094ae43 198 int alt_only; /* is it special? */
0965bee0 199 int localecho;
200 int localedit;
e95edc00 201 int alwaysontop;
c9def1b8 202 int scroll_on_key;
a094ae43 203 int scroll_on_disp;
204 int compose_key;
9ca5da42 205 char wintitle[256]; /* initial window title */
374330e2 206 /* Terminal options */
207 int savelines;
208 int dec_om;
209 int wrap_mode;
fef97f43 210 int lfhascr;
4e30ff69 211 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 212 int blink_cur;
213 int beep;
214 int scrollbar;
215 int locksize;
216 int bce;
217 int blinktext;
374330e2 218 int win_name_always;
219 int width, height;
220 char font[64];
221 int fontisbold;
222 int fontheight;
14963b8f 223 int fontcharset;
e1c8e0ed 224 char logfilename[FILENAME_MAX];
225 int logtype;
554c540d 226 int hide_mouseptr;
374330e2 227 /* Colour options */
228 int try_palette;
229 int bold_colour;
230 unsigned char colours[22][3];
231 /* Selection options */
232 int mouse_is_xterm;
233 short wordness[256];
c9def1b8 234 /* translations */
235 VT_Mode vtmode;
14963b8f 236 int xlat_enablekoiwin;
d3d16feb 237 int xlat_88592w1250;
b0faa571 238 int xlat_88592cp852;
14963b8f 239 int xlat_capslockcyr;
9c964e85 240 /* X11 forwarding */
241 int x11_forward;
242 char x11_display[128];
374330e2 243} Config;
244
e277c42d 245/*
246 * You can compile with -DSSH_DEFAULT to have ssh by default.
247 */
248#ifndef SSH_DEFAULT
249#define DEFAULT_PROTOCOL PROT_TELNET
250#define DEFAULT_PORT 23
251#else
252#define DEFAULT_PROTOCOL PROT_SSH
253#define DEFAULT_PORT 22
254#endif
255
4017be6d 256/*
257 * Some global flags denoting the type of application.
67779be7 258 *
259 * FLAG_VERBOSE is set when the user requests verbose details.
260 *
261 * FLAG_STDERR is set in command-line applications (which have a
262 * functioning stderr that it makes sense to write to) and not in
263 * GUI applications (which don't).
264 *
265 * FLAG_INTERACTIVE is set when a full interactive shell session is
266 * being run, _either_ because no remote command has been provided
267 * _or_ because the application is GUI and can't run non-
268 * interactively.
4017be6d 269 */
67779be7 270#define FLAG_VERBOSE 0x0001
271#define FLAG_STDERR 0x0002
272#define FLAG_INTERACTIVE 0x0004
4017be6d 273GLOBAL int flags;
274
374330e2 275GLOBAL Config cfg;
e277c42d 276GLOBAL int default_protocol;
277GLOBAL int default_port;
374330e2 278
4e23b276 279struct RSAKey; /* be a little careful of scope */
280
374330e2 281/*
282 * Exports from window.c.
283 */
e14a5a13 284void request_resize (int, int, int);
c9def1b8 285void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 286void set_title (char *);
287void set_icon (char *);
288void set_sbar (int, int, int);
f67b4e85 289Context get_ctx(void);
374330e2 290void free_ctx (Context);
291void palette_set (int, int, int, int);
292void palette_reset (void);
f0df44da 293void write_clip (void *, int, int);
374330e2 294void get_clip (void **, int *);
295void optimised_move (int, int, int);
8d5de777 296void connection_fatal(char *, ...);
374330e2 297void fatalbox (char *, ...);
c9def1b8 298void beep (int);
6f34e365 299void begin_session(void);
ec8679e9 300void sys_cursor(int x, int y);
374330e2 301#define OPTIMISE_IS_SCROLL 1
302
303/*
304 * Exports from noise.c.
305 */
7d6ee6ff 306void noise_get_heavy(void (*func)(void *, int));
307void noise_get_light(void (*func)(void *, int));
308void noise_regular(void);
374330e2 309void noise_ultralight(DWORD data);
310void random_save_seed(void);
de3df031 311void random_destroy_seed(void);
374330e2 312
313/*
314 * Exports from windlg.c.
315 */
8c3cd914 316void defuse_showwindow(void);
374330e2 317int do_config (void);
318int do_reconfig (HWND);
a9422f39 319void do_defaults (char *, Config *);
c5e9c988 320void logevent (char *);
321void showeventlog (HWND);
374330e2 322void showabout (HWND);
d4857987 323void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 324 char *keystr, char *fingerprint);
e1c8e0ed 325int askappend(char *filename);
de3df031 326void registry_cleanup(void);
3da0b1d2 327void force_normal(HWND hwnd);
0a4aa984 328
7393a137 329GLOBAL int nsessions;
330GLOBAL char **sessions;
374330e2 331
332/*
a9422f39 333 * Exports from settings.c.
334 */
335void save_settings (char *section, int do_host, Config *cfg);
336void load_settings (char *section, int do_host, Config *cfg);
337void get_sesslist(int allocate);
338
339/*
374330e2 340 * Exports from terminal.c.
341 */
342
343void term_init (void);
344void term_size (int, int, int);
345void term_out (void);
346void term_paint (Context, int, int, int, int);
347void term_scroll (int, int);
348void term_pwron (void);
349void term_clrsb (void);
350void term_mouse (Mouse_Button, Mouse_Action, int, int);
351void term_deselect (void);
352void term_update (void);
353void term_invalidate(void);
e14a5a13 354void term_blink(int set_cursor);
c9def1b8 355void term_paste(void);
356void term_nopaste(void);
feb7fdfe 357int term_ldisc(int option);
fe50e814 358void from_backend(int is_stderr, char *data, int len);
e1c8e0ed 359void logfopen (void);
360void logfclose (void);
bc1235d4 361void term_copyall(void);
374330e2 362
363/*
5e1a8e27 364 * Exports from raw.c.
365 */
366
3d9a14c9 367extern Backend raw_backend;
5e1a8e27 368
369/*
c91409da 370 * Exports from rlogin.c.
371 */
372
373extern Backend rlogin_backend;
374
375/*
374330e2 376 * Exports from telnet.c.
377 */
378
c14776e8 379extern Backend telnet_backend;
374330e2 380
381/*
382 * Exports from ssh.c.
383 */
384
67779be7 385extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
c14776e8 386extern Backend ssh_backend;
374330e2 387
388/*
5bc238bb 389 * Exports from ldisc.c.
390 */
391
0965bee0 392extern void ldisc_send(char *buf, int len);
5bc238bb 393
394/*
374330e2 395 * Exports from sshrand.c.
396 */
397
398void random_add_noise(void *noise, int length);
399void random_init(void);
400int random_byte(void);
401void random_get_savedata(void **data, int *len);
402
403/*
404 * Exports from misc.c.
405 */
406
dcbde236 407#include "puttymem.h"
374330e2 408
409/*
067a15ea 410 * Exports from version.c.
411 */
412extern char ver[];
413
414/*
b73fd1b1 415 * Exports from sizetip.c.
416 */
417void UpdateSizeTip(HWND src, int cx, int cy);
418void EnableSizeTip(int bEnable);
419
420/*
14963b8f 421 * Exports from xlat.c.
422 */
423unsigned char xlat_kbd2tty(unsigned char c);
424unsigned char xlat_tty2scr(unsigned char c);
425unsigned char xlat_latkbd2win(unsigned char c);
426
427/*
8f203108 428 * Exports from mscrypto.c
429 */
430#ifdef MSCRYPTOAPI
431int crypto_startup();
432void crypto_wrapup();
433#endif
434
435/*
5c58ad2d 436 * Exports from pageantc.c
437 */
438void agent_query(void *in, int inlen, void **out, int *outlen);
439int agent_exists(void);
440
374330e2 441#ifdef DEBUG
c82bda52 442void dprintf(char *fmt, ...);
374330e2 443#define debug(x) (dprintf x)
374330e2 444#else
445#define debug(x)
446#endif
447
448#endif