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