[u/mdw/putty] / putty.h

#ifndef PUTTY_PUTTY_H
#define PUTTY_PUTTY_H

#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"

/*
 * Global variables. Most modules declare these `extern', but
 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
 * module, and so will get them properly defined.
 */
#ifdef PUTTY_DO_GLOBALS
#define GLOBAL
#else
#define GLOBAL extern
#endif

GLOBAL HINSTANCE putty_inst;

#define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
#define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
#define ATTR_INVALID 0x20000000UL
#define ATTR_WRAPPED 0x10000000UL

#define LATTR_NORM   0x00000000UL
#define LATTR_WIDE   0x01000000UL
#define LATTR_TOP    0x02000000UL
#define LATTR_BOT    0x03000000UL
#define LATTR_MODE   0x03000000UL

#define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
#define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
#define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */

#define ATTR_BOLD    0x00000100UL
#define ATTR_UNDER   0x00000200UL
#define ATTR_REVERSE 0x00000400UL
#define ATTR_BLINK   0x00000800UL
#define ATTR_FGMASK  0x0000F000UL
#define ATTR_BGMASK  0x000F0000UL
#define ATTR_FGSHIFT 12
#define ATTR_BGSHIFT 16

#define ATTR_DEFAULT 0x00098000UL
#define ATTR_DEFFG   0x00008000UL
#define ATTR_DEFBG   0x00090000UL
#define ATTR_CUR_XOR 0x000BA000UL
#define ERASE_CHAR   (ATTR_DEFAULT | ' ')
#define ATTR_MASK    0xFFFFFF00UL
#define CHAR_MASK    0x000000FFUL

typedef HDC Context;
#define SEL_NL { 13, 10 }

GLOBAL int rows, cols, savelines;

GLOBAL int font_width, font_height;

#define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
			  inbuf[inbuf_head++] = (_C) ; } while(0)
#define INBUF_SIZE 2048
GLOBAL unsigned char inbuf[INBUF_SIZE];
GLOBAL int inbuf_head;

#define OUTBUF_SIZE 2048
#define OUTBUF_MASK (OUTBUF_SIZE-1)
GLOBAL unsigned char outbuf[OUTBUF_SIZE];
GLOBAL int outbuf_head, outbuf_reap;

GLOBAL int has_focus;

GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
GLOBAL int repeat_off, cr_lf_return;

GLOBAL int seen_key_event;
GLOBAL int seen_disp_event;

GLOBAL int session_closed;

GLOBAL char *logfile;

/*
 * I've just looked in the windows standard headr files for WM_USER, there
 * are hundreds of flags defined using the form WM_USER+123 so I've 
 * renumbered this NETEVENT value and the two in window.c
 */
#define WM_XUSER     (WM_USER + 0x2000)
#define WM_NETEVENT  (WM_XUSER + 5)

typedef enum {
    TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
    TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO
} Telnet_Special;

typedef enum {
    MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
} Mouse_Button;

typedef enum {
    MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
} Mouse_Action;

typedef enum {
    VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
} VT_Mode;

typedef struct {
    char *(*init) (HWND hwnd, char *host, int port, char **realhost);
    int (*msg) (WPARAM wParam, LPARAM lParam);
    void (*send) (char *buf, int len);
    void (*size) (void);
    void (*special) (Telnet_Special code);
} Backend;

GLOBAL Backend *back;

extern struct backend_list {
    int protocol;
    char *name;
    Backend *backend;
} backends[];

typedef struct {
    void (*send) (char *buf, int len);
} Ldisc;

GLOBAL Ldisc *ldisc;

typedef struct {
    /* Basic options */
    char host[512];
    int port;
    enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
    int close_on_exit;
    int warn_on_close;
    /* SSH options */
    int nopty;
    enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
    char keyfile[FILENAME_MAX];
    int try_tis_auth;
    /* Telnet options */
    char termtype[32];
    char termspeed[32];
    char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
    char username[32];
    int rfc_environ;
    /* Keyboard options */
    int bksp_is_delete;
    int rxvt_homeend;
    int funky_type;
    int app_cursor;
    int app_keypad;
    int nethack_keypad;
    int alt_f4;			       /* is it special? */
    int alt_space;		       /* is it special? */
    int ldisc_term;
    int scroll_on_key;
    /* Terminal options */
    int savelines;
    int dec_om;
    int wrap_mode;
    int lfhascr;
    int blink_cur;
    int beep;
    int scrollbar;
    int locksize;
    int bce;
    int blinktext;
    int win_name_always;
    int width, height;
    char font[64];
    int fontisbold;
    int fontheight;
    int fontcharset;
    /* Colour options */
    int try_palette;
    int bold_colour;
    unsigned char colours[22][3];
    /* Selection options */
    int mouse_is_xterm;
    short wordness[256];
    /* translations */
    VT_Mode vtmode;
    int xlat_enablekoiwin;
    int xlat_88592w1250;
    int xlat_capslockcyr;
} Config;

