X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/dda87a288bfdd67b3572a8f219c66382b1045782..6ac7f054182a91601c70c93b663c10149a766fb7:/putty.h diff --git a/putty.h b/putty.h index 5c5b1c18..a7f3f5b2 100644 --- a/putty.h +++ b/putty.h @@ -40,35 +40,36 @@ typedef struct terminal_tag Terminal; * 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 TATTR_ACTCURS 0x40000000UL /* active cursor (block) */ +#define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */ +#define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */ +#define TATTR_COMBINING 0x80000000UL /* combining characters */ #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 LATTR_WRAPPED2 0x20000000UL +#define LATTR_WIDE 0x00000001UL +#define LATTR_TOP 0x00000002UL +#define LATTR_BOT 0x00000003UL +#define LATTR_MODE 0x00000003UL +#define LATTR_WRAPPED 0x00000010UL +#define LATTR_WRAPPED2 0x00000020UL -#define ATTR_INVALID 0x03FF0000UL +#define ATTR_INVALID 0x03FFU /* Like Linux use the F000 page for direct to font. */ -#define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */ -#define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */ +#define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */ +#define CSET_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 CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */ +#define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */ +#define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */ +#define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */ +#define CSET_MASK 0xFFFFFF00UL /* Character set mask */ -#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800) -#define DIRECT_FONT(c) ((c&0xFE00)==0xF000) +#define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800) +#define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000) -#define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */ +#define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */ /* * UCSWIDE is a special value used in the terminal data to signify * the character cell containing the right-hand half of a CJK wide @@ -79,27 +80,24 @@ typedef struct terminal_tag Terminal; */ #define UCSWIDE 0xDFFF -#define ATTR_NARROW 0x80000000UL -#define ATTR_WIDE 0x40000000UL -#define ATTR_BOLD 0x04000000UL -#define ATTR_UNDER 0x08000000UL -#define ATTR_REVERSE 0x10000000UL -#define ATTR_BLINK 0x20000000UL -#define ATTR_FGMASK 0x001F0000UL -#define ATTR_BGMASK 0x03E00000UL -#define ATTR_COLOURS 0x03FF0000UL -#define ATTR_FGSHIFT 16 -#define ATTR_BGSHIFT 21 - -#define ATTR_DEFAULT 0x01280000UL /* bg 9, fg 8 */ -#define ATTR_DEFFG 0x00080000UL -#define ATTR_DEFBG 0x01200000UL -#define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ') -#define ATTR_MASK 0xFFFFFF00UL -#define CHAR_MASK 0x000000FFUL +#define ATTR_NARROW 0x8000U +#define ATTR_WIDE 0x4000U +#define ATTR_BOLD 0x0400U +#define ATTR_UNDER 0x0800U +#define ATTR_REVERSE 0x1000U +#define ATTR_BLINK 0x2000U +#define ATTR_FGMASK 0x001FU +#define ATTR_BGMASK 0x03E0U +#define ATTR_COLOURS 0x03FFU +#define ATTR_FGSHIFT 0 +#define ATTR_BGSHIFT 5 + +#define ATTR_DEFAULT 0x0128U /* bg 9, fg 8 */ +#define ATTR_DEFFG 0x0008U +#define ATTR_DEFBG 0x0120U #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS)) -#define ATTR_CUR_XOR 0x016A0000UL +#define ATTR_CUR_XOR 0x016AU struct sesslist { int nsessions; @@ -134,6 +132,11 @@ typedef enum { TS_EOL } Telnet_Special; +struct telnet_special { + const char *name; /* NULL==end, ""==separator */ + int code; +}; + typedef enum { MBT_NOTHING, MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */ @@ -219,7 +222,8 @@ enum { /* * Proxy types. */ - PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET + PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5, + PROXY_HTTP, PROXY_TELNET, PROXY_CMD }; enum { @@ -237,7 +241,7 @@ enum { enum { /* Bell settings (cfg.beep) */ - BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE + BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER }; enum { @@ -261,8 +265,10 @@ enum { }; struct backend_tag { - char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg, - char *host, int port, char **realhost, int nodelay); + const char *(*init) (void *frontend_handle, void **backend_handle, + Config *cfg, + char *host, int port, char **realhost, int nodelay, + int keepalive); void (*free) (void *handle); /* back->reconfig() passes in a replacement configuration. */ void (*reconfig) (void *handle, Config *cfg); @@ -272,6 +278,7 @@ struct backend_tag { int (*sendbuffer) (void *handle); void (*size) (void *handle, int width, int height); void (*special) (void *handle, Telnet_Special code); + const struct telnet_special *(*get_specials) (void *handle); Socket(*socket) (void *handle); int (*exitcode) (void *handle); int (*sendok) (void *handle); @@ -299,6 +306,12 @@ extern struct backend_list { extern const int be_default_protocol; /* + * Name of this particular application, for use in the config box + * and other pieces of text. + */ +extern const char *const appname; + +/* * IMPORTANT POLICY POINT: everything in this structure which wants * to be treated like an integer must be an actual, honest-to- * goodness `int'. No enum-typed variables. This is because parts @@ -315,6 +328,7 @@ struct config_tag { int warn_on_close; int ping_interval; /* in seconds */ int tcp_nodelay; + int tcp_keepalives; /* Proxy options */ char proxy_exclude_list[512]; int proxy_dns; @@ -322,10 +336,9 @@ struct config_tag { int proxy_type; char proxy_host[512]; int proxy_port; - char proxy_username[32]; - char proxy_password[32]; + char proxy_username[128]; + char proxy_password[128]; char proxy_telnet_command[512]; - int proxy_socks_version; /* SSH options */ char remote_cmd[512]; char remote_cmd2[512]; /* fallback if the first fails @@ -346,6 +359,7 @@ struct config_tag { int try_ki_auth; int ssh_subsys; /* run a subsystem rather than a command */ int ssh_subsys2; /* fallback to go with remote_cmd2 */ + int ssh_no_shell; /* avoid running a shell */ /* Telnet options */ char termtype[32]; char termspeed[32]; @@ -366,6 +380,7 @@ struct config_tag { int no_remote_wintitle; /* disable remote retitling */ int no_dbackspace; /* disable destructive backspace */ int no_remote_charset; /* disable remote charset config */ + int no_remote_qtitle; /* disable remote win title query */ int app_cursor; int app_keypad; int nethack_keypad; @@ -380,6 +395,7 @@ struct config_tag { int fullscreenonaltenter; int scroll_on_key; int scroll_on_disp; + int erase_to_scrollback; int compose_key; int ctrlaltkeys; char wintitle[256]; /* initial window title */ @@ -408,12 +424,17 @@ struct config_tag { Filename logfilename; int logtype; int logxfovr; + int logomitpass; + int logomitdata; int hide_mouseptr; int sunken_edge; int window_border; char answerback[256]; char printer[128]; + int arabicshaping; + int bidi; /* Colour options */ + int system_colour; int try_palette; int bold_colour; unsigned char colours[22][3]; @@ -427,6 +448,7 @@ struct config_tag { /* translations */ int vtmode; char line_codepage[128]; + int utf8_override; int xlat_capslockcyr; /* X11 forwarding */ int x11_forward; @@ -435,7 +457,18 @@ struct config_tag { /* 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 */ + /* + * The port forwarding string contains a number of + * NUL-terminated substrings, terminated in turn by an empty + * string (i.e. a second NUL immediately after the previous + * one). Each string can be of one of the following forms: + * + * [LR]localport\thost:port + * [LR]localaddr:localport\thost:port + * Dlocalport + * Dlocaladdr:localport + */ + char portfwd[1024]; /* SSH bug compatibility modes */ int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, @@ -444,6 +477,7 @@ struct config_tag { int stamp_utmp; int login_shell; int scrollbar_on_left; + int shadowbold; FontSpec boldfont; FontSpec widefont; FontSpec wideboldfont; @@ -467,6 +501,10 @@ struct config_tag { * These flags describe the type of _application_ - they wouldn't * vary between individual sessions - and so it's OK to have this * variable be GLOBAL. + * + * Note that additional flags may be defined in platform-specific + * headers. It's probably best if those ones start from 0x1000, to + * avoid collision. */ #define FLAG_VERBOSE 0x0001 #define FLAG_STDERR 0x0002 @@ -481,14 +519,19 @@ GLOBAL int flags; GLOBAL int default_protocol; GLOBAL int default_port; +/* + * This is set TRUE by cmdline.c iff a session is loaded with "-load". + */ +GLOBAL int loaded_session; + struct RSAKey; /* be a little careful of scope */ /* * Exports from window.c. */ void request_resize(void *frontend, int, int); -void do_text(Context, int, int, char *, int, unsigned long, int); -void do_cursor(Context, int, int, char *, int, unsigned long, int); +void do_text(Context, int, int, wchar_t *, int, unsigned long, int); +void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int); int char_width(Context ctx, int uc); #ifdef OPTIMISE_SCROLL void do_scroll(Context, int, int, int); @@ -518,6 +561,8 @@ void sys_cursor(void *frontend, int x, int y); void request_paste(void *frontend); void frontend_keypress(void *frontend); void ldisc_update(void *frontend, int echo, int edit); +void update_specials_menu(void *frontend); +int from_backend(void *frontend, int is_stderr, const char *data, int len); #define OPTIMISE_IS_SCROLL 1 void set_iconic(void *frontend, int iconic); @@ -545,7 +590,7 @@ void random_destroy_seed(void); /* * Exports from settings.c. */ -void save_settings(char *section, int do_host, Config * cfg); +char *save_settings(char *section, int do_host, Config * cfg); void save_open_settings(void *sesskey, int do_host, Config *cfg); void load_settings(char *section, int do_host, Config * cfg); void load_open_settings(void *sesskey, int do_host, Config *cfg); @@ -597,7 +642,7 @@ int term_ldisc(Terminal *, int option); void term_copyall(Terminal *); void term_reconfig(Terminal *, Config *); void term_seen_key_event(Terminal *); -int from_backend(void *, int is_stderr, const char *data, int len); +int term_data(Terminal *, int is_stderr, const char *data, int len); void term_provide_resize_fn(Terminal *term, void (*resize_fn)(void *, int, int), void *resize_ctx); @@ -612,10 +657,18 @@ void log_reconfig(void *logctx, Config *cfg); void logfopen(void *logctx); void logfclose(void *logctx); void logtraffic(void *logctx, unsigned char c, int logmode); -void log_eventlog(void *logctx, char *string); +void logflush(void *logctx); +void log_eventlog(void *logctx, const char *string); enum { PKT_INCOMING, PKT_OUTGOING }; +enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT }; +struct logblank_t { + int offset; + int len; + int type; +}; void log_packet(void *logctx, int direction, int type, - char *texttype, void *data, int len); + char *texttype, void *data, int len, + int n_blanks, const struct logblank_t *blanks); /* * Exports from testback.c @@ -703,8 +756,8 @@ int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, 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); +const char *cp_enumerate (int index); +const char *cp_name(int codepage); void get_unitab(int codepage, wchar_t * unitab, int ftype); /* @@ -722,9 +775,19 @@ void crypto_wrapup(); #endif /* - * Exports from pageantc.c + * Exports from pageantc.c. + * + * agent_query returns 1 for here's-a-response, and 0 for query-in- + * progress. In the latter case there will be a call to `callback' + * at some future point, passing callback_ctx as the first + * parameter and the actual reply data as the second and third. + * + * The response may be a NULL pointer (in either of the synchronous + * or asynchronous cases), which indicates failure to receive a + * response. */ -void agent_query(void *in, int inlen, void **out, int *outlen); +int agent_query(void *in, int inlen, void **out, int *outlen, + void (*callback)(void *, void *, int), void *callback_ctx); int agent_exists(void); /* @@ -737,7 +800,7 @@ int wc_unescape(char *output, const char *wildcard); /* * Exports from windlg.c */ -void logevent(void *frontend, char *); +void logevent(void *frontend, const char *); void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, char *keystr, char *fingerprint); void askcipher(void *frontend, char *ciphername, int cs); @@ -750,6 +813,7 @@ int askappend(void *frontend, Filename filename); extern int console_batch_mode; int console_get_line(const char *prompt, char *str, int maxlen, int is_pw); void console_provide_logctx(void *logctx); +int is_interactive(void); /* * Exports from printing.c. @@ -770,13 +834,32 @@ void printer_finish_job(printer_job *); */ int cmdline_process_param(char *, char *, int, Config *); void cmdline_run_saved(Config *); +void cmdline_cleanup(void); extern char *cmdline_password; #define TOOLTYPE_FILETRANSFER 1 +#define TOOLTYPE_NONNETWORK 2 extern int cmdline_tooltype; void cmdline_error(char *, ...); /* + * Exports from config.c. + */ +struct controlbox; +void setup_config_box(struct controlbox *b, struct sesslist *sesslist, + int midsession, int protocol); + +/* + * Exports from minibidi.c. + */ +typedef struct bidi_char { + wchar_t origwc, wc; + unsigned short index; +} bidi_char; +int do_bidi(bidi_char *line, int count); +int do_shape(bidi_char *line, bidi_char *to, int count); + +/* * X11 auth mechanisms we know about. */ enum { @@ -794,5 +877,7 @@ Filename filename_from_str(const char *string); const char *filename_to_str(const Filename *fn); int filename_equal(Filename f1, Filename f2); int filename_is_null(Filename fn); +char *get_username(void); /* return value needs freeing */ +char *get_random_data(int bytes); /* used in cmdgen.c */ #endif