Rethink the whole line discipline architecture. Instead of having
[u/mdw/putty] / putty.h
diff --git a/putty.h b/putty.h
index 8de3aff..5423ae9 100644 (file)
--- a/putty.h
+++ b/putty.h
@@ -1,7 +1,13 @@
 #ifndef PUTTY_PUTTY_H
 #define PUTTY_PUTTY_H
 
+#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
 #define GLOBAL extern
 #endif
 
-GLOBAL HINSTANCE putty_inst;
-
 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
 #define ATTR_INVALID 0x20000000UL
 #define ATTR_WRAPPED 0x10000000UL
+#define ATTR_RIGHTCURS 0x10000000UL    /* doubles as cursor-on-RHS indicator */
 
 #define LATTR_NORM   0x00000000UL
 #define LATTR_WIDE   0x01000000UL
@@ -55,8 +60,6 @@ GLOBAL int rows, cols, savelines;
 
 GLOBAL int font_width, font_height;
 
-#define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
-                         inbuf[inbuf_head++] = (_C) ; } while(0)
 #define INBUF_SIZE 2048
 GLOBAL unsigned char inbuf[INBUF_SIZE];
 GLOBAL int inbuf_head;
@@ -76,9 +79,18 @@ GLOBAL int seen_disp_event;
 
 GLOBAL int session_closed;
 
+#define LGTYP_NONE  0  /* logmode: no logging */
+#define LGTYP_ASCII 1  /* logmode: pure ascii */
+#define LGTYP_DEBUG 2  /* logmode: all chars of taffic */
 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
@@ -88,7 +100,7 @@ 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_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
 } Telnet_Special;
 
 typedef enum {
@@ -103,14 +115,30 @@ typedef enum {
     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
 } VT_Mode;
 
+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 */
+};
+
 typedef struct {
-    char *(*init) (HWND hwnd, char *host, int port, char **realhost);
-    int (*msg) (WPARAM wParam, LPARAM lParam);
+    char *(*init) (char *host, int port, char **realhost);
     void (*send) (char *buf, int len);
     void (*size) (void);
     void (*special) (Telnet_Special code);
-    SOCKET (*socket) (void);
+    Socket (*socket) (void);
     int (*sendok) (void);
+    int (*ldisc) (int);
+    int default_port;
 } Backend;
 
 GLOBAL Backend *back;
@@ -122,48 +150,55 @@ extern struct backend_list {
 } backends[];
 
 typedef struct {
-    void (*send) (char *buf, int len);
-} Ldisc;
-
-GLOBAL Ldisc *ldisc;
-
-typedef struct {
     /* Basic options */
     char host[512];
     int port;
-    enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
+    enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
     int close_on_exit;
     int warn_on_close;
+    int ping_interval;                 /* in seconds */
     /* SSH options */
     char remote_cmd[512];
     int nopty;
+    int compression;
     int agentfwd;
     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
     char keyfile[FILENAME_MAX];
     int sshprot;                       /* use v1 or v2 when both available */
+    int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
     int try_tis_auth;
     /* Telnet options */
     char termtype[32];
     char termspeed[32];
     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
     char username[32];
+    char localusername[32];
     int rfc_environ;
     /* 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 app_cursor;
     int app_keypad;
     int nethack_keypad;
     int alt_f4;                               /* is it special? */
     int alt_space;                    /* is it special? */
-    int ldisc_term;
+    int alt_only;                     /* is it special? */
+    int localecho;
+    int localedit;
+    int alwaysontop;
     int scroll_on_key;
+    int scroll_on_disp;
+    int compose_key;
+    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;
     int beep;
     int scrollbar;
@@ -176,6 +211,9 @@ typedef struct {
     int fontisbold;
     int fontheight;
     int fontcharset;
+    char logfilename[FILENAME_MAX];
+    int logtype;
+    int hide_mouseptr;
     /* Colour options */
     int try_palette;
     int bold_colour;
@@ -187,7 +225,11 @@ typedef struct {
     VT_Mode vtmode;
     int xlat_enablekoiwin;
     int xlat_88592w1250;
+    int xlat_88592cp852;
     int xlat_capslockcyr;
+    /* X11 forwarding */
+    int x11_forward;
+    char x11_display[128];
 } Config;
 
 /*
@@ -238,38 +280,53 @@ Context get_ctx(void);
 void free_ctx (Context);
 void palette_set (int, int, int, int);
 void palette_reset (void);
-void write_clip (void *, int);
+void write_clip (void *, int, int);
 void get_clip (void **, int *);
 void optimised_move (int, int, int);
 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
 
 /*
  * Exports from noise.c.
  */
-void noise_get_heavy(void (*func) (void *, int));
-void noise_get_light(void (*func) (void *, 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 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 *);
+void do_defaults (char *, Config *);
 void logevent (char *);
 void showeventlog (HWND);
 void showabout (HWND);
-void verify_ssh_host_key(char *host, char *keystr);
-void get_sesslist(int allocate);
+void verify_ssh_host_key(char *host, int port, char *keytype,
+                         char *keystr, char *fingerprint);
+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);
+
+/*
  * Exports from terminal.c.
  */
 
@@ -287,6 +344,11 @@ void term_invalidate(void);
 void term_blink(int set_cursor);
 void term_paste(void);
 void term_nopaste(void);
+int telnet_ldisc(int option);
+void from_backend(int is_stderr, char *data, int len);
+void logfopen (void); 
+void logfclose (void);
+void term_copyall(void);
 
 /*
  * Exports from raw.c.
@@ -295,6 +357,12 @@ void term_nopaste(void);
 extern Backend raw_backend;
 
 /*
+ * Exports from rlogin.c.
+ */
+
+extern Backend rlogin_backend;
+
+/*
  * Exports from telnet.c.
  */
 
@@ -311,7 +379,7 @@ extern Backend ssh_backend;
  * Exports from ldisc.c.
  */
 
-extern Ldisc ldisc_term, ldisc_simple;
+extern void ldisc_send(char *buf, int len);
 
 /*
  * Exports from sshrand.c.
@@ -326,21 +394,7 @@ void random_get_savedata(void **data, int *len);
  * Exports from misc.c.
  */
 
-/* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
-#ifdef MALLOC_LOG
-#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
-#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
-#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
-void mlog(char *, int);
-#else
-#define smalloc safemalloc
-#define srealloc saferealloc
-#define sfree safefree
-#endif
-
-void *safemalloc(size_t);
-void *saferealloc(void *, size_t);
-void safefree(void *);
+#include "puttymem.h"
 
 /*
  * Exports from version.c.
@@ -374,28 +428,9 @@ void crypto_wrapup();
 void agent_query(void *in, int inlen, void **out, int *outlen);
 int agent_exists(void);
 
-/*
- * A debug system.
- */
 #ifdef DEBUG
-#include <stdarg.h>
+void dprintf(char *fmt, ...);
 #define debug(x) (dprintf x)
-static void dprintf(char *fmt, ...) {
-    char buf[2048];
-    DWORD dw;
-    va_list ap;
-    static int gotconsole = 0;
-
-    if (!gotconsole) {
-       AllocConsole();
-       gotconsole = 1;
-    }
-
-    va_start(ap, fmt);
-    vsprintf(buf, fmt, ap);
-    WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
-    va_end(ap);
-}
 #else
 #define debug(x)
 #endif