/*
 * You can compile with -DSSH_DEFAULT to have ssh by default.
 */
#ifndef SSH_DEFAULT
#define DEFAULT_PROTOCOL PROT_TELNET
#define DEFAULT_PORT 23
#else
#define DEFAULT_PROTOCOL PROT_SSH
#define DEFAULT_PORT 22
#endif

GLOBAL Config cfg;
GLOBAL int default_protocol;
GLOBAL int default_port;

struct RSAKey;			       /* be a little careful of scope */

/*
 * Exports from window.c.
 */
void request_resize (int, int, int);
void do_text (Context, int, int, char *, int, unsigned long, int);
void set_title (char *);
void set_icon (char *);
void set_sbar (int, int, int);
Context get_ctx(void);
void free_ctx (Context);
void palette_set (int, int, int, int);
void palette_reset (void);
void write_clip (void *, int);
void get_clip (void **, int *);
void optimised_move (int, int, int);
void fatalbox (char *, ...);
void beep (int);
#define OPTIMISE_IS_SCROLL 1

/*
 * Exports from noise.c.
 */
void noise_get_heavy(void (*func) (void *, int));
void noise_get_light(void (*func) (void *, int));
void noise_ultralight(DWORD data);
void random_save_seed(void);

/*
 * Exports from windlg.c.
 */
int do_config (void);
int do_reconfig (HWND);
void do_defaults (char *);
void logevent (char *);
void showeventlog (HWND);
void showabout (HWND);
void verify_ssh_host_key(char *host, char *keystr);
void get_sesslist(int allocate);

GLOBAL int nsessions;
GLOBAL char **sessions;

/*
 * Exports from terminal.c.
 */

void term_init (void);
void term_size (int, int, int);
void term_out (void);
void term_paint (Context, int, int, int, int);
void term_scroll (int, int);
void term_pwron (void);
void term_clrsb (void);
void term_mouse (Mouse_Button, Mouse_Action, int, int);
void term_deselect (void);
void term_update (void);
void term_invalidate(void);
void term_blink(int set_cursor);
void term_paste(void);
void term_nopaste(void);

/*
 * Exports from raw.c.
 */

extern Backend raw_backend;

/*
 * Exports from telnet.c.
 */

extern Backend telnet_backend;

/*
 * Exports from ssh.c.
 */

extern Backend ssh_backend;

/*
 * Exports from ldisc.c.
 */

extern Ldisc ldisc_term, ldisc_simple;

/*
 * Exports from sshrand.c.
 */

void random_add_noise(void *noise, int length);
void random_init(void);
int random_byte(void);
void random_get_savedata(void **data, int *len);

/*
 * Exports from misc.c.
 */

/* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
#ifdef MALLOC_LOG
#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
void mlog(char *, int);
#else
#define smalloc safemalloc
#define srealloc saferealloc
#define sfree safefree
#endif

void *safemalloc(size_t);
void *saferealloc(void *, size_t);
void safefree(void *);

/*
 * Exports from version.c.
 */
extern char ver[];

/*
 * Exports from sizetip.c.
 */
void UpdateSizeTip(HWND src, int cx, int cy);
void EnableSizeTip(int bEnable);

/*
 * Exports from xlat.c.
 */
unsigned char xlat_kbd2tty(unsigned char c);
unsigned char xlat_tty2scr(unsigned char c);
unsigned char xlat_latkbd2win(unsigned char c);

/*
 * Exports from mscrypto.c
 */
#ifdef MSCRYPTOAPI
int crypto_startup();
void crypto_wrapup();
#endif

/*
 * A debug system.
 */
#ifdef DEBUG
#include <stdarg.h>
#define debug(x) (dprintf x)
static void dprintf(char *fmt, ...) {
    char buf[2048];
    DWORD dw;
    va_list ap;
    static int gotconsole = 0;

    if (!gotconsole) {
	AllocConsole();
	gotconsole = 1;
    }

    va_start(ap, fmt);
    vsprintf(buf, fmt, ap);
    WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
    va_end(ap);
}
#else
#define debug(x)
#endif

#endif
Commit	Line	Data
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	17	GLOBAL HINSTANCE putty_inst;
73251d5d	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
	51	typedef HDC Context;
	52	#define SEL_NL { 13, 10 }
	53
	54	GLOBAL int rows, cols, savelines;
	55
	56	GLOBAL int font_width, font_height;
	57
