[u/mdw/putty] / putty.h

#ifndef PUTTY_PUTTY_H
#define PUTTY_PUTTY_H

#include <stdio.h>		       /* for FILENAME_MAX */

/*
 * 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.
 */
#ifndef GLOBAL
#ifdef PUTTY_DO_GLOBALS
#define GLOBAL
#else
#define GLOBAL extern
#endif
#endif

typedef struct config_tag Config;

#include "puttyps.h"
#include "network.h"

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

/* Three attribute types: 
 * The ATTRs (normal attributes) are stored with the characters in the main
 * display arrays
 *
 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
 * with characters but not with normal attributes.
 *
 * The LATTRs (line attributes) conflict with no others and only have one
 * value per line. But on area clears the LATTR cells are set to the erase_char
 * (or DEFAULT_ATTR + 'E')
 *
 * ATTR_INVALID is an illegal colour combination.
 */

#define TATTR_ACTCURS 	    0x4UL      /* active cursor (block) */
#define TATTR_PASCURS 	    0x2UL      /* passive cursor (box) */
#define TATTR_RIGHTCURS	    0x1UL      /* cursor-on-RHS */

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

#define ATTR_INVALID 0x00FF0000UL

/* Like Linux use the F000 page for direct to font. */
#define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
#define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */

/* These are internal use overlapping with the UTF-16 surrogates */
#define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
#define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
#define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
#define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
#define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */

#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
#define DIRECT_FONT(c) ((c&0xFE00)==0xF000)

#define UCSERR	     (ATTR_LINEDRW|'a')	/* UCS Format error character. */
#define UCSWIDE	     0x303F

#define ATTR_NARROW  0x20000000UL
#define ATTR_WIDE    0x10000000UL
#define ATTR_BOLD    0x01000000UL
#define ATTR_UNDER   0x02000000UL
#define ATTR_REVERSE 0x04000000UL
#define ATTR_BLINK   0x08000000UL
#define ATTR_FGMASK  0x000F0000UL
#define ATTR_BGMASK  0x00F00000UL
#define ATTR_COLOURS 0x00FF0000UL
#define ATTR_FGSHIFT 16
#define ATTR_BGSHIFT 20

#define ATTR_DEFAULT 0x00980000UL
#define ATTR_DEFFG   0x00080000UL
#define ATTR_DEFBG   0x00900000UL
#define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
#define ATTR_MASK    0xFFFFFF00UL
#define CHAR_MASK    0x000000FFUL

#define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
#define ATTR_CUR_XOR 0x00BA0000UL

#define SEL_NL { 13, 10 }

GLOBAL int rows, cols, savelines;

GLOBAL int has_focus;

GLOBAL int in_vbell;
GLOBAL unsigned long vbell_startpoint;

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

GLOBAL int session_closed;

GLOBAL int big_cursor;

GLOBAL char *help_path;
GLOBAL int help_has_contents;

GLOBAL int utf;
GLOBAL int dbcs_screenfont;
GLOBAL int font_codepage;
GLOBAL int kbd_codepage;
GLOBAL int line_codepage;
GLOBAL wchar_t unitab_scoacs[256];
GLOBAL wchar_t unitab_line[256];
GLOBAL wchar_t unitab_font[256];
GLOBAL wchar_t unitab_xterm[256];
GLOBAL wchar_t unitab_oemcp[256];
GLOBAL unsigned char unitab_ctrl[256];
#define in_utf (utf || line_codepage==CP_UTF8)

#define LGXF_OVR  1		       /* existing logfile overwrite */
#define LGXF_APN  0		       /* existing logfile append */
#define LGXF_ASK -1		       /* existing logfile ask */
#define LGTYP_NONE  0		       /* logmode: no logging */
#define LGTYP_ASCII 1		       /* logmode: pure ascii */
#define LGTYP_DEBUG 2		       /* logmode: all chars of traffic */
#define LGTYP_PACKETS 3		       /* logmode: SSH data packets */
GLOBAL char *logfile;

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, TS_PING,
    TS_EOL
} Telnet_Special;

typedef enum {
    MBT_NOTHING,
    MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
    MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
    MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
} 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_UNICODE
} VT_Mode;

enum {
    /*
     * SSH ciphers (both SSH1 and SSH2)
     */
    CIPHER_WARN,		       /* pseudo 'cipher' */
    CIPHER_3DES,
    CIPHER_BLOWFISH,
    CIPHER_AES,			       /* (SSH 2 only) */
    CIPHER_DES,
    CIPHER_MAX			       /* no. ciphers (inc warn) */
};

enum {
    /*
     * Line discipline option states: off, on, up to the backend.
     */
    LD_YES, LD_NO, LD_BACKEND
};

enum {
    /*
     * Line discipline options which the backend might try to control.
     */
    LD_EDIT,			       /* local line editing */
    LD_ECHO			       /* local echo */
};

enum {
    /*
     * Close On Exit behaviours. (cfg.close_on_exit)
     */
    COE_NEVER,			       /* Never close the window */
    COE_NORMAL,			       /* Close window on "normal" (non-error) exits only */
    COE_ALWAYS			       /* Always close the window */
};

