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     /* Basic options */
  96     char host[512];
  97     int port;
  98     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
  99     int close_on_exit;
 100     int warn_on_close;
 101     /* SSH options */
 102     int nopty;
 103     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 104     /* Telnet options */
 105     char termtype[32];
 106     char termspeed[32];
 107     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 108     char username[32];
 109     int rfc_environ;
 110     /* Keyboard options */
 111     int bksp_is_delete;
 112     int rxvt_homeend;
 113     int linux_funkeys;
 114     int app_cursor;
 115     int app_keypad;
 116     /* Terminal options */
 117     int savelines;
 118     int dec_om;
 119     int wrap_mode;
 120     int lfhascr;
 121     int win_name_always;
 122     int width, height;
 123     char font[64];
 124     int fontisbold;
 125     int fontheight;
 126     int fontcharset;
 127     VT_Mode vtmode;
 128     /* Colour options */
 129     int try_palette;
 130     int bold_colour;
 131     unsigned char colours[22][3];
 132     /* Selection options */
 133     int mouse_is_xterm;
 134     short wordness[256];
 135     /* russian language translation */
 136     int xlat_enablekoiwin;
 137     int xlat_capslockcyr;
 138 } Config;
 139
 140 /*
 141  * You can compile with -DSSH_DEFAULT to have ssh by default.
 142  */
 143 #ifndef SSH_DEFAULT
 144 #define DEFAULT_PROTOCOL PROT_TELNET
 145 #define DEFAULT_PORT 23
 146 #else
 147 #define DEFAULT_PROTOCOL PROT_SSH
 148 #define DEFAULT_PORT 22
 149 #endif
 150
 151 GLOBAL Config cfg;
 152 GLOBAL int default_protocol;
 153 GLOBAL int default_port;
 154
 155 /*
 156  * Exports from window.c.
 157  */
 158 void request_resize (int, int);
 159 void do_text (Context, int, int, char *, int, unsigned long);
 160 void set_title (char *);
 161 void set_icon (char *);
 162 void set_sbar (int, int, int);
 163 Context get_ctx(void);
 164 void free_ctx (Context);
 165 void palette_set (int, int, int, int);
 166 void palette_reset (void);
 167 void write_clip (void *, int);
 168 void get_clip (void **, int *);
 169 void optimised_move (int, int, int);
 170 void fatalbox (char *, ...);
 171 void beep (void);
 172 #define OPTIMISE_IS_SCROLL 1
 173
 174 /*
 175  * Exports from noise.c.
 176  */
 177 void noise_get_heavy(void (*func) (void *, int));
 178 void noise_get_light(void (*func) (void *, int));
 179 void noise_ultralight(DWORD data);
 180 void random_save_seed(void);
 181
 182 /*
 183  * Exports from windlg.c.
 184  */
 185 int do_config (void);
 186 int do_reconfig (HWND);
 187 void do_defaults (char *);
 188 void lognegot (char *);
 189 void shownegot (HWND);
 190 void showabout (HWND);
 191 void verify_ssh_host_key(char *host, struct RSAKey *key);
 192 void get_sesslist(int allocate);
 193
 194 GLOBAL int nsessions;
 195 GLOBAL char **sessions;
 196
 197 /*
 198  * Exports from terminal.c.
 199  */
 200
 201 void term_init (void);
 202 void term_size (int, int, int);
 203 void term_out (void);
 204 void term_paint (Context, int, int, int, int);
 205 void term_scroll (int, int);
 206 void term_pwron (void);
 207 void term_clrsb (void);
 208 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 209 void term_deselect (void);
 210 void term_update (void);
 211 void term_invalidate(void);
 212
 213 /*
 214  * Exports from raw.c.
 215  */
 216
 217 Backend raw_backend;
 218
 219 /*
 220  * Exports from telnet.c.
 221  */
 222
 223 extern Backend telnet_backend;
 224
 225 /*
 226  * Exports from ssh.c.
 227  */
 228
 229 extern Backend ssh_backend;
 230
 231 /*
 232  * Exports from sshrand.c.
 233  */
 234
 235 void random_add_noise(void *noise, int length);
 236 void random_init(void);
 237 int random_byte(void);
 238 void random_get_savedata(void **data, int *len);
 239
 240 /*
 241  * Exports from misc.c.
 242  */
 243
 244 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 245 #ifdef MALLOC_LOG
 246 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 247 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 248 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 249 void mlog(char *, int);
 250 #else
 251 #define smalloc safemalloc
 252 #define srealloc saferealloc
 253 #define sfree safefree
 254 #endif
 255
 256 void *safemalloc(size_t);
 257 void *saferealloc(void *, size_t);
 258 void safefree(void *);
 259
 260 /*
 261  * Exports from version.c.
 262  */
 263 extern char ver[];
 264
 265 /*
 266  * Exports from sizetip.c.
 267  */
 268 void UpdateSizeTip(HWND src, int cx, int cy);
 269 void EnableSizeTip(int bEnable);
 270
 271 /*
 272  * Exports from xlat.c.
 273  */
 274 unsigned char xlat_kbd2tty(unsigned char c);
 275 unsigned char xlat_tty2scr(unsigned char c);
 276 unsigned char xlat_latkbd2win(unsigned char c);
 277
 278 /*
 279  * A debug system.
 280  */
 281 #ifdef DEBUG
 282 #include <stdarg.h>
 283 #define debug(x) (dprintf x)
 284 static void dprintf(char *fmt, ...) {
 285     char buf[2048];
 286     DWORD dw;
 287     va_list ap;
 288     static int gotconsole = 0;
 289
 290     if (!gotconsole) {
 291         AllocConsole();
 292         gotconsole = 1;
 293     }
 294
 295     va_start(ap, fmt);
 296     vsprintf(buf, fmt, ap);
 297     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 298     va_end(ap);
 299 }
 300 #else
 301 #define debug(x)
 302 #endif
 303
 304 #endif