Configurable TCP_NODELAY option on network connections
[u/mdw/putty] / putty.h
diff --git a/putty.h b/putty.h
index cd7262f..352a4ef 100644 (file)
--- a/putty.h
+++ b/putty.h
@@ -1,6 +1,8 @@
 #ifndef PUTTY_PUTTY_H
 #define PUTTY_PUTTY_H
 
+#include <stdio.h>                    /* for FILENAME_MAX */
+
 #include "network.h"
 
 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
 #define GLOBAL extern
 #endif
 
-#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 */
+/* Three attribute types: 
+ * The ATTRs (normal attributes) are stored with the characters in the main
+ * display arrays
+ *
+ * The TATTRs (temporary attributes) are generated on the fly, they can overlap
+ * with characters but not with normal attributes.
+ *
+ * The LATTRs (line attributes) conflict with no others and only have one
+ * value per line. But on area clears the LATTR cells are set to the erase_char
+ * (or DEFAULT_ATTR + 'E')
+ *
+ * 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 LATTR_NORM   0x00000000UL
 #define LATTR_WIDE   0x01000000UL
 #define LATTR_TOP    0x02000000UL
 #define LATTR_BOT    0x03000000UL
 #define LATTR_MODE   0x03000000UL
-
-#define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
-#define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
-#define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
-
-#define ATTR_BOLD    0x00000100UL
-#define ATTR_UNDER   0x00000200UL
-#define ATTR_REVERSE 0x00000400UL
-#define ATTR_BLINK   0x00000800UL
-#define ATTR_FGMASK  0x0000F000UL
-#define ATTR_BGMASK  0x000F0000UL
-#define ATTR_FGSHIFT 12
-#define ATTR_BGSHIFT 16
-
-#define ATTR_DEFAULT 0x00098000UL
-#define ATTR_DEFFG   0x00008000UL
-#define ATTR_DEFBG   0x00090000UL
-#define ATTR_CUR_XOR 0x000BA000UL
-#define ERASE_CHAR   (ATTR_DEFAULT | ' ')
+#define LATTR_WRAPPED 0x10000000UL
+
+#define ATTR_INVALID 0x00FF0000UL
+
+/* Like Linux use the F000 page for direct to font. */
+#define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
+#define ATTR_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 DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
+#define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
+
+#define UCSERR      (ATTR_LINEDRW|'a') /* UCS Format error character. */
+#define UCSWIDE             0x303F
+
+#define ATTR_NARROW  0x20000000UL
+#define ATTR_WIDE    0x10000000UL
+#define ATTR_BOLD    0x01000000UL
+#define ATTR_UNDER   0x02000000UL
+#define ATTR_REVERSE 0x04000000UL
+#define ATTR_BLINK   0x08000000UL
+#define ATTR_FGMASK  0x000F0000UL
+#define ATTR_BGMASK  0x00F00000UL
+#define ATTR_COLOURS 0x00FF0000UL
+#define ATTR_FGSHIFT 16
+#define ATTR_BGSHIFT 20
+
+#define ATTR_DEFAULT 0x00980000UL
+#define ATTR_DEFFG   0x00080000UL
+#define ATTR_DEFBG   0x00900000UL
+#define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
 #define ATTR_MASK    0xFFFFFF00UL
 #define CHAR_MASK    0x000000FFUL
-#define CSET_MASK    0x00F00000UL      /* mask for character set */
+
+#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 font_width, font_height;
-
-#define INBUF_SIZE 2048
-GLOBAL unsigned char inbuf[INBUF_SIZE];
-GLOBAL int inbuf_head;
-
-#define OUTBUF_SIZE 2048
-#define OUTBUF_MASK (OUTBUF_SIZE-1)
-GLOBAL unsigned char outbuf[OUTBUF_SIZE];
-GLOBAL int outbuf_head, outbuf_reap;
-
 GLOBAL int has_focus;
 
 GLOBAL int in_vbell;
-GLOBAL long vbell_timeout;
+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 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)
+
 #define LGXF_OVR  1                   /* existing logfile overwrite */
 #define LGXF_APN  0                   /* existing logfile append */
 #define LGXF_ASK -1                   /* existing logfile ask */
@@ -107,7 +146,8 @@ GLOBAL HWND logbox;
 
 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_PING