typedef struct {
    char *(*init) (char *host, int port, char **realhost, int nodelay);
    /* back->send() returns the current amount of buffered data. */
    int (*send) (char *buf, int len);
    /* back->sendbuffer() does the same thing but without attempting a send */
    int (*sendbuffer) (void);
    void (*size) (void);
    void (*special) (Telnet_Special code);
    Socket(*socket) (void);
    int (*exitcode) (void);
    int (*sendok) (void);
    int (*ldisc) (int);
    /*
     * back->unthrottle() tells the back end that the front end
     * buffer is clearing.
     */
    void (*unthrottle) (int);
    int default_port;
} Backend;

GLOBAL Backend *back;

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

struct config_tag {
    /* Basic options */
    char host[512];
    int port;
    enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
    int close_on_exit;
    int warn_on_close;
    int ping_interval;		       /* in seconds */
    int tcp_nodelay;
    /* Proxy options */
    char proxy_exclude_list[512];
    enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
    char proxy_host[512];
    int proxy_port;
    char proxy_username[32];
    char proxy_password[32];
    char proxy_telnet_command[512];
    int proxy_socks_version;
    /* SSH options */
    char remote_cmd[512];
    char remote_cmd2[512];	       /* fallback if the first fails
					* (used internally for scp) */
    char *remote_cmd_ptr;	       /* might point to a larger command
				        * but never for loading/saving */
    char *remote_cmd_ptr2;	       /* might point to a larger command
				        * but never for loading/saving */
    int nopty;
    int compression;
    int agentfwd;
    int change_username;	       /* allow username switching in SSH2 */
    int ssh_cipherlist[CIPHER_MAX];
    char keyfile[FILENAME_MAX];
    int sshprot;		       /* use v1 or v2 when both available */
    int ssh2_des_cbc;		       /* "des-cbc" nonstandard SSH2 cipher */
    int try_tis_auth;
    int try_ki_auth;
    int ssh_subsys;		       /* run a subsystem rather than a command */
    int ssh_subsys2;		       /* fallback to go with remote_cmd2 */
    /* Telnet options */
    char termtype[32];
    char termspeed[32];
    char environmt[1024];	       /* VAR\tvalue\0VAR\tvalue\0\0 */
    char username[100];
    char localusername[100];
    int rfc_environ;
    int passive_telnet;
    /* Keyboard options */
    int bksp_is_delete;
    int rxvt_homeend;
    int funky_type;
    int no_applic_c;		       /* totally disable app cursor keys */
    int no_applic_k;		       /* totally disable app keypad */
    int no_mouse_rep;		       /* totally disable mouse reporting */
    int no_remote_resize;	       /* disable remote resizing */
    int no_alt_screen;		       /* disable alternate screen */
    int no_remote_wintitle;	       /* disable remote retitling */
    int no_dbackspace;		       /* disable destructive backspace */
    int no_remote_charset;	       /* disable remote charset config */
    int app_cursor;
    int app_keypad;
    int nethack_keypad;
    int telnet_keyboard;
    int telnet_newline;
    int alt_f4;			       /* is it special? */
    int alt_space;		       /* is it special? */
    int alt_only;		       /* is it special? */
    int localecho;
    int localedit;
    int alwaysontop;
    int fullscreenonaltenter;
    int scroll_on_key;
    int scroll_on_disp;
    int compose_key;
    int ctrlaltkeys;
    char wintitle[256];		       /* initial window title */
    /* Terminal options */
    int savelines;
    int dec_om;
    int wrap_mode;
    int lfhascr;
    int cursor_type;		       /* 0=block 1=underline 2=vertical */
    int blink_cur;
    enum {
	BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
    } beep;
    enum {
	B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
    } beep_ind;
    int bellovl;		       /* bell overload protection active? */
    int bellovl_n;		       /* number of bells to cause overload */
    int bellovl_t;		       /* time interval for overload (seconds) */
    int bellovl_s;		       /* period of silence to re-enable bell (s) */
    char bell_wavefile[FILENAME_MAX];
    int scrollbar;
    int scrollbar_in_fullscreen;
    enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
    int bce;
    int blinktext;
    int win_name_always;
    int width, height;
    char font[64];
    int fontisbold;
    int fontheight;
    int fontcharset;
    char logfilename[FILENAME_MAX];
    int logtype;
    int logxfovr;
    int hide_mouseptr;
    int sunken_edge;
    int window_border;
    char answerback[256];
    char printer[128];
    /* Colour options */
    int try_palette;
    int bold_colour;
    unsigned char colours[22][3];
    /* Selection options */
    int mouse_is_xterm;
    int rect_select;
    int rawcnp;
    int rtf_paste;
    int mouse_override;
    short wordness[256];
    /* translations */
    VT_Mode vtmode;
    char line_codepage[128];
    int xlat_capslockcyr;
    /* X11 forwarding */
    int x11_forward;
    char x11_display[128];
    /* port forwarding */
    int lport_acceptall; /* accept conns from hosts other than localhost */
    int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
    char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
    /* SSH bug compatibility modes */
    enum {
	BUG_AUTO, BUG_OFF, BUG_ON
    } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
	sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
	sshbug_dhgex2;
};

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