c9def1b8	58	#define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
c9def1b8	59	inbuf[inbuf_head++] = (_C) ; } while(0)
374330e2	60	#define INBUF_SIZE 2048
374330e2	61	GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8	62	GLOBAL int inbuf_head;
374330e2	63
	64	#define OUTBUF_SIZE 2048
	65	#define OUTBUF_MASK (OUTBUF_SIZE-1)
	66	GLOBAL unsigned char outbuf[OUTBUF_SIZE];
	67	GLOBAL int outbuf_head, outbuf_reap;
	68
	69	GLOBAL int has_focus;
	70
c9def1b8	71	GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
c9def1b8	72	GLOBAL int repeat_off, cr_lf_return;
374330e2	73
cabfd08c	74	GLOBAL int seen_key_event;
	75	GLOBAL int seen_disp_event;
	76
d85548fe	77	GLOBAL int session_closed;
d85548fe	78
5fd04f07	79	GLOBAL char *logfile;
5fd04f07	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
	89	typedef 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
	94	typedef enum {
	95	MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
	96	} Mouse_Button;
	97
	98	typedef enum {
	99	MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
	100	} Mouse_Action;
	101
	102	typedef enum {
	103	VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
	104	} VT_Mode;
	105
	106	typedef 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);
	112	} Backend;
	113
	114	GLOBAL Backend *back;
	115
297d398b	116	extern struct backend_list {
89ee5268	117	int protocol;
	118	char *name;
	119	Backend *backend;
	120	} backends[];
	121
374330e2	122	typedef struct {
5bc238bb	123	void (send) (char buf, int len);
	124	} Ldisc;
	125
	126	GLOBAL Ldisc *ldisc;
	127
	128	typedef struct {
374330e2	129	/* Basic options */
	130	char host[512];
	131	int port;
5e1a8e27	132	enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2	133	int close_on_exit;
9ef49106	134	int warn_on_close;
fef97f43	135	/* SSH options */
fef97f43	136	int nopty;
9697bfd2	137	enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81	138	char keyfile[FILENAME_MAX];
ccbfb941	139	int try_tis_auth;
374330e2	140	/* Telnet options */
	141	char termtype[32];
	142	char termspeed[32];
37508af4	143	char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2	144	char username[32];
	145	int rfc_environ;
	146	/* Keyboard options */
	147	int bksp_is_delete;
	148	int rxvt_homeend;
c9def1b8	149	int funky_type;
374330e2	150	int app_cursor;
374330e2	151	int app_keypad;
c5e9c988	152	int nethack_keypad;
	153	int alt_f4; /* is it special? */
	154	int alt_space; /* is it special? */
5bc238bb	155	int ldisc_term;
c9def1b8	156	int scroll_on_key;
374330e2	157	/* Terminal options */
	158	int savelines;
	159	int dec_om;
	160	int wrap_mode;
fef97f43	161	int lfhascr;
c9def1b8	162	int blink_cur;
	163	int beep;
	164	int scrollbar;
	165	int locksize;
	166	int bce;
	167	int blinktext;
374330e2	168	int win_name_always;
	169	int width, height;
	170	char font[64];
	171	int fontisbold;
	172	int fontheight;
14963b8f	173	int fontcharset;
374330e2	174	/* Colour options */
	175	int try_palette;
	176	int bold_colour;
	177	unsigned char colours[22][3];
	178	/* Selection options */
	179	int mouse_is_xterm;
	180	short wordness[256];
c9def1b8	181	/* translations */
c9def1b8	182	VT_Mode vtmode;
14963b8f	183	int xlat_enablekoiwin;
d3d16feb	184	int xlat_88592w1250;
14963b8f	185	int xlat_capslockcyr;
374330e2	186	} Config;
374330e2	187
e277c42d	188	/*
	189	* You can compile with -DSSH_DEFAULT to have ssh by default.
	190	*/
	191	#ifndef SSH_DEFAULT
	192	#define DEFAULT_PROTOCOL PROT_TELNET
	193	#define DEFAULT_PORT 23
	194	#else
	195	#define DEFAULT_PROTOCOL PROT_SSH
	196	#define DEFAULT_PORT 22
	197	#endif
	198
374330e2	199	GLOBAL Config cfg;
e277c42d	200	GLOBAL int default_protocol;
e277c42d	201	GLOBAL int default_port;
374330e2	202
4e23b276	203	struct RSAKey; /* be a little careful of scope */
4e23b276	204
374330e2	205	/*
	206	* Exports from window.c.
	207	*/
e14a5a13	208	void request_resize (int, int, int);
c9def1b8	209	void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2	210	void set_title (char *);
	211	void set_icon (char *);
	212	void set_sbar (int, int, int);
f67b4e85	213	Context get_ctx(void);
374330e2	214	void free_ctx (Context);
	215	void palette_set (int, int, int, int);
	216	void palette_reset (void);
	217	void write_clip (void *, int);
	218	void get_clip (void *, int );
	219	void optimised_move (int, int, int);
	220	void fatalbox (char *, ...);
