Be more sure that state->collecting_entropy can't be spuriously set
[u/mdw/putty] / putty.h
... / ...
CommitLineData
1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
4#include "network.h"
5
6#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
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"
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
27
28#define LATTR_NORM 0x00000000UL
29#define LATTR_WIDE 0x01000000UL
30#define LATTR_TOP 0x02000000UL
31#define LATTR_BOT 0x03000000UL
32#define LATTR_MODE 0x03000000UL
33
34#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
35#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
36#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
37
38#define ATTR_BOLD 0x00000100UL
39#define ATTR_UNDER 0x00000200UL
40#define ATTR_REVERSE 0x00000400UL
41#define ATTR_BLINK 0x00000800UL
42#define ATTR_FGMASK 0x0000F000UL
43#define ATTR_BGMASK 0x000F0000UL
44#define ATTR_FGSHIFT 12
45#define ATTR_BGSHIFT 16
46
47#define ATTR_DEFAULT 0x00098000UL
48#define ATTR_DEFFG 0x00008000UL
49#define ATTR_DEFBG 0x00090000UL
50#define ATTR_CUR_XOR 0x000BA000UL
51#define ERASE_CHAR (ATTR_DEFAULT | ' ')
52#define ATTR_MASK 0xFFFFFF00UL
53#define CHAR_MASK 0x000000FFUL
54
55typedef HDC Context;
56#define SEL_NL { 13, 10 }
57
58GLOBAL int rows, cols, savelines;
59
60GLOBAL int font_width, font_height;
61
62#define INBUF_SIZE 2048
63GLOBAL unsigned char inbuf[INBUF_SIZE];
64GLOBAL int inbuf_head;
65
66#define OUTBUF_SIZE 2048
67#define OUTBUF_MASK (OUTBUF_SIZE-1)
68GLOBAL unsigned char outbuf[OUTBUF_SIZE];
69GLOBAL int outbuf_head, outbuf_reap;
70
71GLOBAL int has_focus;
72
73GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
74GLOBAL int repeat_off, cr_lf_return;
75
76GLOBAL int seen_key_event;
77GLOBAL int seen_disp_event;
78
79GLOBAL int session_closed;
80
81GLOBAL char *logfile;
82
83/*
84 * I've just looked in the windows standard headr files for WM_USER, there
85 * are hundreds of flags defined using the form WM_USER+123 so I've
86 * renumbered this NETEVENT value and the two in window.c
87 */
88#define WM_XUSER (WM_USER + 0x2000)
89#define WM_NETEVENT (WM_XUSER + 5)
90
91typedef enum {
92 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
93 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
94} Telnet_Special;
95
96typedef enum {
97 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
98} Mouse_Button;
99
100typedef enum {
101 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
102} Mouse_Action;
103
104typedef enum {
105 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
106} VT_Mode;
107
108typedef struct {
109 char *(*init) (char *host, int port, char **realhost);
110 void (*send) (char *buf, int len);
111 void (*size) (void);
112 void (*special) (Telnet_Special code);
113 Socket (*socket) (void);
114 int (*sendok) (void);
115 int default_port;
116} Backend;
117
118GLOBAL Backend *back;
119
120extern struct backend_list {
121 int protocol;
122 char *name;
123 Backend *backend;
124} backends[];
125
126typedef struct {
127 void (*send) (char *buf, int len);
128} Ldisc;
129
130GLOBAL Ldisc *ldisc;
131
132typedef struct {
133 /* Basic options */
134 char host[512];
135 int port;
136 enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
137 int close_on_exit;
138 int warn_on_close;
139 int ping_interval;
140 /* SSH options */
141 char remote_cmd[512];
142 int nopty;
143 int agentfwd;
144 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
145 char keyfile[FILENAME_MAX];
146 int sshprot; /* use v1 or v2 when both available */
147 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
148 int try_tis_auth;
149 /* Telnet options */
150 char termtype[32];
151 char termspeed[32];
152 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
153 char username[32];
154 int rfc_environ;
155 /* Keyboard options */
156 int bksp_is_delete;
157 int rxvt_homeend;
158 int funky_type;
159 int no_applic; /* totally disable application modes */
160 int app_cursor;
161 int app_keypad;
162 int nethack_keypad;
163 int alt_f4; /* is it special? */
164 int alt_space; /* is it special? */
165 int alt_only; /* is it special? */
166 int ldisc_term;
167 int scroll_on_key;
168 int scroll_on_disp;
169 int compose_key;
170 char wintitle[256]; /* initial window title */
171 /* Terminal options */
172 int savelines;
173 int dec_om;
174 int wrap_mode;
175 int lfhascr;
176 int blink_cur;
177 int beep;
178 int scrollbar;
179 int locksize;
180 int bce;
181 int blinktext;
182 int win_name_always;
183 int width, height;
184 char font[64];
185 int fontisbold;
186 int fontheight;
187 int fontcharset;
188 /* Colour options */
189 int try_palette;
190 int bold_colour;
191 unsigned char colours[22][3];
192 /* Selection options */
193 int mouse_is_xterm;
194 short wordness[256];
195 /* translations */
196 VT_Mode vtmode;
197 int xlat_enablekoiwin;
198 int xlat_88592w1250;
199 int xlat_88592cp852;
200 int xlat_capslockcyr;
201} Config;
202
203/*
204 * You can compile with -DSSH_DEFAULT to have ssh by default.
205 */
206#ifndef SSH_DEFAULT
207#define DEFAULT_PROTOCOL PROT_TELNET
208#define DEFAULT_PORT 23
209#else
210#define DEFAULT_PROTOCOL PROT_SSH
211#define DEFAULT_PORT 22
212#endif
213
214/*
215 * Some global flags denoting the type of application.
216 *
217 * FLAG_VERBOSE is set when the user requests verbose details.
218 *
219 * FLAG_STDERR is set in command-line applications (which have a
220 * functioning stderr that it makes sense to write to) and not in
221 * GUI applications (which don't).
222 *
223 * FLAG_INTERACTIVE is set when a full interactive shell session is
224 * being run, _either_ because no remote command has been provided
225 * _or_ because the application is GUI and can't run non-
226 * interactively.
227 */
228#define FLAG_VERBOSE 0x0001
229#define FLAG_STDERR 0x0002
230#define FLAG_INTERACTIVE 0x0004
231GLOBAL int flags;
232
233GLOBAL Config cfg;
234GLOBAL int default_protocol;
235GLOBAL int default_port;
236
237struct RSAKey; /* be a little careful of scope */
238
239/*
240 * Exports from window.c.
241 */
242void request_resize (int, int, int);
243void do_text (Context, int, int, char *, int, unsigned long, int);
244void set_title (char *);
245void set_icon (char *);
246void set_sbar (int, int, int);
247Context get_ctx(void);
248void free_ctx (Context);
249void palette_set (int, int, int, int);
250void palette_reset (void);
251void write_clip (void *, int, int);
252void get_clip (void **, int *);
253void optimised_move (int, int, int);
254void connection_fatal(char *, ...);
255void fatalbox (char *, ...);
256void beep (int);
257void begin_session(void);
258void sys_cursor(int x, int y);
259#define OPTIMISE_IS_SCROLL 1
260
261/*
262 * Exports from noise.c.
263 */
264void noise_get_heavy(void (*func)(void *, int));
265void noise_get_light(void (*func)(void *, int));
266void noise_regular(void);
267void noise_ultralight(DWORD data);
268void random_save_seed(void);
269void random_destroy_seed(void);
270
271/*
272 * Exports from windlg.c.
273 */
274void defuse_showwindow(void);
275int do_config (void);
276int do_reconfig (HWND);
277void do_defaults (char *, Config *);
278void logevent (char *);
279void showeventlog (HWND);
280void showabout (HWND);
281void verify_ssh_host_key(char *host, int port, char *keytype,
282 char *keystr, char *fingerprint);
283void registry_cleanup(void);
284
285GLOBAL int nsessions;
286GLOBAL char **sessions;
287
288/*
289 * Exports from settings.c.
290 */
291void save_settings (char *section, int do_host, Config *cfg);
292void load_settings (char *section, int do_host, Config *cfg);
293void get_sesslist(int allocate);
294
295/*
296 * Exports from terminal.c.
297 */
298
299void term_init (void);
300void term_size (int, int, int);
301void term_out (void);
302void term_paint (Context, int, int, int, int);
303void term_scroll (int, int);
304void term_pwron (void);
305void term_clrsb (void);
306void term_mouse (Mouse_Button, Mouse_Action, int, int);
307void term_deselect (void);
308void term_update (void);
309void term_invalidate(void);
310void term_blink(int set_cursor);
311void term_paste(void);
312void term_nopaste(void);
313void from_backend(int is_stderr, char *data, int len);
314
315/*
316 * Exports from raw.c.
317 */
318
319extern Backend raw_backend;
320
321/*
322 * Exports from telnet.c.
323 */
324
325extern Backend telnet_backend;
326
327/*
328 * Exports from ssh.c.
329 */
330
331extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
332extern Backend ssh_backend;
333
334/*
335 * Exports from ldisc.c.
336 */
337
338extern Ldisc ldisc_term, ldisc_simple;
339
340/*
341 * Exports from sshrand.c.
342 */
343
344void random_add_noise(void *noise, int length);
345void random_init(void);
346int random_byte(void);
347void random_get_savedata(void **data, int *len);
348
349/*
350 * Exports from misc.c.
351 */
352
353/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
354#ifdef MALLOC_LOG
355#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
356#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
357#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
358void mlog(char *, int);
359#else
360#define smalloc safemalloc
361#define srealloc saferealloc
362#define sfree safefree
363#endif
364
365void *safemalloc(size_t);
366void *saferealloc(void *, size_t);
367void safefree(void *);
368
369/*
370 * Exports from version.c.
371 */
372extern char ver[];
373
374/*
375 * Exports from sizetip.c.
376 */
377void UpdateSizeTip(HWND src, int cx, int cy);
378void EnableSizeTip(int bEnable);
379
380/*
381 * Exports from xlat.c.
382 */
383unsigned char xlat_kbd2tty(unsigned char c);
384unsigned char xlat_tty2scr(unsigned char c);
385unsigned char xlat_latkbd2win(unsigned char c);
386
387/*
388 * Exports from mscrypto.c
389 */
390#ifdef MSCRYPTOAPI
391int crypto_startup();
392void crypto_wrapup();
393#endif
394
395/*
396 * Exports from pageantc.c
397 */
398void agent_query(void *in, int inlen, void **out, int *outlen);
399int agent_exists(void);
400
401/*
402 * A debug system.
403 */
404#ifdef DEBUG
405#include <stdarg.h>
406#define debug(x) (dprintf x)
407static void dprintf(char *fmt, ...) {
408 char buf[2048];
409 DWORD dw;
410 va_list ap;
411 static int gotconsole = 0;
412
413 if (!gotconsole) {
414 AllocConsole();
415 gotconsole = 1;
416 }
417
418 va_start(ap, fmt);
419 vsprintf(buf, fmt, ap);
420 WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
421 va_end(ap);
422}
423#else
424#define debug(x)
425#endif
426
427#endif