/*
 * Some global flags denoting the type of application.
 * 
 * FLAG_VERBOSE is set when the user requests verbose details.
 * 
 * FLAG_STDERR is set in command-line applications (which have a
 * functioning stderr that it makes sense to write to) and not in
 * GUI applications (which don't).
 * 
 * FLAG_INTERACTIVE is set when a full interactive shell session is
 * being run, _either_ because no remote command has been provided
 * _or_ because the application is GUI and can't run non-
 * interactively.
 */
#define FLAG_VERBOSE     0x0001
#define FLAG_STDERR      0x0002
#define FLAG_INTERACTIVE 0x0004
GLOBAL int flags;

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, int);
void do_cursor(Context, int, int, char *, int, unsigned long, int);
int CharWidth(Context ctx, int uc);
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_aclip(char *, int, int);
void write_clip(wchar_t *, int, int);
void get_clip(wchar_t **, int *);
void optimised_move(int, int, int);
void set_raw_mouse_mode(int);
Mouse_Button translate_button(Mouse_Button b);
void connection_fatal(char *, ...);
void fatalbox(char *, ...);
void beep(int);
void begin_session(void);
void sys_cursor(int x, int y);
#define OPTIMISE_IS_SCROLL 1

void set_iconic(int iconic);
void move_window(int x, int y);
void set_zorder(int top);
void refresh_window(void);
void set_zoomed(int zoomed);
int is_iconic(void);
void get_window_pos(int *x, int *y);
void get_window_pixels(int *x, int *y);
char *get_window_title(int icon);

void cleanup_exit(int);

/*
 * Exports from noise.c.
 */
void noise_get_heavy(void (*func) (void *, int));
void noise_get_light(void (*func) (void *, int));
void noise_regular(void);
void noise_ultralight(unsigned long data);
void random_save_seed(void);
void random_destroy_seed(void);

/*
 * Exports from settings.c.
 */
void save_settings(char *section, int do_host, Config * cfg);
void load_settings(char *section, int do_host, Config * cfg);
void get_sesslist(int allocate);

/*
 * 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, int, int, int);
void term_deselect(void);
void term_update(void);
void term_invalidate(void);
void term_blink(int set_cursor);
void term_do_paste(void);
void term_paste(void);
void term_nopaste(void);
int term_ldisc(int option);
int from_backend(int is_stderr, char *data, int len);
void logfopen(void);
void logfclose(void);
void term_copyall(void);
void term_reconfig(void);

/*
 * Exports from logging.c.
 */
void logtraffic(unsigned char c, int logmode);
enum { PKT_INCOMING, PKT_OUTGOING };
void log_eventlog(char *string);
void log_packet(int direction, int type, char *texttype, void *data, int len);

/*
 * Exports from raw.c.
 */

extern Backend raw_backend;

/*
 * Exports from rlogin.c.
 */

extern Backend rlogin_backend;

/*
 * Exports from telnet.c.
 */

extern Backend telnet_backend;

/*
 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
 * so that PuTTYtel will still compile - otherwise it would depend
 * on ssh.c.)
 */

GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
			    int is_pw);
GLOBAL int ssh_getline_pw_only;
extern Backend ssh_backend;

/*
 * Exports from ldisc.c.
 */

extern void ldisc_send(char *buf, int len, int interactive);

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

/*
 * Exports from misc.c.
 */

#include "misc.h"

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

/*
 * Exports from unicode.c.
 */
#ifndef CP_UTF8
#define CP_UTF8 65001
#endif
void init_ucs_tables(void);
void lpage_send(int codepage, char *buf, int len, int interactive);
void luni_send(wchar_t * widebuf, int len, int interactive);
wchar_t xlat_uskbd2cyrllic(int ch);
int check_compose(int first, int second);
int decode_codepage(char *cp_name);
char *cp_enumerate (int index);
char *cp_name(int codepage);
void get_unitab(int codepage, wchar_t * unitab, int ftype);

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

/*
 * Exports from pageantc.c
 */
void agent_query(void *in, int inlen, void **out, int *outlen);
int agent_exists(void);

/*
 * Exports from wildcard.c
 */
const char *wc_error(int value);
int wc_match(const char *wildcard, const char *target);
int wc_unescape(char *output, const char *wildcard);

/*
 * Exports from console.c (that aren't equivalents to things in
 * windlg.c).
 */
extern int console_batch_mode;
int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);

/*
 * Exports from printing.c.
 */
typedef struct printer_enum_tag printer_enum;
typedef struct printer_job_tag printer_job;
printer_enum *printer_start_enum(int *nprinters);
char *printer_get_name(printer_enum *, int);
void printer_finish_enum(printer_enum *);
printer_job *printer_start_job(char *printer);
void printer_job_data(printer_job *, void *, int);
void printer_finish_job(printer_job *);

/*
 * Exports from cmdline.c (and also cmdline_error(), which is
 * defined differently in various places and required _by_
 * cmdline.c).
 */
int cmdline_process_param(char *, char *, int);
void cmdline_run_saved(void);
extern char *cmdline_password;
#define TOOLTYPE_FILETRANSFER 1
extern int cmdline_tooltype;

