Yet more global-removal. The static variables in logging.c are now
[u/mdw/putty] / putty.h
diff --git a/putty.h b/putty.h
index 04804c2..116e2a3 100644 (file)
--- a/putty.h
+++ b/putty.h
@@ -3,24 +3,28 @@
 
 #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"
-
 /*
  * 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
 #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;
+GLOBAL int nsessions;
+GLOBAL char **sessions;
 
 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 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 */
@@ -132,21 +118,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 +176,28 @@ 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,
+                  char *host, int port, char **realhost, int nodelay);
     /* 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 +205,7 @@ extern struct backend_list {
     Backend *backend;
 } backends[];
 
-typedef struct {
+struct config_tag {
     /* Basic options */
     char host[512];
     int port;
@@ -242,6 +214,15 @@ typedef struct {
     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
@@ -257,7 +238,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;
@@ -267,8 +247,8 @@ typedef struct {
     char termtype[32];
     char termspeed[32];
     char environmt[1024];             /* VAR\tvalue\0VAR\tvalue\0\0 */
-    char username[32];
-    char localusername[32];
+    char username[100];
+    char localusername[100];
     int rfc_environ;
     int passive_telnet;
     /* Keyboard options */
@@ -277,6 +257,12 @@ typedef struct {
     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;
@@ -330,6 +316,7 @@ typedef struct {
     int sunken_edge;
     int window_border;
     char answerback[256];
+    char printer[128];
     /* Colour options */
     int try_palette;
     int bold_colour;
@@ -352,7 +339,19 @@ typedef struct {
     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 */
-} Config;
+    /* 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;
+    /* Options for pterm. Should split out into platform-dependent part. */
+    int stamp_utmp;
+    int login_shell;
+    int scrollbar_on_left;
+    char boldfont[64];
+    int shadowboldoffset;
+};
 
 /*
  * You can compile with -DSSH_DEFAULT to have ssh by default.
@@ -393,39 +392,43 @@ 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);
+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 *, ...);
+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);
 
@@ -435,68 +438,60 @@ 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.
- */
-void defuse_showwindow(void);
-int do_config(void);
-int do_reconfig(HWND);
-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.
  */
 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);
+void do_defaults(char *, Config *);
+void registry_cleanup(void);
 
 /*
  * 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);
+Terminal *term_init(void *frontend);
+void term_size(Terminal *, int, int, int);
+void term_out(Terminal *);
+void term_paint(Terminal *, Context, 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 *);
+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);
+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 raw.c.
@@ -517,18 +512,27 @@ extern Backend rlogin_backend;
 extern Backend telnet_backend;
 
 /*
- * Exports from ssh.c.
+ * 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.)
  */
 
-extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
+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.
  */
+void *ldisc_create(Terminal *, Backend *, void *, 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.
@@ -552,20 +556,17 @@ 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);
+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);
 wchar_t xlat_uskbd2cyrllic(int ch);
 int check_compose(int first, int second);
 int decode_codepage(char *cp_name);
@@ -595,11 +596,44 @@ 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).
  */
 extern int console_batch_mode;
-extern char *console_password;
 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