X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/ab2c86b9e339e4c0a7d824b1f7ec4efcce985d79..5ecd7ad009cc5148c67b9d665f79a64083fae254:/putty.h diff --git a/putty.h b/putty.h index 3594ceb3..ad845afe 100644 --- a/putty.h +++ b/putty.h @@ -2,6 +2,7 @@ #define PUTTY_PUTTY_H #include /* for FILENAME_MAX */ +#include /* for wchar_t */ /* * Global variables. Most modules declare these `extern', but @@ -16,24 +17,16 @@ #endif #endif +#ifndef DONE_TYPEDEFS +#define DONE_TYPEDEFS typedef struct config_tag Config; typedef struct backend_tag Backend; typedef struct terminal_tag Terminal; +#endif #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 @@ -58,6 +51,7 @@ typedef struct terminal_tag Terminal; #define LATTR_BOT 0x03000000UL #define LATTR_MODE 0x03000000UL #define LATTR_WRAPPED 0x10000000UL +#define LATTR_WRAPPED2 0x20000000UL #define ATTR_INVALID 0x00FF0000UL @@ -76,7 +70,15 @@ typedef struct terminal_tag Terminal; #define DIRECT_FONT(c) ((c&0xFE00)==0xF000) #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */ -#define UCSWIDE 0x303F +/* + * UCSWIDE is a special value used in the terminal data to signify + * the character cell containing the right-hand half of a CJK wide + * character. We use 0xDFFF because it's part of the surrogate + * range and hence won't be used for anything else (it's impossible + * to input it via UTF-8 because our UTF-8 decoder correctly + * rejects surrogates). + */ +#define UCSWIDE 0xDFFF #define ATTR_NARROW 0x20000000UL #define ATTR_WIDE 0x10000000UL @@ -100,27 +102,24 @@ typedef struct terminal_tag Terminal; #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS)) #define ATTR_CUR_XOR 0x00BA0000UL -GLOBAL int alt_pressed; - -GLOBAL int session_closed; - -GLOBAL char *help_path; -GLOBAL int help_has_contents; - -GLOBAL int nsessions; -GLOBAL char **sessions; +struct sesslist { + int nsessions; + char **sessions; + char *buffer; /* so memory can be freed later */ +}; -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]; +struct unicode_data { + char **uni_tbl; + int dbcs_screenfont; + int font_codepage; + int line_codepage; + wchar_t unitab_scoacs[256]; + wchar_t unitab_line[256]; + wchar_t unitab_font[256]; + wchar_t unitab_xterm[256]; + wchar_t unitab_oemcp[256]; + unsigned char unitab_ctrl[256]; +}; #define LGXF_OVR 1 /* existing logfile overwrite */ #define LGXF_APN 0 /* existing logfile append */ @@ -147,9 +146,50 @@ typedef enum { MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE } Mouse_Action; +/* Keyboard modifiers -- keys the user is actually holding down */ + +#define PKM_SHIFT 0x01 +#define PKM_CONTROL 0x02 +#define PKM_META 0x04 +#define PKM_ALT 0x08 + +/* Keyboard flags that aren't really modifiers */ +#define PKF_CAPSLOCK 0x10 +#define PKF_NUMLOCK 0x20 +#define PKF_REPEAT 0x40 + +/* Stand-alone keysyms for function keys */ + typedef enum { + PK_NULL, /* No symbol for this key */ + /* Main keypad keys */ + PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE, + /* Editing keys */ + PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN, + /* Cursor keys */ + PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST, + /* Numeric keypad */ /* Real one looks like: */ + PK_PF1, PK_PF2, PK_PF3, PK_PF4, /* PF1 PF2 PF3 PF4 */ + PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL, /* 7 8 9 - */ + PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4, /* 4 5 6 , */ + PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9, /* 1 2 3 en- */ + PK_KPBIGPLUS, PK_KPENTER, /* 0 . ter */ + /* Top row */ + PK_F1, PK_F2, PK_F3, PK_F4, PK_F5, + PK_F6, PK_F7, PK_F8, PK_F9, PK_F10, + PK_F11, PK_F12, PK_F13, PK_F14, PK_F15, + PK_F16, PK_F17, PK_F18, PK_F19, PK_F20, + PK_PAUSE +} Key_Sym; + +#define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN) +#define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST) +#define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER) +#define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20) + +enum { VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE -} VT_Mode; +}; enum { /* @@ -165,9 +205,22 @@ enum { enum { /* - * Line discipline option states: off, on, up to the backend. + * Several different bits of the PuTTY configuration seem to be + * three-way settings whose values are `always yes', `always + * no', and `decide by some more complex automated means'. This + * is true of line discipline options (local echo and line + * editing), proxy DNS, Close On Exit, and SSH server bug + * workarounds. Accordingly I supply a single enum here to deal + * with them all. + */ + FORCE_ON, FORCE_OFF, AUTO +}; + +enum { + /* + * Proxy types. */ - LD_YES, LD_NO, LD_BACKEND + PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET }; enum { @@ -179,55 +232,95 @@ enum { }; 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 */ + /* Protocol back ends. (cfg.protocol) */ + PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH +}; + +enum { + /* Bell settings (cfg.beep) */ + BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE +}; + +enum { + /* Taskbar flashing indication on bell (cfg.beep_ind) */ + B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY +}; + +enum { + /* Resize actions (cfg.resize_action) */ + RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER +}; + +enum { + /* Function key types (cfg.funky_type) */ + FUNKY_TILDE, + FUNKY_LINUX, + FUNKY_XTERM, + FUNKY_VT400, + FUNKY_VT100P, + FUNKY_SCO }; struct backend_tag { - char *(*init) (void *frontend_handle, + char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg, char *host, int port, char **realhost, int nodelay); + void (*free) (void *handle); + /* back->reconfig() passes in a replacement configuration. */ + void (*reconfig) (void *handle, Config *cfg); /* back->send() returns the current amount of buffered data. */ - int (*send) (char *buf, int len); + int (*send) (void *handle, char *buf, int len); /* back->sendbuffer() does the same thing but without attempting a send */ - int (*sendbuffer) (void); - void (*size) (int width, int height); - void (*special) (Telnet_Special code); - Socket(*socket) (void); - int (*exitcode) (void); - int (*sendok) (void); - int (*ldisc) (int); + int (*sendbuffer) (void *handle); + void (*size) (void *handle, int width, int height); + void (*special) (void *handle, Telnet_Special code); + Socket(*socket) (void *handle); + int (*exitcode) (void *handle); + int (*sendok) (void *handle); + int (*ldisc) (void *handle, int); + void (*provide_ldisc) (void *handle, void *ldisc); + void (*provide_logctx) (void *handle, void *logctx); /* * back->unthrottle() tells the back end that the front end * buffer is clearing. */ - void (*unthrottle) (int); + void (*unthrottle) (void *handle, int); int default_port; }; -GLOBAL Backend *back; - extern struct backend_list { int protocol; char *name; Backend *backend; } backends[]; +/* + * Suggested default protocol provided by the backend link module. + * The application is free to ignore this. + */ +extern const int be_default_protocol; + +/* + * 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 + * of the code will want to pass around `int *' pointers to them + * and we can't run the risk of porting to some system on which the + * enum comes out as a different size from int. + */ struct config_tag { /* Basic options */ char host[512]; int port; - enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol; + int 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; + int proxy_dns; + int even_proxy_localhost; + int proxy_type; char proxy_host[512]; int proxy_port; char proxy_username[32]; @@ -298,12 +391,8 @@ struct config_tag { 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 beep; + int 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) */ @@ -311,12 +400,12 @@ struct config_tag { char bell_wavefile[FILENAME_MAX]; int scrollbar; int scrollbar_in_fullscreen; - enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action; + int resize_action; int bce; int blinktext; int win_name_always; int width, height; - char font[64]; + char font[256]; int fontisbold; int fontheight; int fontcharset; @@ -340,42 +429,32 @@ struct config_tag { int mouse_override; short wordness[256]; /* translations */ - VT_Mode vtmode; + int vtmode; char line_codepage[128]; int xlat_capslockcyr; /* X11 forwarding */ int x11_forward; char x11_display[128]; + int x11_auth; /* 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, + int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, sshbug_dhgex2; /* Options for pterm. Should split out into platform-dependent part. */ int stamp_utmp; int login_shell; int scrollbar_on_left; - char boldfont[64]; + char boldfont[256]; + char widefont[256]; + char wideboldfont[256]; int shadowboldoffset; }; /* - * 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. @@ -388,59 +467,72 @@ struct config_tag { * being run, _either_ because no remote command has been provided * _or_ because the application is GUI and can't run non- * interactively. + * + * 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. */ #define FLAG_VERBOSE 0x0001 #define FLAG_STDERR 0x0002 #define FLAG_INTERACTIVE 0x0004 GLOBAL int flags; -GLOBAL Config cfg; +/* + * Likewise, these two variables are set up when the application + * initialises, and inform all default-settings accesses after + * that. + */ GLOBAL int default_protocol; GLOBAL int default_port; -GLOBAL Terminal *term; /* temporary while changes are made */ - struct RSAKey; /* be a little careful of scope */ /* * Exports from window.c. */ -void request_resize(int, int); +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); -int CharWidth(Context ctx, int uc); -void set_title(char *); -void set_icon(char *); -void set_sbar(int, int, int); -Context get_ctx(void); +int char_width(Context ctx, int uc); +#ifdef OPTIMISE_SCROLL +void do_scroll(void *, int, int, int); +#endif +void set_title(void *frontend, char *); +void set_icon(void *frontend, char *); +void set_sbar(void *frontend, int, int, int); +Context get_ctx(void *frontend); 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 palette_set(void *frontend, int, int, int, int); +void palette_reset(void *frontend); +void write_aclip(void *frontend, char *, int, int); +void write_clip(void *frontend, wchar_t *, int, int); +void get_clip(void *frontend, wchar_t **, int *); +void optimised_move(void *frontend, int, int, int); +void set_raw_mouse_mode(void *frontend, int); +void connection_fatal(void *frontend, char *, ...); void fatalbox(char *, ...); void modalfatalbox(char *, ...); -void beep(int); -void begin_session(void); -void sys_cursor(int x, int y); -void request_paste(void); -void frontend_keypress(void); +#ifdef macintosh +#pragma noreturn(fatalbox) +#pragma noreturn(modalfatalbox) +#endif +void beep(void *frontend, int); +void begin_session(void *frontend); +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); #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 set_iconic(void *frontend, int iconic); +void move_window(void *frontend, int x, int y); +void set_zorder(void *frontend, int top); +void refresh_window(void *frontend); +void set_zoomed(void *frontend, int zoomed); +int is_iconic(void *frontend); +void get_window_pos(void *frontend, int *x, int *y); +void get_window_pixels(void *frontend, int *x, int *y); +char *get_window_title(void *frontend, int icon); void cleanup_exit(int); @@ -458,23 +550,41 @@ void random_destroy_seed(void); * Exports from settings.c. */ void 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 get_sesslist(int allocate); +void load_open_settings(void *sesskey, int do_host, Config *cfg); +void get_sesslist(struct sesslist *, int allocate); void do_defaults(char *, Config *); void registry_cleanup(void); /* + * Functions used by settings.c to provide platform-specific + * default settings. + * + * (The integer one is expected to return `def' if it has no clear + * opinion of its own. This is because there's no integer value + * which I can reliably set aside to indicate `nil'. The string + * function is perfectly all right returning NULL, of course.) + */ +char *platform_default_s(const char *name); +int platform_default_i(const char *name, int def); + +/* * Exports from terminal.c. */ -Terminal *term_init(void); +Terminal *term_init(Config *, struct unicode_data *, void *); +void term_free(Terminal *); void term_size(Terminal *, int, int, int); void term_out(Terminal *); -void term_paint(Terminal *, Context, int, int, int, int); +void term_paint(Terminal *, Context, int, int, int, int, int); void term_scroll(Terminal *, int, int); void term_pwron(Terminal *); void term_clrsb(Terminal *); -void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int); +void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action, + int,int,int,int,int); +void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int, + unsigned int); void term_deselect(Terminal *); void term_update(Terminal *); void term_invalidate(Terminal *); @@ -485,19 +595,34 @@ void term_paste(Terminal *); void term_nopaste(Terminal *); int term_ldisc(Terminal *, int option); void term_copyall(Terminal *); -void term_reconfig(Terminal *); +void term_reconfig(Terminal *, Config *); void term_seen_key_event(Terminal *); int from_backend(void *, int is_stderr, char *data, int len); +void term_provide_resize_fn(Terminal *term, + void (*resize_fn)(void *, int, int), + void *resize_ctx); +void term_provide_logctx(Terminal *term, void *logctx); /* * Exports from logging.c. */ -void logfopen(); -void logfclose(); -void logtraffic(unsigned char c, int logmode); +void *log_init(void *frontend, Config *cfg); +void log_free(void *logctx); +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); enum { PKT_INCOMING, PKT_OUTGOING }; -void log_eventlog(char *string); -void log_packet(int direction, int type, char *texttype, void *data, int len); +void log_packet(void *logctx, int direction, int type, + char *texttype, void *data, int len); + +/* + * Exports from testback.c + */ + +extern Backend null_backend; +extern Backend loop_backend; /* * Exports from raw.c. @@ -531,8 +656,15 @@ extern Backend ssh_backend; /* * Exports from ldisc.c. */ +void *ldisc_create(Config *, Terminal *, Backend *, void *, void *); +void ldisc_free(void *); +void ldisc_send(void *handle, char *buf, int len, int interactive); -extern void ldisc_send(char *buf, int len, int interactive); +/* + * Exports from ldiscucs.c. + */ +void lpage_send(void *, int codepage, char *buf, int len, int interactive); +void luni_send(void *, wchar_t * widebuf, int len, int interactive); /* * Exports from sshrand.c. @@ -561,9 +693,13 @@ extern char ver[]; #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); +/* void init_ucs(void); -- this is now in platform-specific headers */ +int is_dbcs_leadbyte(int codepage, char byte); +int mb_to_wc(int codepage, int flags, char *mbstr, int mblen, + wchar_t *wcstr, int wclen); +int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, + char *mbstr, int mblen, char *defchr, int *defused, + struct unicode_data *ucsdata); wchar_t xlat_uskbd2cyrllic(int ch); int check_compose(int first, int second); int decode_codepage(char *cp_name); @@ -572,6 +708,12 @@ char *cp_name(int codepage); void get_unitab(int codepage, wchar_t * unitab, int ftype); /* + * Exports from wcwidth.c + */ +int wcwidth(wchar_t ucs); +int wcswidth(const wchar_t *pwcs, size_t n); + +/* * Exports from mscrypto.c */ #ifdef MSCRYPTOAPI @@ -595,11 +737,11 @@ int wc_unescape(char *output, const char *wildcard); /* * Exports from windlg.c */ -void logevent(char *); -void verify_ssh_host_key(char *host, int port, char *keytype, +void logevent(void *frontend, char *); +void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, char *keystr, char *fingerprint); -void askcipher(char *ciphername, int cs); -int askappend(char *filename); +void askcipher(void *frontend, char *ciphername, int cs); +int askappend(void *frontend, char *filename); /* * Exports from console.c (that aren't equivalents to things in @@ -607,6 +749,7 @@ int askappend(char *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); /* * Exports from printing.c. @@ -625,12 +768,23 @@ void printer_finish_job(printer_job *); * defined differently in various places and required _by_ * cmdline.c). */ -int cmdline_process_param(char *, char *, int); -void cmdline_run_saved(void); +int cmdline_process_param(char *, char *, int, Config *); +void cmdline_run_saved(Config *); extern char *cmdline_password; #define TOOLTYPE_FILETRANSFER 1 extern int cmdline_tooltype; void cmdline_error(char *, ...); +/* + * X11 auth mechanisms we know about. + */ +enum { + X11_NO_AUTH, + X11_MIT, /* MIT-MAGIC-COOKIE-1 */ + X11_XDM, /* XDM-AUTHORIZATION-1 */ + X11_NAUTHS +}; +extern const char *const x11_authnames[]; /* declared in x11fwd.c */ + #endif