void cmdline_error(char *, ...);

#endif
Commit	Line	Data
374330e2	1	#ifndef PUTTY_PUTTY_H
	2	#define PUTTY_PUTTY_H
	3
ca20bfcf	4	#include <stdio.h> /* for FILENAME_MAX */
ca20bfcf	5
f7f27309	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	#ifndef GLOBAL
	12	#ifdef PUTTY_DO_GLOBALS
	13	#define GLOBAL
	14	#else
	15	#define GLOBAL extern
	16	#endif
	17	#endif
	18
	19	typedef struct config_tag Config;
8df7a775	20
f7f27309	21	#include "puttyps.h"
f7f27309	22	#include "network.h"
374330e2	23
	24	/*
	25	* Global variables. Most modules declare these `extern', but
	26	* window.c will do `#define PUTTY_DO_GLOBALS' before including this
	27	* module, and so will get them properly defined.
	28	*/
	29	#ifdef PUTTY_DO_GLOBALS
	30	#define GLOBAL
	31	#else
	32	#define GLOBAL extern
	33	#endif
	34
4eeb7d09	35	/* Three attribute types:
	36	* The ATTRs (normal attributes) are stored with the characters in the main
	37	* display arrays
	38	*
	39	* The TATTRs (temporary attributes) are generated on the fly, they can overlap
	40	* with characters but not with normal attributes.
	41	*
	42	* The LATTRs (line attributes) conflict with no others and only have one
	43	* value per line. But on area clears the LATTR cells are set to the erase_char
	44	* (or DEFAULT_ATTR + 'E')
	45	*
	46	* ATTR_INVALID is an illegal colour combination.
	47	*/
	48
	49	#define TATTR_ACTCURS 0x4UL /* active cursor (block) */
	50	#define TATTR_PASCURS 0x2UL /* passive cursor (box) */
	51	#define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
374330e2	52
c9def1b8	53	#define LATTR_NORM 0x00000000UL
	54	#define LATTR_WIDE 0x01000000UL
	55	#define LATTR_TOP 0x02000000UL
	56	#define LATTR_BOT 0x03000000UL
	57	#define LATTR_MODE 0x03000000UL
4eeb7d09	58	#define LATTR_WRAPPED 0x10000000UL
	59
	60	#define ATTR_INVALID 0x00FF0000UL
	61
	62	/* Like Linux use the F000 page for direct to font. */
	63	#define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
	64	#define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
	65
	66	/* These are internal use overlapping with the UTF-16 surrogates */
	67	#define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
	68	#define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
d3cb5465	69	#define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
4eeb7d09	70	#define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
	71	#define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
	72
	73	#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
	74	#define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
	75
	76	#define UCSERR (ATTR_LINEDRW\|'a') /* UCS Format error character. */
	77	#define UCSWIDE 0x303F
	78
5a73255e	79	#define ATTR_NARROW 0x20000000UL
4eeb7d09	80	#define ATTR_WIDE 0x10000000UL
	81	#define ATTR_BOLD 0x01000000UL
	82	#define ATTR_UNDER 0x02000000UL
	83	#define ATTR_REVERSE 0x04000000UL
	84	#define ATTR_BLINK 0x08000000UL
	85	#define ATTR_FGMASK 0x000F0000UL
	86	#define ATTR_BGMASK 0x00F00000UL
	87	#define ATTR_COLOURS 0x00FF0000UL
	88	#define ATTR_FGSHIFT 16
	89	#define ATTR_BGSHIFT 20
	90
	91	#define ATTR_DEFAULT 0x00980000UL
	92	#define ATTR_DEFFG 0x00080000UL
	93	#define ATTR_DEFBG 0x00900000UL
8f22582c	94	#define ERASE_CHAR (ATTR_DEFAULT \| ATTR_ASCII \| ' ')
374330e2	95	#define ATTR_MASK 0xFFFFFF00UL
374330e2	96	#define CHAR_MASK 0x000000FFUL
4eeb7d09	97
	98	#define ATTR_CUR_AND (~(ATTR_BOLD\|ATTR_REVERSE\|ATTR_BLINK\|ATTR_COLOURS))
	99	#define ATTR_CUR_XOR 0x00BA0000UL
374330e2	100
374330e2	101	#define SEL_NL { 13, 10 }
	102
	103	GLOBAL int rows, cols, savelines;
	104
374330e2	105	GLOBAL int has_focus;
374330e2	106
156686ef	107	GLOBAL int in_vbell;
286c6b86	108	GLOBAL unsigned long vbell_startpoint;
156686ef	109
c9def1b8	110	GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
c9def1b8	111	GLOBAL int repeat_off, cr_lf_return;
374330e2	112
cabfd08c	113	GLOBAL int seen_key_event;
cabfd08c	114	GLOBAL int seen_disp_event;
5a73255e	115	GLOBAL int alt_pressed;
cabfd08c	116
d85548fe	117	GLOBAL int session_closed;
d85548fe	118
4eeb7d09	119	GLOBAL int big_cursor;
4eeb7d09	120
70133c0e	121	GLOBAL char *help_path;
	122	GLOBAL int help_has_contents;
	123
