[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 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_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 INBUF_SIZE 2048
#define INBUF_MASK (INBUF_SIZE-1)
GLOBAL unsigned char inbuf[INBUF_SIZE];
GLOBAL int inbuf_head, inbuf_reap;

#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;

GLOBAL int seen_key_event;
GLOBAL int seen_disp_event;

typedef enum {
    US_NONE = 0, US_KEY = 1, US_DISP = 2, US_BOTH = 3
} Unscroll_Trigger;

GLOBAL Unscroll_Trigger unscroll_event;

#define WM_NETEVENT  (WM_USER + 1)

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
} 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;

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;
    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 linux_funkeys;
    int app_cursor;
    int app_keypad;
    int nethack_keypad;
    int alt_f4;			       /* is it special? */
    int alt_space;		       /* is it special? */
    int ldisc_term;
    /* Terminal options */
    int savelines;
    int dec_om;
    int wrap_mode;
    int lfhascr;
    int win_name_always;
    int width, height;
    char font[64];
    int fontisbold;
    int fontheight;
    int fontcharset;
    VT_Mode vtmode;
    /* Colour options */
    int try_palette;
    int bold_colour;
    unsigned char colours[22][3];
    /* Selection options */
    int mouse_is_xterm;
    short wordness[256];
    /* russian language translation */
    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);
void do_text (Context, int, int, char *, int, unsigned long);
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 (void);
#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, struct RSAKey *key);
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);

/*
 * 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);

/*
 * 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
	24	#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
	25	#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
	26	#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
	27
	28	#define ATTR_BOLD 0x00000100UL
	29	#define ATTR_UNDER 0x00000200UL
	30	#define ATTR_REVERSE 0x00000400UL
	31	#define ATTR_FGMASK 0x0000F000UL
	32	#define ATTR_BGMASK 0x000F0000UL
	33	#define ATTR_FGSHIFT 12
	34	#define ATTR_BGSHIFT 16
	35
	36	#define ATTR_DEFAULT 0x00098000UL
	37	#define ATTR_DEFFG 0x00008000UL
	38	#define ATTR_DEFBG 0x00090000UL
	39	#define ATTR_CUR_XOR 0x000BA000UL
	40	#define ERASE_CHAR (ATTR_DEFAULT \| ' ')
	41	#define ATTR_MASK 0xFFFFFF00UL
	42	#define CHAR_MASK 0x000000FFUL
	43
	44	typedef HDC Context;
	45	#define SEL_NL { 13, 10 }
	46
	47	GLOBAL int rows, cols, savelines;
	48
	49	GLOBAL int font_width, font_height;
	50
	51	#define INBUF_SIZE 2048
	52	#define INBUF_MASK (INBUF_SIZE-1)
	53	GLOBAL unsigned char inbuf[INBUF_SIZE];
	54	GLOBAL int inbuf_head, inbuf_reap;
	55
	56	#define OUTBUF_SIZE 2048
	57	#define OUTBUF_MASK (OUTBUF_SIZE-1)
	58	GLOBAL unsigned char outbuf[OUTBUF_SIZE];
	59	GLOBAL int outbuf_head, outbuf_reap;
	60
	61	GLOBAL int has_focus;
	62
	63	GLOBAL int app_cursor_keys, app_keypad_keys;
	64
cabfd08c	65	GLOBAL int seen_key_event;
	66	GLOBAL int seen_disp_event;
	67
	68	typedef enum {
	69	US_NONE = 0, US_KEY = 1, US_DISP = 2, US_BOTH = 3
	70	} Unscroll_Trigger;
	71
ceba7599	72	GLOBAL Unscroll_Trigger unscroll_event;
cabfd08c	73
374330e2	74	#define WM_NETEVENT (WM_USER + 1)
	75
	76	typedef enum {
	77	TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
	78	TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF
	79	} Telnet_Special;
	80
	81	typedef enum {
	82	MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
	83	} Mouse_Button;
	84
	85	typedef enum {
	86	MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
	87	} Mouse_Action;
	88
	89	typedef enum {
	90	VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
	91	} VT_Mode;
	92
	93	typedef struct {
	94	char (init) (HWND hwnd, char host, int port, char *realhost);
	95	int (*msg) (WPARAM wParam, LPARAM lParam);
	96	void (send) (char buf, int len);
	97	void (*size) (void);
	98	void (*special) (Telnet_Special code);
	99	} Backend;
	100
	101	GLOBAL Backend *back;
	102
	103	typedef struct {
5bc238bb	104	void (send) (char buf, int len);
	105	} Ldisc;
	106
	107	GLOBAL Ldisc *ldisc;
	108
	109	typedef struct {
374330e2	110	/* Basic options */
	111	char host[512];
	112	int port;
