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 GLOBAL HINSTANCE putty_inst;
  18
  19 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
  20 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
  21 #define ATTR_INVALID 0x20000000UL
  22 #define ATTR_WRAPPED 0x10000000UL
  23
  24 #define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
  25 #define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
  26 #define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
  27
  28 #define ATTR_BOLD    0x00000100UL
  29 #define ATTR_UNDER   0x00000200UL
  30 #define ATTR_REVERSE 0x00000400UL
  31 #define ATTR_FGMASK  0x0000F000UL
  32 #define ATTR_BGMASK  0x000F0000UL
  33 #define ATTR_FGSHIFT 12
  34 #define ATTR_BGSHIFT 16
  35
  36 #define ATTR_DEFAULT 0x00098000UL
  37 #define ATTR_DEFFG   0x00008000UL
  38 #define ATTR_DEFBG   0x00090000UL
  39 #define ATTR_CUR_XOR 0x000BA000UL
  40 #define ERASE_CHAR   (ATTR_DEFAULT | ' ')
  41 #define ATTR_MASK    0xFFFFFF00UL
  42 #define CHAR_MASK    0x000000FFUL
  43
  44 typedef HDC Context;
  45 #define SEL_NL { 13, 10 }
  46
  47 GLOBAL int rows, cols, savelines;
  48
  49 GLOBAL int font_width, font_height;
  50
  51 #define INBUF_SIZE 2048
  52 #define INBUF_MASK (INBUF_SIZE-1)
  53 GLOBAL unsigned char inbuf[INBUF_SIZE];
  54 GLOBAL int inbuf_head, inbuf_reap;
  55
  56 #define OUTBUF_SIZE 2048
  57 #define OUTBUF_MASK (OUTBUF_SIZE-1)
  58 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
  59 GLOBAL int outbuf_head, outbuf_reap;
  60
  61 GLOBAL int has_focus;
  62
  63 GLOBAL int app_cursor_keys, app_keypad_keys;
  64
  65 #define WM_NETEVENT  (WM_USER + 1)
  66
  67 typedef enum {
  68     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
  69     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF
  70 } Telnet_Special;
  71
  72 typedef enum {
  73     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
  74 } Mouse_Button;
  75
  76 typedef enum {
  77     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
  78 } Mouse_Action;
  79
  80 typedef enum {
  81     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
  82 } VT_Mode;
  83
  84 typedef struct {
  85     char *(*init) (HWND hwnd, char *host, int port, char **realhost);
  86     int (*msg) (WPARAM wParam, LPARAM lParam);
  87     void (*send) (char *buf, int len);
  88     void (*size) (void);
  89     void (*special) (Telnet_Special code);
  90 } Backend;
  91
  92 GLOBAL Backend *back;
  93
  94 typedef struct {
  95     void (*send) (char *buf, int len);
  96 } Ldisc;
  97
  98 GLOBAL Ldisc *ldisc;
  99
 100 typedef struct {
 101     /* Basic options */
 102     char host[512];
 103     int port;
 104     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
 105     int close_on_exit;
 106     int warn_on_close;
 107     /* SSH options */
 108     int nopty;
 109     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 110     int try_tis_auth;
 111     /* Telnet options */
 112     char termtype[32];
 113     char termspeed[32];
 114     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 115     char username[32];
 116     int rfc_environ;
 117     /* Keyboard options */
 118     int bksp_is_delete;
 119     int rxvt_homeend;
 120     int linux_funkeys;
 121     int app_cursor;
 122     int app_keypad;
 123     int nethack_keypad;
 124     int alt_f4;                        /* is it special? */
 125     int alt_space;                     /* is it special? */
 126     int ldisc_term;
 127     /* Terminal options */
 128     int savelines;
 129     int dec_om;
 130     int wrap_mode;
 131     int lfhascr;
 132     int win_name_always;
 133     int width, height;
 134     char font[64];
 135     int fontisbold;
 136     int fontheight;
 137     int fontcharset;
 138     VT_Mode vtmode;
 139     /* Colour options */
 140     int try_palette;
 141     int bold_colour;
 142     unsigned char colours[22][3];
 143     /* Selection options */
 144     int mouse_is_xterm;
 145     short wordness[256];
 146     /* russian language translation */
 147     int xlat_enablekoiwin;
 148     int xlat_88592w1250;
 149     int xlat_capslockcyr;
 150 } Config;
 151
 152 /*
 153  * You can compile with -DSSH_DEFAULT to have ssh by default.
 154  */
 155 #ifndef SSH_DEFAULT
 156 #define DEFAULT_PROTOCOL PROT_TELNET
 157 #define DEFAULT_PORT 23
 158 #else
 159 #define DEFAULT_PROTOCOL PROT_SSH
 160 #define DEFAULT_PORT 22
 161 #endif
 162
 163 GLOBAL Config cfg;
 164 GLOBAL int default_protocol;
 165 GLOBAL int default_port;
 166
 167 struct RSAKey;                         /* be a little careful of scope */
 168
 169 /*
 170  * Exports from window.c.
 171  */
 172 void request_resize (int, int);
 173 void do_text (Context, int, int, char *, int, unsigned long);
 174 void set_title (char *);
 175 void set_icon (char *);
 176 void set_sbar (int, int, int);
 177 Context get_ctx(void);
 178 void free_ctx (Context);
 179 void palette_set (int, int, int, int);
 180 void palette_reset (void);
 181 void write_clip (void *, int);
 182 void get_clip (void **, int *);
 183 void optimised_move (int, int, int);
 184 void fatalbox (char *, ...);
 185 void beep (void);
 186 #define OPTIMISE_IS_SCROLL 1
 187
 188 /*
 189  * Exports from noise.c.
 190  */
 191 void noise_get_heavy(void (*func) (void *, int));
 192 void noise_get_light(void (*func) (void *, int));
 193 void noise_ultralight(DWORD data);
 194 void random_save_seed(void);
 195
 196 /*
 197  * Exports from windlg.c.
 198  */
 199 int do_config (void);
 200 int do_reconfig (HWND);
 201 void do_defaults (char *);
 202 void logevent (char *);
 203 void showeventlog (HWND);
 204 void showabout (HWND);
 205 void verify_ssh_host_key(char *host, struct RSAKey *key);
 206 void get_sesslist(int allocate);
 207
 208 GLOBAL int nsessions;
 209 GLOBAL char **sessions;
 210
 211 /*
 212  * Exports from terminal.c.
 213  */
 214
 215 void term_init (void);
 216 void term_size (int, int, int);
 217 void term_out (void);
 218 void term_paint (Context, int, int, int, int);
 219 void term_scroll (int, int);
 220 void term_pwron (void);
 221 void term_clrsb (void);
 222 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 223 void term_deselect (void);
 224 void term_update (void);
 225 void term_invalidate(void);
 226
 227 /*
 228  * Exports from raw.c.
 229  */
 230
 231 extern Backend raw_backend;
 232
 233 /*
 234  * Exports from telnet.c.
 235  */
 236
 237 extern Backend telnet_backend;
 238
 239 /*
 240  * Exports from ssh.c.
 241  */
 242
 243 extern Backend ssh_backend;
 244
 245 /*
 246  * Exports from ldisc.c.
 247  */
 248
 249 extern Ldisc ldisc_term, ldisc_simple;
 250
 251 /*
 252  * Exports from sshrand.c.
 253  */
 254
 255 void random_add_noise(void *noise, int length);
 256 void random_init(void);
 257 int random_byte(void);
 258 void random_get_savedata(void **data, int *len);
 259
 260 /*
 261  * Exports from misc.c.
 262  */
 263
 264 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 265 #ifdef MALLOC_LOG
 266 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 267 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 268 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 269 void mlog(char *, int);
 270 #else
 271 #define smalloc safemalloc
 272 #define srealloc saferealloc
 273 #define sfree safefree
 274 #endif
 275
 276 void *safemalloc(size_t);
 277 void *saferealloc(void *, size_t);
 278 void safefree(void *);
 279
 280 /*
 281  * Exports from version.c.
 282  */
 283 extern char ver[];
 284
 285 /*
 286  * Exports from sizetip.c.
 287  */
 288 void UpdateSizeTip(HWND src, int cx, int cy);
 289 void EnableSizeTip(int bEnable);
 290
 291 /*
 292  * Exports from xlat.c.
 293  */
 294 unsigned char xlat_kbd2tty(unsigned char c);
 295 unsigned char xlat_tty2scr(unsigned char c);
 296 unsigned char xlat_latkbd2win(unsigned char c);
 297
 298 /*
 299  * A debug system.
 300  */
 301 #ifdef DEBUG
 302 #include <stdarg.h>
 303 #define debug(x) (dprintf x)
 304 static void dprintf(char *fmt, ...) {
 305     char buf[2048];
 306     DWORD dw;
 307     va_list ap;
 308     static int gotconsole = 0;
 309
 310     if (!gotconsole) {
 311         AllocConsole();
 312         gotconsole = 1;
 313     }
 314
 315     va_start(ap, fmt);
 316     vsprintf(buf, fmt, ap);
 317     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 318     va_end(ap);
 319 }
 320 #else
 321 #define debug(x)
 322 #endif
 323
 324 #endif