Add the ability to close sessions. This adds *_free() functions to most
[u/mdw/putty] / putty.h
diff --git a/putty.h b/putty.h
index e2a7fea..39d9454 100644 (file)
--- a/putty.h
+++ b/putty.h
@@ -2,25 +2,30 @@
 #define PUTTY_PUTTY_H
 
 #include <stdio.h>                    /* for FILENAME_MAX */
-
-#include "network.h"
-
-#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
-#define PUTTY_REG_PARENT "Software\\SimonTatham"
-#define PUTTY_REG_PARENT_CHILD "PuTTY"
-#define PUTTY_REG_GPARENT "Software"
-#define PUTTY_REG_GPARENT_CHILD "SimonTatham"
+#include <stddef.h>                   /* for wchar_t */
 
 /*
  * 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
+
+#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"
 
 /* Three attribute types: 
  * The ATTRs (normal attributes) are stored with the characters in the main
@@ -46,6 +51,7 @@
 #define LATTR_BOT    0x03000000UL
 #define LATTR_MODE   0x03000000UL
 #define LATTR_WRAPPED 0x10000000UL
+#define LATTR_WRAPPED2 0x20000000UL
 
 #define ATTR_INVALID 0x00FF0000UL
 
 #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
 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
 #define ATTR_CUR_XOR 0x00BA0000UL
 
-typedef HDC Context;
-#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;
+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 unitab_scoacs[256];
-GLOBAL WCHAR unitab_line[256];
-GLOBAL WCHAR unitab_font[256];
-GLOBAL WCHAR unitab_xterm[256];
-GLOBAL WCHAR unitab_oemcp[256];
-GLOBAL unsigned char unitab_ctrl[256];
-#define in_utf (utf || line_codepage==CP_UTF8)
+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 */
@@ -132,21 +128,6 @@ GLOBAL unsigned char unitab_ctrl[256];
 #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;
-
-/*
- * Window handles for the dialog boxes that can be running during a
- * PuTTY session.
- */
-GLOBAL HWND logbox;
-
-/*
- * 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,
@@ -205,27 +186,31 @@ enum {
     COE_ALWAYS                        /* Always close the window */
 };
 
-typedef struct {
-    char *(*init) (char *host, int port, char **realhost, int nodelay);
+struct backend_tag {
+    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) (void);
-    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;
-} Backend;
-
-GLOBAL Backend *back;
+};
 
 extern struct backend_list {
     int protocol;
@@ -233,7 +218,13 @@ extern struct backend_list {
     Backend *backend;
 } backends[];
 
-typedef struct {
+/*
+ * Suggested default protocol provided by the backend link module.
+ * The application is free to ignore this.
+ */
+extern const int be_default_protocol;
+
+struct config_tag {
     /* Basic options */
     char host[512];
     int port;
@@ -244,6 +235,8 @@ typedef struct {
     int tcp_nodelay;
     /* Proxy options */
     char proxy_exclude_list[512];
+    enum { PROXYDNS_NO, PROXYDNS_AUTO, PROXYDNS_YES } proxy_dns;
+    int even_proxy_localhost;
     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
     char proxy_host[512];
     int proxy_port;
@@ -266,7 +259,6 @@ typedef struct {
     int ssh_cipherlist[CIPHER_MAX];
     char keyfile[FILENAME_MAX];
     int sshprot;                      /* use v1 or v2 when both available */
-    int buggymac;                     /* MAC bug commmercial <=v2.3.x SSH2 */
     int ssh2_des_cbc;                 /* "des-cbc" nonstandard SSH2 cipher */
     int try_tis_auth;
     int try_ki_auth;
@@ -334,7 +326,7 @@ typedef struct {
     int blinktext;
     int win_name_always;
     int width, height;
-    char font[64];
+    char font[256];
     int fontisbold;
     int fontheight;
     int fontcharset;
@@ -364,6 +356,7 @@ typedef struct {
     /* 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) */
@@ -372,19 +365,17 @@ typedef struct {
     enum {
        BUG_AUTO, BUG_OFF, BUG_ON
     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
-       sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2;
-} 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
+       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[256];
+    char widefont[256];
+    char wideboldfont[256];
+    int shadowboldoffset;
+};
 
 /*
  * Some global flags denoting the type of application.
@@ -399,13 +390,21 @@ typedef struct {
  * 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;
 
@@ -414,39 +413,50 @@ 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);
+Mouse_Button translate_button(void *frontend, Mouse_Button b);
+void connection_fatal(void *frontend, char *, ...);
 void fatalbox(char *, ...);
-void beep(int);
-void begin_session(void);
-void sys_cursor(int x, int y);
+void modalfatalbox(char *, ...);
+#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);
 
@@ -456,69 +466,83 @@ void cleanup_exit(int);
 void noise_get_heavy(void (*func) (void *, int));
 void noise_get_light(void (*func) (void *, int));
 void noise_regular(void);
-void noise_ultralight(DWORD data);
+void noise_ultralight(unsigned long data);
 void random_save_seed(void);
 void random_destroy_seed(void);
 
 /*
- * Exports from windlg.c.
+ * Exports from settings.c.
  */
-void defuse_showwindow(void);
-int do_config(void);
-int do_reconfig(HWND);
+void save_settings(char *section, 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);
+void get_sesslist(struct sesslist *, int allocate);
 void do_defaults(char *, Config *);
-void logevent(char *);
-void showeventlog(HWND);
-void showabout(HWND);
-void verify_ssh_host_key(char *host, int port, char *keytype,
-                        char *keystr, char *fingerprint);
-void askcipher(char *ciphername, int cs);
-int askappend(char *filename);
 void registry_cleanup(void);
-void force_normal(HWND hwnd);
-
-GLOBAL int nsessions;
-GLOBAL char **sessions;
 
 /*
- * Exports from settings.c.
+ * 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.)
  */
-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);
+char *platform_default_s(const char *name);
+int platform_default_i(const char *name, int def);
 
 /*
  * 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);
+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, 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_deselect(Terminal *);
+void term_update(Terminal *);
+void term_invalidate(Terminal *);
+void term_blink(Terminal *, int set_cursor);
+void term_do_paste(Terminal *);
+int term_paste_pending(Terminal *);
+void term_paste(Terminal *);
+void term_nopaste(Terminal *);
+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, 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 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_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.
@@ -552,8 +576,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.
@@ -577,20 +608,18 @@ extern int random_active;
 extern char ver[];
 
 /*
- * Exports from sizetip.c.
- */
-void UpdateSizeTip(HWND src, int cx, int cy);
-void EnableSizeTip(int bEnable);
-
-/*
  * 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);
+/* 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);
@@ -599,6 +628,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
@@ -620,6 +655,15 @@ int wc_match(const char *wildcard, const char *target);
 int wc_unescape(char *output, const char *wildcard);
 
 /*
+ * Exports from windlg.c
+ */
+void logevent(void *frontend, 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);
+int askappend(void *frontend, char *filename);
+
+/*
  * Exports from console.c (that aren't equivalents to things in
  * windlg.c).
  */
@@ -643,12 +687,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