+    TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
+    TS_EOL
 } Telnet_Special;
 
 typedef enum {
@@ -122,11 +162,23 @@ typedef enum {
 } Mouse_Action;
 
 typedef enum {
-    VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
+    VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 } VT_Mode;
 
 enum {
     /*
+     * SSH ciphers (both SSH1 and SSH2)
+     */
+    CIPHER_WARN,                      /* pseudo 'cipher' */
+    CIPHER_3DES,
+    CIPHER_BLOWFISH,
+    CIPHER_AES,                               /* (SSH 2 only) */
+    CIPHER_DES,
+    CIPHER_MAX                        /* no. ciphers (inc warn) */
+};
+
+enum {
+    /*
      * Line discipline option states: off, on, up to the backend.
      */
     LD_YES, LD_NO, LD_BACKEND
@@ -150,13 +202,21 @@ enum {
 };
 
 typedef struct {
-    char *(*init) (char *host, int port, char **realhost);
-    void (*send) (char *buf, int len);
+    char *(*init) (char *host, int port, char **realhost, int nodelay);
+    /* back->send() returns the current amount of buffered data. */
+    int (*send) (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);
+    Socket(*socket) (void);
     int (*sendok) (void);
     int (*ldisc) (int);
+    /*
+     * back->unthrottle() tells the back end that the front end
+     * buffer is clearing.
+     */
+    void (*unthrottle) (int);
     int default_port;
 } Backend;
 
@@ -176,19 +236,26 @@ typedef struct {
     int close_on_exit;
     int warn_on_close;
     int ping_interval;                /* in seconds */
+    int tcp_nodelay;
     /* SSH options */
     char remote_cmd[512];
+    char remote_cmd2[512];            /* fallback if the first fails
+                                       * (used internally for scp) */
     char *remote_cmd_ptr;             /* might point to a larger command
                                        * but never for loading/saving */
+    char *remote_cmd_ptr2;            /* might point to a larger command
+                                       * but never for loading/saving */
     int nopty;
     int compression;
     int agentfwd;
-    enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
+    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 try_tis_auth;
+    int try_ki_auth;
     int ssh_subsys;                   /* run a subsystem rather than a command */
+    int ssh_subsys2;                  /* fallback to go with remote_cmd2 */
     /* Telnet options */
     char termtype[32];
     char termspeed[32];
@@ -206,12 +273,14 @@ typedef struct {
     int app_cursor;
     int app_keypad;
     int nethack_keypad;
+    int telnet_keyboard;
     int alt_f4;                               /* is it special? */
     int alt_space;                    /* is it special? */
     int alt_only;                     /* is it special? */
     int localecho;
     int localedit;
     int alwaysontop;
+    int fullscreenonaltenter;
     int scroll_on_key;
     int scroll_on_disp;
     int compose_key;
@@ -227,13 +296,17 @@ typedef struct {
     enum {
        BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
     } beep;
+    enum {
+       B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
+    } 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) */
     int bellovl_s;                    /* period of silence to re-enable bell (s) */
     char bell_wavefile[FILENAME_MAX];
     int scrollbar;
-    int locksize;
+    int scrollbar_in_fullscreen;
+    enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
     int bce;
     int blinktext;
     int win_name_always;
@@ -247,6 +320,7 @@ typedef struct {
     int logxfovr;
     int hide_mouseptr;
     int sunken_edge;
+    int window_border;
     char answerback[256];
     /* Colour options */
     int try_palette;
@@ -254,17 +328,21 @@ typedef struct {
     unsigned char colours[22][3];
     /* Selection options */
     int mouse_is_xterm;
+    int rect_select;
     int rawcnp;
+    int rtf_paste;
+    int mouse_override;
     short wordness[256];
     /* translations */
     VT_Mode vtmode;
-    int xlat_enablekoiwin;
-    int xlat_88592w1250;
-    int xlat_88592cp852;
+    char line_codepage[128];
     int xlat_capslockcyr;
     /* X11 forwarding */
     int x11_forward;
     char x11_display[128];
+    /* port forwarding */
+    int lport_acceptall; /* accepts connection from hosts other than localhost */
+    char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 } Config;
 
 /*
@@ -306,8 +384,10 @@ struct RSAKey;                            /* be a little careful of scope */
 /*
  * Exports from window.c.
  */
-void request_resize(int, int, int);
+void request_resize(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);
@@ -315,8 +395,9 @@ Context get_ctx(void);
 void free_ctx(Context);
 void palette_set(int, int, int, int);
 void palette_reset(void);
-void write_clip(void *, int, int);
-void get_clip(void **, int *);
+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);
@@ -327,6 +408,16 @@ void begin_session(void);
 void sys_cursor(int x, int y);
 #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);
+
 /*
  * Exports from noise.c.
  */
@@ -349,6 +440,7 @@ 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);
@@ -374,15 +466,16 @@ 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);
+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);
-void from_backend(int is_stderr, char *data, int len);
+int from_backend(int is_stderr, char *data, int len);
 void logfopen(void);
 void logfclose(void);
 void term_copyall(void);
@@ -417,7 +510,7 @@ extern Backend ssh_backend;
  * Exports from ldisc.c.
  */
 
-extern void ldisc_send(char *buf, int len);
+extern void ldisc_send(char *buf, int len, int interactive);
 
 /*
  * Exports from sshrand.c.
@@ -446,11 +539,20 @@ void UpdateSizeTip(HWND src, int cx, int cy);
 void EnableSizeTip(int bEnable);
 
 /*
- * Exports from xlat.c.
+ * Exports from unicode.c.
  */
-unsigned char xlat_kbd2tty(unsigned char c);
-unsigned char xlat_tty2scr(unsigned char c);
-unsigned char xlat_latkbd2win(unsigned char 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);
+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);
+void get_unitab(int codepage, wchar_t * unitab, int ftype);
 
 /*
  * Exports from mscrypto.c
@@ -466,5 +568,11 @@ void crypto_wrapup();
 void agent_query(void *in, int inlen, void **out, int *outlen);
 int agent_exists(void);
 
+/*
+ * Exports from wildcard.c
+ */
+const char *wc_error(int value);
+int wc_match(const char *wildcard, const char *target);
+int wc_unescape(char *output, const char *wildcard);
 
 #endif