5e1a8e27	113	enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2	114	int close_on_exit;
9ef49106	115	int warn_on_close;
fef97f43	116	/* SSH options */
fef97f43	117	int nopty;
9697bfd2	118	enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
ccbfb941	119	int try_tis_auth;
374330e2	120	/* Telnet options */
	121	char termtype[32];
	122	char termspeed[32];
37508af4	123	char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2	124	char username[32];
	125	int rfc_environ;
	126	/* Keyboard options */
	127	int bksp_is_delete;
	128	int rxvt_homeend;
	129	int linux_funkeys;
	130	int app_cursor;
	131	int app_keypad;
c5e9c988	132	int nethack_keypad;
	133	int alt_f4; /* is it special? */
	134	int alt_space; /* is it special? */
5bc238bb	135	int ldisc_term;
374330e2	136	/* Terminal options */
	137	int savelines;
	138	int dec_om;
	139	int wrap_mode;
fef97f43	140	int lfhascr;
374330e2	141	int win_name_always;
	142	int width, height;
	143	char font[64];
	144	int fontisbold;
	145	int fontheight;
14963b8f	146	int fontcharset;
374330e2	147	VT_Mode vtmode;
	148	/* Colour options */
	149	int try_palette;
	150	int bold_colour;
	151	unsigned char colours[22][3];
	152	/* Selection options */
	153	int mouse_is_xterm;
	154	short wordness[256];
14963b8f	155	/* russian language translation */
14963b8f	156	int xlat_enablekoiwin;
d3d16feb	157	int xlat_88592w1250;
14963b8f	158	int xlat_capslockcyr;
374330e2	159	} Config;
374330e2	160
e277c42d	161	/*
	162	* You can compile with -DSSH_DEFAULT to have ssh by default.
	163	*/
	164	#ifndef SSH_DEFAULT
	165	#define DEFAULT_PROTOCOL PROT_TELNET
	166	#define DEFAULT_PORT 23
	167	#else
	168	#define DEFAULT_PROTOCOL PROT_SSH
	169	#define DEFAULT_PORT 22
	170	#endif
	171
374330e2	172	GLOBAL Config cfg;
e277c42d	173	GLOBAL int default_protocol;
e277c42d	174	GLOBAL int default_port;
374330e2	175
4e23b276	176	struct RSAKey; /* be a little careful of scope */
4e23b276	177
374330e2	178	/*
	179	* Exports from window.c.
	180	*/
	181	void request_resize (int, int);
	182	void do_text (Context, int, int, char *, int, unsigned long);
	183	void set_title (char *);
	184	void set_icon (char *);
	185	void set_sbar (int, int, int);
f67b4e85	186	Context get_ctx(void);
374330e2	187	void free_ctx (Context);
	188	void palette_set (int, int, int, int);
	189	void palette_reset (void);
	190	void write_clip (void *, int);
	191	void get_clip (void *, int );
	192	void optimised_move (int, int, int);
	193	void fatalbox (char *, ...);
	194	void beep (void);
	195	#define OPTIMISE_IS_SCROLL 1
	196
	197	/*
	198	* Exports from noise.c.
	199	*/
	200	void noise_get_heavy(void (func) (void , int));
	201	void noise_get_light(void (func) (void , int));
	202	void noise_ultralight(DWORD data);
	203	void random_save_seed(void);
	204
	205	/*
	206	* Exports from windlg.c.
	207	*/
	208	int do_config (void);
	209	int do_reconfig (HWND);
	210	void do_defaults (char *);