c9def1b8	221	void beep (int);
374330e2	222	#define OPTIMISE_IS_SCROLL 1
	223
	224	/*
	225	* Exports from noise.c.
	226	*/
	227	void noise_get_heavy(void (func) (void , int));
	228	void noise_get_light(void (func) (void , int));
	229	void noise_ultralight(DWORD data);
	230	void random_save_seed(void);
	231
	232	/*
	233	* Exports from windlg.c.
	234	*/
	235	int do_config (void);
	236	int do_reconfig (HWND);
	237	void do_defaults (char *);
c5e9c988	238	void logevent (char *);
c5e9c988	239	void showeventlog (HWND);
374330e2	240	void showabout (HWND);
89ee5268	241	void verify_ssh_host_key(char host, char keystr);
0a4aa984	242	void get_sesslist(int allocate);
0a4aa984	243
7393a137	244	GLOBAL int nsessions;
7393a137	245	GLOBAL char **sessions;
374330e2	246
	247	/*
	248	* Exports from terminal.c.
	249	*/
	250
	251	void term_init (void);
	252	void term_size (int, int, int);
	253	void term_out (void);
	254	void term_paint (Context, int, int, int, int);
	255	void term_scroll (int, int);
	256	void term_pwron (void);
	257	void term_clrsb (void);
	258	void term_mouse (Mouse_Button, Mouse_Action, int, int);
	259	void term_deselect (void);
	260	void term_update (void);
	261	void term_invalidate(void);
e14a5a13	262	void term_blink(int set_cursor);
c9def1b8	263	void term_paste(void);
c9def1b8	264	void term_nopaste(void);
374330e2	265
374330e2	266	/*
5e1a8e27	267	* Exports from raw.c.
	268	*/
	269
3d9a14c9	270	extern Backend raw_backend;
5e1a8e27	271
5e1a8e27	272	/*
374330e2	273	* Exports from telnet.c.
	274	*/
	275
c14776e8	276	extern Backend telnet_backend;
374330e2	277
	278	/*
	279	* Exports from ssh.c.
	280	*/
	281
c14776e8	282	extern Backend ssh_backend;
374330e2	283
374330e2	284	/*
5bc238bb	285	* Exports from ldisc.c.
	286	*/
	287
	288	extern Ldisc ldisc_term, ldisc_simple;
	289
	290	/*
374330e2	291	* Exports from sshrand.c.
	292	*/
	293
	294	void random_add_noise(void *noise, int length);
	295	void random_init(void);
	296	int random_byte(void);
	297	void random_get_savedata(void *data, int len);
	298
	299	/*
	300	* Exports from misc.c.
	301	*/
	302
	303	/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
	304	#ifdef MALLOC_LOG
	305	#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
	306	#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
	307	#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
	308	void mlog(char *, int);
	309	#else
	310	#define smalloc safemalloc
	311	#define srealloc saferealloc
	312	#define sfree safefree
	313	#endif
	314
	315	void *safemalloc(size_t);
	316	void saferealloc(void , size_t);
	317	void safefree(void *);
	318
	319	/*
067a15ea	320	* Exports from version.c.
	321	*/
	322	extern char ver[];
	323
	324	/*
b73fd1b1	325	* Exports from sizetip.c.
	326	*/
	327	void UpdateSizeTip(HWND src, int cx, int cy);
	328	void EnableSizeTip(int bEnable);
	329
	330	/*
14963b8f	331	* Exports from xlat.c.
	332	*/
	333	unsigned char xlat_kbd2tty(unsigned char c);
	334	unsigned char xlat_tty2scr(unsigned char c);
	335	unsigned char xlat_latkbd2win(unsigned char c);
	336
	337	/*
8f203108	338	* Exports from mscrypto.c
	339	*/
	340	#ifdef MSCRYPTOAPI
	341	int crypto_startup();
	342	void crypto_wrapup();
	343	#endif
	344
	345	/*
374330e2	346	* A debug system.
	347	*/
	348	#ifdef DEBUG
	349	#include <stdarg.h>
	350	#define debug(x) (dprintf x)
	351	static void dprintf(char *fmt, ...) {
	352	char buf[2048];
	353	DWORD dw;
	354	va_list ap;
	355	static int gotconsole = 0;
	356
	357	if (!gotconsole) {
	358	AllocConsole();
	359	gotconsole = 1;
	360	}
	361
	362	va_start(ap, fmt);
	363	vsprintf(buf, fmt, ap);
	364	WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
	365	va_end(ap);
	366	}
	367	#else
	368	#define debug(x)
	369	#endif
	370
	371	#endif