4eeb7d09	124	GLOBAL int utf;
	125	GLOBAL int dbcs_screenfont;
	126	GLOBAL int font_codepage;
	127	GLOBAL int kbd_codepage;
	128	GLOBAL int line_codepage;
f7f27309	129	GLOBAL wchar_t unitab_scoacs[256];
	130	GLOBAL wchar_t unitab_line[256];
	131	GLOBAL wchar_t unitab_font[256];
	132	GLOBAL wchar_t unitab_xterm[256];
	133	GLOBAL wchar_t unitab_oemcp[256];
4eeb7d09	134	GLOBAL unsigned char unitab_ctrl[256];
8f22582c	135	#define in_utf (utf \|\| line_codepage==CP_UTF8)
4eeb7d09	136
32874aea	137	#define LGXF_OVR 1 /* existing logfile overwrite */
	138	#define LGXF_APN 0 /* existing logfile append */
	139	#define LGXF_ASK -1 /* existing logfile ask */
	140	#define LGTYP_NONE 0 /* logmode: no logging */
	141	#define LGTYP_ASCII 1 /* logmode: pure ascii */
00db133f	142	#define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
00db133f	143	#define LGTYP_PACKETS 3 /* logmode: SSH data packets */
5fd04f07	144	GLOBAL char *logfile;
5fd04f07	145
374330e2	146	typedef enum {
374330e2	147	TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
a5f3e637	148	TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
a5f3e637	149	TS_EOL
374330e2	150	} Telnet_Special;
	151
	152	typedef enum {
01c034ad	153	MBT_NOTHING,
	154	MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
	155	MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
	156	MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
374330e2	157	} Mouse_Button;
	158
	159	typedef enum {
	160	MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
	161	} Mouse_Action;
	162
	163	typedef enum {
4eeb7d09	164	VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
374330e2	165	} VT_Mode;
374330e2	166
0965bee0	167	enum {
0965bee0	168	/*
ca20bfcf	169	* SSH ciphers (both SSH1 and SSH2)
	170	*/
	171	CIPHER_WARN, /* pseudo 'cipher' */
	172	CIPHER_3DES,
	173	CIPHER_BLOWFISH,
	174	CIPHER_AES, /* (SSH 2 only) */
7f1ae1d2	175	CIPHER_DES,
ca20bfcf	176	CIPHER_MAX /* no. ciphers (inc warn) */
	177	};
	178
	179	enum {
	180	/*
0965bee0	181	* Line discipline option states: off, on, up to the backend.
	182	*/
	183	LD_YES, LD_NO, LD_BACKEND
	184	};
	185
	186	enum {
	187	/*
	188	* Line discipline options which the backend might try to control.
	189	*/
32874aea	190	LD_EDIT, /* local line editing */
32874aea	191	LD_ECHO /* local echo */
0965bee0	192	};
0965bee0	193
b41069ff	194	enum {
	195	/*
	196	* Close On Exit behaviours. (cfg.close_on_exit)
	197	*/
32874aea	198	COE_NEVER, /* Never close the window */
	199	COE_NORMAL, /* Close window on "normal" (non-error) exits only */
	200	COE_ALWAYS /* Always close the window */
b41069ff	201	};
b41069ff	202
374330e2	203	typedef struct {
2184a5d9	204	char (init) (char host, int port, char *realhost, int nodelay);
5471d09a	205	/* back->send() returns the current amount of buffered data. */
	206	int (send) (char buf, int len);
	207	/* back->sendbuffer() does the same thing but without attempting a send */
	208	int (*sendbuffer) (void);
374330e2	209	void (*size) (void);
374330e2	210	void (*special) (Telnet_Special code);
5471d09a	211	Socket(*socket) (void);
d8d6c7e5	212	int (*exitcode) (void);
8ccc75b0	213	int (*sendok) (void);
0965bee0	214	int (*ldisc) (int);
5471d09a	215	/*
	216	* back->unthrottle() tells the back end that the front end
	217	* buffer is clearing.
	218	*/
	219	void (*unthrottle) (int);
97db3be4	220	int default_port;
374330e2	221	} Backend;
	222
	223	GLOBAL Backend *back;
	224
297d398b	225	extern struct backend_list {
89ee5268	226	int protocol;
	227	char *name;
	228	Backend *backend;
	229	} backends[];
	230
