plink can now execute a specific command instead of just a shell session
[u/mdw/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
4#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
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#ifdef PUTTY_DO_GLOBALS
12#define GLOBAL
13#else
14#define GLOBAL extern
15#endif
16
73251d5d 17GLOBAL HINSTANCE putty_inst;
18
374330e2 19#define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */
20#define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */
21#define ATTR_INVALID 0x20000000UL
22#define ATTR_WRAPPED 0x10000000UL
23
c9def1b8 24#define LATTR_NORM 0x00000000UL
25#define LATTR_WIDE 0x01000000UL
26#define LATTR_TOP 0x02000000UL
27#define LATTR_BOT 0x03000000UL
28#define LATTR_MODE 0x03000000UL
29
374330e2 30#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
31#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
32#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
33
34#define ATTR_BOLD 0x00000100UL
35#define ATTR_UNDER 0x00000200UL
36#define ATTR_REVERSE 0x00000400UL
e14a5a13 37#define ATTR_BLINK 0x00000800UL
374330e2 38#define ATTR_FGMASK 0x0000F000UL
39#define ATTR_BGMASK 0x000F0000UL
40#define ATTR_FGSHIFT 12
41#define ATTR_BGSHIFT 16
42
43#define ATTR_DEFAULT 0x00098000UL
44#define ATTR_DEFFG 0x00008000UL
45#define ATTR_DEFBG 0x00090000UL
46#define ATTR_CUR_XOR 0x000BA000UL
47#define ERASE_CHAR (ATTR_DEFAULT | ' ')
48#define ATTR_MASK 0xFFFFFF00UL
49#define CHAR_MASK 0x000000FFUL
50
51typedef HDC Context;
52#define SEL_NL { 13, 10 }
53
54GLOBAL int rows, cols, savelines;
55
56GLOBAL int font_width, font_height;
57
c9def1b8 58#define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
59 inbuf[inbuf_head++] = (_C) ; } while(0)
374330e2 60#define INBUF_SIZE 2048
374330e2 61GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 62GLOBAL int inbuf_head;
374330e2 63
64#define OUTBUF_SIZE 2048
65#define OUTBUF_MASK (OUTBUF_SIZE-1)
66GLOBAL unsigned char outbuf[OUTBUF_SIZE];
67GLOBAL int outbuf_head, outbuf_reap;
68
69GLOBAL int has_focus;
70
c9def1b8 71GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
72GLOBAL int repeat_off, cr_lf_return;
374330e2 73
cabfd08c 74GLOBAL int seen_key_event;
75GLOBAL int seen_disp_event;
76
d85548fe 77GLOBAL int session_closed;
78
5fd04f07 79GLOBAL char *logfile;
80
e14a5a13 81/*
82 * I've just looked in the windows standard headr files for WM_USER, there
83 * are hundreds of flags defined using the form WM_USER+123 so I've
84 * renumbered this NETEVENT value and the two in window.c
85 */
86#define WM_XUSER (WM_USER + 0x2000)
87#define WM_NETEVENT (WM_XUSER + 5)
374330e2 88
89typedef enum {
90 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
684d367c 91 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO
374330e2 92} Telnet_Special;
93
94typedef enum {
95 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
96} Mouse_Button;
97
98typedef enum {
99 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
100} Mouse_Action;
101
102typedef enum {
103 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
104} VT_Mode;
105
106typedef struct {
107 char *(*init) (HWND hwnd, char *host, int port, char **realhost);
108 int (*msg) (WPARAM wParam, LPARAM lParam);
109 void (*send) (char *buf, int len);
110 void (*size) (void);
111 void (*special) (Telnet_Special code);
4017be6d 112 SOCKET (*socket) (void);
374330e2 113} Backend;
114
115GLOBAL Backend *back;
116
297d398b 117extern struct backend_list {
89ee5268 118 int protocol;
119 char *name;
120 Backend *backend;
121} backends[];
122
374330e2 123typedef struct {
5bc238bb 124 void (*send) (char *buf, int len);
125} Ldisc;
126
127GLOBAL Ldisc *ldisc;
128
129typedef struct {
374330e2 130 /* Basic options */
131 char host[512];
132 int port;
5e1a8e27 133 enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2 134 int close_on_exit;
9ef49106 135 int warn_on_close;
fef97f43 136 /* SSH options */
6abbf9e3 137 char remote_cmd[512];
fef97f43 138 int nopty;
9697bfd2 139 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 140 char keyfile[FILENAME_MAX];
ccbfb941 141 int try_tis_auth;
374330e2 142 /* Telnet options */
143 char termtype[32];
144 char termspeed[32];
37508af4 145 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 146 char username[32];
147 int rfc_environ;
148 /* Keyboard options */
149 int bksp_is_delete;
150 int rxvt_homeend;
c9def1b8 151 int funky_type;
374330e2 152 int app_cursor;
153 int app_keypad;
c5e9c988 154 int nethack_keypad;
155 int alt_f4; /* is it special? */
156 int alt_space; /* is it special? */
5bc238bb 157 int ldisc_term;
c9def1b8 158 int scroll_on_key;
374330e2 159 /* Terminal options */
160 int savelines;
161 int dec_om;
162 int wrap_mode;
fef97f43 163 int lfhascr;
c9def1b8 164 int blink_cur;
165 int beep;
166 int scrollbar;
167 int locksize;
168 int bce;
169 int blinktext;
374330e2 170 int win_name_always;
171 int width, height;
172 char font[64];
173 int fontisbold;
174 int fontheight;
14963b8f 175 int fontcharset;
374330e2 176 /* Colour options */
177 int try_palette;
178 int bold_colour;
179 unsigned char colours[22][3];
180 /* Selection options */
181 int mouse_is_xterm;
182 short wordness[256];
c9def1b8 183 /* translations */
184 VT_Mode vtmode;
14963b8f 185 int xlat_enablekoiwin;
d3d16feb 186 int xlat_88592w1250;
14963b8f 187 int xlat_capslockcyr;
374330e2 188} Config;
189
e277c42d 190/*
191 * You can compile with -DSSH_DEFAULT to have ssh by default.
192 */
193#ifndef SSH_DEFAULT
194#define DEFAULT_PROTOCOL PROT_TELNET
195#define DEFAULT_PORT 23
196#else
197#define DEFAULT_PROTOCOL PROT_SSH
198#define DEFAULT_PORT 22
199#endif
200
4017be6d 201/*
202 * Some global flags denoting the type of application.
203 */
204#define FLAG_VERBOSE 0x0001
205#define FLAG_WINDOWED 0x0002
206#define FLAG_CONNECTION 0x0004
207GLOBAL int flags;
208
374330e2 209GLOBAL Config cfg;
e277c42d 210GLOBAL int default_protocol;
211GLOBAL int default_port;
374330e2 212
4e23b276 213struct RSAKey; /* be a little careful of scope */
214
374330e2 215/*
216 * Exports from window.c.
217 */
e14a5a13 218void request_resize (int, int, int);
c9def1b8 219void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 220void set_title (char *);
221void set_icon (char *);
222void set_sbar (int, int, int);
f67b4e85 223Context get_ctx(void);
374330e2 224void free_ctx (Context);
225void palette_set (int, int, int, int);
226void palette_reset (void);
227void write_clip (void *, int);
228void get_clip (void **, int *);
229void optimised_move (int, int, int);
230void fatalbox (char *, ...);
c9def1b8 231void beep (int);
374330e2 232#define OPTIMISE_IS_SCROLL 1
233
234/*
235 * Exports from noise.c.
236 */
237void noise_get_heavy(void (*func) (void *, int));
238void noise_get_light(void (*func) (void *, int));
239void noise_ultralight(DWORD data);
240void random_save_seed(void);
241
242/*
243 * Exports from windlg.c.
244 */
245int do_config (void);
246int do_reconfig (HWND);
247void do_defaults (char *);
c5e9c988 248void logevent (char *);
249void showeventlog (HWND);
374330e2 250void showabout (HWND);
89ee5268 251void verify_ssh_host_key(char *host, char *keystr);
0a4aa984 252void get_sesslist(int allocate);
253
7393a137 254GLOBAL int nsessions;
255GLOBAL char **sessions;
374330e2 256
257/*
258 * Exports from terminal.c.
259 */
260
261void term_init (void);
262void term_size (int, int, int);
263void term_out (void);
264void term_paint (Context, int, int, int, int);
265void term_scroll (int, int);
266void term_pwron (void);
267void term_clrsb (void);
268void term_mouse (Mouse_Button, Mouse_Action, int, int);
269void term_deselect (void);
270void term_update (void);
271void term_invalidate(void);
e14a5a13 272void term_blink(int set_cursor);
c9def1b8 273void term_paste(void);
274void term_nopaste(void);
374330e2 275
276/*
5e1a8e27 277 * Exports from raw.c.
278 */
279
3d9a14c9 280extern Backend raw_backend;
5e1a8e27 281
282/*
374330e2 283 * Exports from telnet.c.
284 */
285
c14776e8 286extern Backend telnet_backend;
374330e2 287
288/*
289 * Exports from ssh.c.
290 */
291
c14776e8 292extern Backend ssh_backend;
374330e2 293
294/*
5bc238bb 295 * Exports from ldisc.c.
296 */
297
298extern Ldisc ldisc_term, ldisc_simple;
299
300/*
374330e2 301 * Exports from sshrand.c.
302 */
303
304void random_add_noise(void *noise, int length);
305void random_init(void);
306int random_byte(void);
307void random_get_savedata(void **data, int *len);
308
309/*
310 * Exports from misc.c.
311 */
312
313/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
314#ifdef MALLOC_LOG
315#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
316#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
317#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
318void mlog(char *, int);
319#else
320#define smalloc safemalloc
321#define srealloc saferealloc
322#define sfree safefree
323#endif
324
325void *safemalloc(size_t);
326void *saferealloc(void *, size_t);
327void safefree(void *);
328
329/*
067a15ea 330 * Exports from version.c.
331 */
332extern char ver[];
333
334/*
b73fd1b1 335 * Exports from sizetip.c.
336 */
337void UpdateSizeTip(HWND src, int cx, int cy);
338void EnableSizeTip(int bEnable);
339
340/*
14963b8f 341 * Exports from xlat.c.
342 */
343unsigned char xlat_kbd2tty(unsigned char c);
344unsigned char xlat_tty2scr(unsigned char c);
345unsigned char xlat_latkbd2win(unsigned char c);
346
347/*
8f203108 348 * Exports from mscrypto.c
349 */
350#ifdef MSCRYPTOAPI
351int crypto_startup();
352void crypto_wrapup();
353#endif
354
355/*
374330e2 356 * A debug system.
357 */
358#ifdef DEBUG
359#include <stdarg.h>
360#define debug(x) (dprintf x)
361static void dprintf(char *fmt, ...) {
362 char buf[2048];
363 DWORD dw;
364 va_list ap;
365 static int gotconsole = 0;
366
367 if (!gotconsole) {
368 AllocConsole();
369 gotconsole = 1;
370 }
371
372 va_start(ap, fmt);
373 vsprintf(buf, fmt, ap);
374 WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
375 va_end(ap);
376}
377#else
378#define debug(x)
379#endif
380
381#endif