putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
   5
   6 /*
   7  * Global variables. Most modules declare these `extern', but
   8  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
   9  * module, and so will get them properly defined.
  10  */
  11 #ifdef PUTTY_DO_GLOBALS
  12 #define GLOBAL
  13 #else
  14 #define GLOBAL extern
  15 #endif
  16
  17 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
  18 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
  19 #define ATTR_INVALID 0x20000000UL
  20 #define ATTR_WRAPPED 0x10000000UL
  21
  22 #define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
  23 #define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
  24 #define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
  25
  26 #define ATTR_BOLD    0x00000100UL
  27 #define ATTR_UNDER   0x00000200UL
  28 #define ATTR_REVERSE 0x00000400UL
  29 #define ATTR_FGMASK  0x0000F000UL
  30 #define ATTR_BGMASK  0x000F0000UL
  31 #define ATTR_FGSHIFT 12
  32 #define ATTR_BGSHIFT 16
  33
  34 #define ATTR_DEFAULT 0x00098000UL
  35 #define ATTR_DEFFG   0x00008000UL
  36 #define ATTR_DEFBG   0x00090000UL
  37 #define ATTR_CUR_XOR 0x000BA000UL
  38 #define ERASE_CHAR   (ATTR_DEFAULT | ' ')
  39 #define ATTR_MASK    0xFFFFFF00UL
  40 #define CHAR_MASK    0x000000FFUL
  41
  42 typedef HDC Context;
  43 #define SEL_NL { 13, 10 }
  44
  45 GLOBAL int rows, cols, savelines;
  46
  47 GLOBAL int font_width, font_height;
  48
  49 #define INBUF_SIZE 2048
  50 #define INBUF_MASK (INBUF_SIZE-1)
  51 GLOBAL unsigned char inbuf[INBUF_SIZE];
  52 GLOBAL int inbuf_head, inbuf_reap;
  53
  54 #define OUTBUF_SIZE 2048
  55 #define OUTBUF_MASK (OUTBUF_SIZE-1)
  56 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
  57 GLOBAL int outbuf_head, outbuf_reap;
  58
  59 GLOBAL int has_focus;
  60
  61 GLOBAL int app_cursor_keys, app_keypad_keys;
  62
  63 #define WM_NETEVENT  (WM_USER + 1)
  64
  65 typedef enum {
  66     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
  67     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF
  68 } Telnet_Special;
  69
  70 typedef enum {
  71     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
  72 } Mouse_Button;
  73
  74 typedef enum {
  75     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
  76 } Mouse_Action;
  77
  78 typedef enum {
  79     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
  80 } VT_Mode;
  81
  82 typedef struct {
  83     char *(*init) (HWND hwnd, char *host, int port, char **realhost);
  84     int (*msg) (WPARAM wParam, LPARAM lParam);
  85     void (*send) (char *buf, int len);
  86     void (*size) (void);
  87     void (*special) (Telnet_Special code);
  88 } Backend;
  89
  90 GLOBAL Backend *back;
  91
  92 typedef struct {
  93     /* Basic options */
  94     char host[512];
  95     int port;
  96     enum { PROT_TELNET, PROT_SSH } protocol;
  97     int close_on_exit;
  98     /* Telnet options */
  99     char termtype[32];
 100     char termspeed[32];
 101     char environ[1024];                /* VAR\tvalue\0VAR\tvalue\0\0 */
 102     char username[32];
 103     int rfc_environ;
 104     /* Keyboard options */
 105     int bksp_is_delete;
 106     int rxvt_homeend;
 107     int linux_funkeys;
 108     int app_cursor;
 109     int app_keypad;
 110     /* Terminal options */
 111     int savelines;
 112     int dec_om;
 113     int wrap_mode;
 114     int win_name_always;
 115     int width, height;
 116     char font[64];
 117     int fontisbold;
 118     int fontheight;
 119     VT_Mode vtmode;
 120     /* Colour options */
 121     int try_palette;
 122     int bold_colour;
 123     unsigned char colours[22][3];
 124     /* Selection options */
 125     int mouse_is_xterm;
 126     short wordness[256];
 127 } Config;
 128
 129 GLOBAL Config cfg;
 130
 131 /*
 132  * Exports from window.c.
 133  */
 134 void request_resize (int, int);
 135 void do_text (Context, int, int, char *, int, unsigned long);
 136 void set_title (char *);
 137 void set_icon (char *);
 138 void set_sbar (int, int, int);
 139 Context get_ctx();
 140 void free_ctx (Context);
 141 void palette_set (int, int, int, int);
 142 void palette_reset (void);
 143 void write_clip (void *, int);
 144 void get_clip (void **, int *);
 145 void optimised_move (int, int, int);
 146 void fatalbox (char *, ...);
 147 void beep (void);
 148 #define OPTIMISE_IS_SCROLL 1
 149
 150 /*
 151  * Exports from noise.c.
 152  */
 153 void noise_get_heavy(void (*func) (void *, int));
 154 void noise_get_light(void (*func) (void *, int));
 155 void noise_ultralight(DWORD data);
 156 void random_save_seed(void);
 157
 158 /*
 159  * Exports from windlg.c.
 160  */
 161 int do_config (void);
 162 int do_reconfig (HWND);
 163 void do_defaults (char *);
 164 void lognegot (char *);
 165 void shownegot (HWND);
 166 void showabout (HWND);
 167 void verify_ssh_host_key(char *host, struct RSAKey *key);
 168
 169 /*
 170  * Exports from terminal.c.
 171  */
 172
 173 void term_init (void);
 174 void term_size (int, int, int);
 175 void term_out (void);
 176 void term_paint (Context, int, int, int, int);
 177 void term_scroll (int, int);
 178 void term_pwron (void);
 179 void term_clrsb (void);
 180 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 181 void term_deselect (void);
 182 void term_update (void);
 183 void term_invalidate(void);
 184
 185 /*
 186  * Exports from telnet.c.
 187  */
 188
 189 Backend telnet_backend;
 190
 191 /*
 192  * Exports from ssh.c.
 193  */
 194
 195 Backend ssh_backend;
 196
 197 /*
 198  * Exports from sshrand.c.
 199  */
 200
 201 void random_add_noise(void *noise, int length);
 202 void random_init(void);
 203 int random_byte(void);
 204 void random_get_savedata(void **data, int *len);
 205
 206 /*
 207  * Exports from misc.c.
 208  */
 209
 210 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 211 #ifdef MALLOC_LOG
 212 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 213 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 214 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 215 void mlog(char *, int);
 216 #else
 217 #define smalloc safemalloc
 218 #define srealloc saferealloc
 219 #define sfree safefree
 220 #endif
 221
 222 void *safemalloc(size_t);
 223 void *saferealloc(void *, size_t);
 224 void safefree(void *);
 225
 226 /*
 227  * A debug system.
 228  */
 229 #ifdef DEBUG
 230 #include <stdarg.h>
 231 #define debug(x) (dprintf x)
 232 static void dprintf(char *fmt, ...) {
 233     char buf[2048];
 234     DWORD dw;
 235     va_list ap;
 236     static int gotconsole = 0;
 237
 238     if (!gotconsole) {
 239         AllocConsole();
 240         gotconsole = 1;
 241     }
 242
 243     va_start(ap, fmt);
 244     vsprintf(buf, fmt, ap);
 245     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 246     va_end(ap);
 247 }
 248 #else
 249 #define debug(x)
 250 #endif
 251
 252 #endif