f7f27309	231	struct config_tag {
374330e2	232	/* Basic options */
	233	char host[512];
	234	int port;
c91409da	235	enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2	236	int close_on_exit;
9ef49106	237	int warn_on_close;
32874aea	238	int ping_interval; /* in seconds */
2184a5d9	239	int tcp_nodelay;
8eebd221	240	/* Proxy options */
	241	char proxy_exclude_list[512];
	242	enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
	243	char proxy_host[512];
	244	int proxy_port;
	245	char proxy_username[32];
	246	char proxy_password[32];
	247	char proxy_telnet_command[512];
	248	int proxy_socks_version;
fef97f43	249	/* SSH options */
6abbf9e3	250	char remote_cmd[512];
fd5e5847	251	char remote_cmd2[512]; /* fallback if the first fails
fd5e5847	252	* (used internally for scp) */
32874aea	253	char remote_cmd_ptr; / might point to a larger command
32874aea	254	* but never for loading/saving */
fd5e5847	255	char remote_cmd_ptr2; / might point to a larger command
fd5e5847	256	* but never for loading/saving */
fef97f43	257	int nopty;
4ba9b64b	258	int compression;
979310f1	259	int agentfwd;
5bb641e1	260	int change_username; /* allow username switching in SSH2 */
ca20bfcf	261	int ssh_cipherlist[CIPHER_MAX];
7cca0d81	262	char keyfile[FILENAME_MAX];
32874aea	263	int sshprot; /* use v1 or v2 when both available */
cb4d4768	264	int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
ccbfb941	265	int try_tis_auth;
f091e308	266	int try_ki_auth;
4a8fc3c4	267	int ssh_subsys; /* run a subsystem rather than a command */
fd5e5847	268	int ssh_subsys2; /* fallback to go with remote_cmd2 */
374330e2	269	/* Telnet options */
	270	char termtype[32];
	271	char termspeed[32];
32874aea	272	char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
277fc55e	273	char username[100];
277fc55e	274	char localusername[100];
374330e2	275	int rfc_environ;
8faa456c	276	int passive_telnet;
374330e2	277	/* Keyboard options */
	278	int bksp_is_delete;
	279	int rxvt_homeend;
c9def1b8	280	int funky_type;
32874aea	281	int no_applic_c; /* totally disable app cursor keys */
32874aea	282	int no_applic_k; /* totally disable app keypad */
c0d36a72	283	int no_mouse_rep; /* totally disable mouse reporting */
0d2086c5	284	int no_remote_resize; /* disable remote resizing */
	285	int no_alt_screen; /* disable alternate screen */
	286	int no_remote_wintitle; /* disable remote retitling */
	287	int no_dbackspace; /* disable destructive backspace */
	288	int no_remote_charset; /* disable remote charset config */
374330e2	289	int app_cursor;
374330e2	290	int app_keypad;
c5e9c988	291	int nethack_keypad;
a5f3e637	292	int telnet_keyboard;
eee63b77	293	int telnet_newline;
c5e9c988	294	int alt_f4; /* is it special? */
c5e9c988	295	int alt_space; /* is it special? */
a094ae43	296	int alt_only; /* is it special? */
0965bee0	297	int localecho;
0965bee0	298	int localedit;
e95edc00	299	int alwaysontop;
8f57d753	300	int fullscreenonaltenter;
c9def1b8	301	int scroll_on_key;
a094ae43	302	int scroll_on_disp;
a094ae43	303	int compose_key;
95bbe1ae	304	int ctrlaltkeys;
32874aea	305	char wintitle[256]; /* initial window title */
374330e2	306	/* Terminal options */
	307	int savelines;
	308	int dec_om;
	309	int wrap_mode;
fef97f43	310	int lfhascr;
4e30ff69	311	int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8	312	int blink_cur;
03169ad0	313	enum {
	314	BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
	315	} beep;
f8a28d1f	316	enum {
	317	B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
	318	} beep_ind;
156686ef	319	int bellovl; /* bell overload protection active? */
	320	int bellovl_n; /* number of bells to cause overload */
	321	int bellovl_t; /* time interval for overload (seconds) */
	322	int bellovl_s; /* period of silence to re-enable bell (s) */
03169ad0	323	char bell_wavefile[FILENAME_MAX];
c9def1b8	324	int scrollbar;
a401e5f3	325	int scrollbar_in_fullscreen;
0ed2f48e	326	enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
c9def1b8	327	int bce;
c9def1b8	328	int blinktext;
374330e2	329	int win_name_always;
	330	int width, height;
	331	char font[64];
	332	int fontisbold;
	333	int fontheight;
14963b8f	334	int fontcharset;
e1c8e0ed	335	char logfilename[FILENAME_MAX];
e1c8e0ed	336	int logtype;
9f89f96e	337	int logxfovr;
554c540d	338	int hide_mouseptr;
57d08f2f	339	int sunken_edge;
5a73255e	340	int window_border;
e7fbcdd8	341	char answerback[256];
b44b307a	342	char printer[128];
374330e2	343	/* Colour options */
	344	int try_palette;
	345	int bold_colour;
	346	unsigned char colours[22][3];
	347	/* Selection options */
	348	int mouse_is_xterm;
6908fed7	349	int rect_select;
d3a22f79	350	int rawcnp;
a7419ea4	351	int rtf_paste;
b90840c3	352	int mouse_override;
374330e2	353	short wordness[256];
c9def1b8	354	/* translations */
c9def1b8	355	VT_Mode vtmode;
8bb92a1c	356	char line_codepage[128];
a9c02454	357	int xlat_capslockcyr;
9c964e85	358	/* X11 forwarding */
	359	int x11_forward;
	360	char x11_display[128];
d74d141c	361	/* port forwarding */
beefa433	362	int lport_acceptall; /* accept conns from hosts other than localhost */
beefa433	363	int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
d74d141c	364	char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
2c9c6388	365	/* SSH bug compatibility modes */
	366	enum {
	367	BUG_AUTO, BUG_OFF, BUG_ON
	368	} sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
8e975795	369	sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
8e975795	370	sshbug_dhgex2;
f7f27309	371	};
374330e2	372
e277c42d	373	/*
	374	* You can compile with -DSSH_DEFAULT to have ssh by default.
	375	*/
	376	#ifndef SSH_DEFAULT
	377	#define DEFAULT_PROTOCOL PROT_TELNET
	378	#define DEFAULT_PORT 23
	379	#else
	380	#define DEFAULT_PROTOCOL PROT_SSH
	381	#define DEFAULT_PORT 22
	382	#endif
	383