c5e9c988	211	void logevent (char *);
c5e9c988	212	void showeventlog (HWND);
374330e2	213	void showabout (HWND);
374330e2	214	void verify_ssh_host_key(char host, struct RSAKey key);
0a4aa984	215	void get_sesslist(int allocate);
0a4aa984	216
7393a137	217	GLOBAL int nsessions;
7393a137	218	GLOBAL char **sessions;
374330e2	219
	220	/*
	221	* Exports from terminal.c.
	222	*/
	223
	224	void term_init (void);
	225	void term_size (int, int, int);
	226	void term_out (void);
	227	void term_paint (Context, int, int, int, int);
	228	void term_scroll (int, int);
	229	void term_pwron (void);
	230	void term_clrsb (void);
	231	void term_mouse (Mouse_Button, Mouse_Action, int, int);
	232	void term_deselect (void);
	233	void term_update (void);
	234	void term_invalidate(void);
	235
	236	/*
5e1a8e27	237	* Exports from raw.c.
	238	*/
	239
3d9a14c9	240	extern Backend raw_backend;
5e1a8e27	241
5e1a8e27	242	/*
374330e2	243	* Exports from telnet.c.
	244	*/
	245
c14776e8	246	extern Backend telnet_backend;
374330e2	247
	248	/*
	249	* Exports from ssh.c.
	250	*/
	251
c14776e8	252	extern Backend ssh_backend;
374330e2	253
374330e2	254	/*
5bc238bb	255	* Exports from ldisc.c.
	256	*/
	257
	258	extern Ldisc ldisc_term, ldisc_simple;
	259
	260	/*
374330e2	261	* Exports from sshrand.c.
	262	*/
	263
	264	void random_add_noise(void *noise, int length);
	265	void random_init(void);
	266	int random_byte(void);
	267	void random_get_savedata(void *data, int len);
	268
	269	/*
	270	* Exports from misc.c.
	271	*/
	272
	273	/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
	274	#ifdef MALLOC_LOG
	275	#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
	276	#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
	277	#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
	278	void mlog(char *, int);
	279	#else
	280	#define smalloc safemalloc
	281	#define srealloc saferealloc
	282	#define sfree safefree
	283	#endif
	284
	285	void *safemalloc(size_t);
	286	void saferealloc(void , size_t);
	287	void safefree(void *);
	288
	289	/*
067a15ea	290	* Exports from version.c.
	291	*/
	292	extern char ver[];
	293
	294	/*
b73fd1b1	295	* Exports from sizetip.c.
	296	*/
	297	void UpdateSizeTip(HWND src, int cx, int cy);
	298	void EnableSizeTip(int bEnable);
	299
	300	/*
14963b8f	301	* Exports from xlat.c.
	302	*/
	303	unsigned char xlat_kbd2tty(unsigned char c);
	304	unsigned char xlat_tty2scr(unsigned char c);
	305	unsigned char xlat_latkbd2win(unsigned char c);
	306
	307	/*
374330e2	308	* A debug system.
	309	*/
	310	#ifdef DEBUG
	311	#include <stdarg.h>
	312	#define debug(x) (dprintf x)
	313	static void dprintf(char *fmt, ...) {
	314	char buf[2048];
	315	DWORD dw;
	316	va_list ap;
	317	static int gotconsole = 0;
	318
	319	if (!gotconsole) {
	320	AllocConsole();
	321	gotconsole = 1;
	322	}
	323
	324	va_start(ap, fmt);
	325	vsprintf(buf, fmt, ap);
	326	WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
	327	va_end(ap);
	328	}
	329	#else
	330	#define debug(x)
	331	#endif
	332
	333	#endif