4017be6d	384	/*
4017be6d	385	* Some global flags denoting the type of application.
67779be7	386	*
	387	* FLAG_VERBOSE is set when the user requests verbose details.
	388	*
	389	* FLAG_STDERR is set in command-line applications (which have a
	390	* functioning stderr that it makes sense to write to) and not in
	391	* GUI applications (which don't).
	392	*
	393	* FLAG_INTERACTIVE is set when a full interactive shell session is
	394	* being run, _either_ because no remote command has been provided
	395	* _or_ because the application is GUI and can't run non-
	396	* interactively.
4017be6d	397	*/
67779be7	398	#define FLAG_VERBOSE 0x0001
	399	#define FLAG_STDERR 0x0002
	400	#define FLAG_INTERACTIVE 0x0004
4017be6d	401	GLOBAL int flags;
4017be6d	402
374330e2	403	GLOBAL Config cfg;
e277c42d	404	GLOBAL int default_protocol;
e277c42d	405	GLOBAL int default_port;
374330e2	406
4e23b276	407	struct RSAKey; /* be a little careful of scope */
4e23b276	408
374330e2	409	/*
	410	* Exports from window.c.
	411	*/
5a73255e	412	void request_resize(int, int);
32874aea	413	void do_text(Context, int, int, char *, int, unsigned long, int);
4eeb7d09	414	void do_cursor(Context, int, int, char *, int, unsigned long, int);
5a73255e	415	int CharWidth(Context ctx, int uc);
32874aea	416	void set_title(char *);
	417	void set_icon(char *);
	418	void set_sbar(int, int, int);
f67b4e85	419	Context get_ctx(void);
32874aea	420	void free_ctx(Context);
	421	void palette_set(int, int, int, int);
	422	void palette_reset(void);
4eeb7d09	423	void write_aclip(char *, int, int);
	424	void write_clip(wchar_t *, int, int);
	425	void get_clip(wchar_t *, int );
32874aea	426	void optimised_move(int, int, int);
01c034ad	427	void set_raw_mouse_mode(int);
01c034ad	428	Mouse_Button translate_button(Mouse_Button b);
8d5de777	429	void connection_fatal(char *, ...);
32874aea	430	void fatalbox(char *, ...);
32874aea	431	void beep(int);
6f34e365	432	void begin_session(void);
ec8679e9	433	void sys_cursor(int x, int y);
374330e2	434	#define OPTIMISE_IS_SCROLL 1
374330e2	435
68f9b3d9	436	void set_iconic(int iconic);
	437	void move_window(int x, int y);
	438	void set_zorder(int top);
	439	void refresh_window(void);
	440	void set_zoomed(int zoomed);
	441	int is_iconic(void);
	442	void get_window_pos(int x, int y);
	443	void get_window_pixels(int x, int y);
	444	char *get_window_title(int icon);
	445
93b581bd	446	void cleanup_exit(int);
93b581bd	447
374330e2	448	/*
	449	* Exports from noise.c.
	450	*/
32874aea	451	void noise_get_heavy(void (func) (void , int));
32874aea	452	void noise_get_light(void (func) (void , int));
7d6ee6ff	453	void noise_regular(void);
f7f27309	454	void noise_ultralight(unsigned long data);
374330e2	455	void random_save_seed(void);
de3df031	456	void random_destroy_seed(void);
374330e2	457
374330e2	458	/*
a9422f39	459	* Exports from settings.c.
a9422f39	460	*/
32874aea	461	void save_settings(char section, int do_host, Config cfg);
32874aea	462	void load_settings(char section, int do_host, Config cfg);
a9422f39	463	void get_sesslist(int allocate);
	464
	465	/*
374330e2	466	* Exports from terminal.c.
	467	*/
	468
32874aea	469	void term_init(void);
	470	void term_size(int, int, int);
	471	void term_out(void);
	472	void term_paint(Context, int, int, int, int);
	473	void term_scroll(int, int);
	474	void term_pwron(void);
	475	void term_clrsb(void);
6908fed7	476	void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
32874aea	477	void term_deselect(void);
32874aea	478	void term_update(void);
374330e2	479	void term_invalidate(void);
e14a5a13	480	void term_blink(int set_cursor);
568dd02f	481	void term_do_paste(void);
c9def1b8	482	void term_paste(void);
c9def1b8	483	void term_nopaste(void);
feb7fdfe	484	int term_ldisc(int option);
5471d09a	485	int from_backend(int is_stderr, char *data, int len);
32874aea	486	void logfopen(void);
32874aea	487	void logfclose(void);
bc1235d4	488	void term_copyall(void);
0d2086c5	489	void term_reconfig(void);
374330e2	490
374330e2	491	/*
00db133f	492	* Exports from logging.c.
	493	*/
	494	void logtraffic(unsigned char c, int logmode);
	495	enum { PKT_INCOMING, PKT_OUTGOING };
fb89f7ff	496	void log_eventlog(char *string);
00db133f	497	void log_packet(int direction, int type, char texttype, void data, int len);
	498
	499	/*
5e1a8e27	500	* Exports from raw.c.
	501	*/
	502
3d9a14c9	503	extern Backend raw_backend;
5e1a8e27	504
5e1a8e27	505	/*
c91409da	506	* Exports from rlogin.c.
	507	*/
	508
	509	extern Backend rlogin_backend;
	510
	511	/*
374330e2	512	* Exports from telnet.c.
	513	*/
	514
c14776e8	515	extern Backend telnet_backend;
374330e2	516
374330e2	517	/*
c0a81592	518	* Exports from ssh.c. (NB the getline variables have to be GLOBAL
	519	* so that PuTTYtel will still compile - otherwise it would depend
	520	* on ssh.c.)
374330e2	521	*/
374330e2	522
c0a81592	523	GLOBAL int (ssh_get_line) (const char prompt, char *str, int maxlen,
32874aea	524	int is_pw);
c0a81592	525	GLOBAL int ssh_getline_pw_only;
c14776e8	526	extern Backend ssh_backend;
374330e2	527
374330e2	528	/*
5bc238bb	529	* Exports from ldisc.c.
	530	*/
	531
760e88b2	532	extern void ldisc_send(char *buf, int len, int interactive);
5bc238bb	533
5bc238bb	534	/*
374330e2	535	* Exports from sshrand.c.
	536	*/
	537
	538	void random_add_noise(void *noise, int length);
	539	void random_init(void);
	540	int random_byte(void);
	541	void random_get_savedata(void *data, int len);
93b581bd	542	extern int random_active;
374330e2	543
	544	/*
	545	* Exports from misc.c.
	546	*/
	547
db9c0f86	548	#include "misc.h"
374330e2	549
374330e2	550	/*
067a15ea	551	* Exports from version.c.
	552	*/
	553	extern char ver[];
	554
	555	/*
4eeb7d09	556	* Exports from unicode.c.
14963b8f	557	*/
4eeb7d09	558	#ifndef CP_UTF8
	559	#define CP_UTF8 65001
	560	#endif
	561	void init_ucs_tables(void);
760e88b2	562	void lpage_send(int codepage, char *buf, int len, int interactive);
760e88b2	563	void luni_send(wchar_t * widebuf, int len, int interactive);
a9c02454	564	wchar_t xlat_uskbd2cyrllic(int ch);
4eeb7d09	565	int check_compose(int first, int second);
4eeb7d09	566	int decode_codepage(char *cp_name);
875b193f	567	char *cp_enumerate (int index);
4eeb7d09	568	char *cp_name(int codepage);
a7419ea4	569	void get_unitab(int codepage, wchar_t * unitab, int ftype);
14963b8f	570
14963b8f	571	/*
8f203108	572	* Exports from mscrypto.c
	573	*/
	574	#ifdef MSCRYPTOAPI
	575	int crypto_startup();
	576	void crypto_wrapup();
	577	#endif
	578
	579	/*
5c58ad2d	580	* Exports from pageantc.c
	581	*/
	582	void agent_query(void in, int inlen, void out, int outlen);
	583	int agent_exists(void);
	584
4eb24e3a	585	/*
	586	* Exports from wildcard.c
	587	*/
	588	const char *wc_error(int value);
	589	int wc_match(const char wildcard, const char target);
	590	int wc_unescape(char output, const char wildcard);
374330e2	591
ff2ae367	592	/*
	593	* Exports from console.c (that aren't equivalents to things in
	594	* windlg.c).
	595	*/
	596	extern int console_batch_mode;
ff2ae367	597	int console_get_line(const char prompt, char str, int maxlen, int is_pw);
ff2ae367	598
b44b307a	599	/*
	600	* Exports from printing.c.
	601	*/
	602	typedef struct printer_enum_tag printer_enum;
	603	typedef struct printer_job_tag printer_job;
	604	printer_enum printer_start_enum(int nprinters);
	605	char printer_get_name(printer_enum , int);
	606	void printer_finish_enum(printer_enum *);
	607	printer_job printer_start_job(char printer);
	608	void printer_job_data(printer_job , void , int);
	609	void printer_finish_job(printer_job *);
	610
c0a81592	611	/*
	612	* Exports from cmdline.c (and also cmdline_error(), which is
	613	* defined differently in various places and required _by_
	614	* cmdline.c).
	615	*/
	616	int cmdline_process_param(char , char , int);
	617	void cmdline_run_saved(void);
	618	extern char *cmdline_password;
	619	#define TOOLTYPE_FILETRANSFER 1
	620	extern int cmdline_tooltype;
	621
	622	void cmdline_error(char *, ...);
	623
374330e2	624	#endif