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     SOCKET (*socket) (void);
 113 } Backend;
 114
 115 GLOBAL Backend *back;
 116
 117 extern struct backend_list {
 118     int protocol;
 119     char *name;
 120     Backend *backend;
 121 } backends[];
 122
 123 typedef struct {
 124     void (*send) (char *buf, int len);
 125 } Ldisc;
 126
 127 GLOBAL Ldisc *ldisc;
 128
 129 typedef struct {
 130     /* Basic options */
 131     char host[512];
 132     int port;
 133     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
 134     int close_on_exit;
 135     int warn_on_close;
 136     /* SSH options */
 137     int nopty;
 138     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 139     char keyfile[FILENAME_MAX];
 140     int try_tis_auth;
 141     /* Telnet options */
 142     char termtype[32];
 143     char termspeed[32];
 144     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 145     char username[32];
 146     int rfc_environ;
 147     /* Keyboard options */
 148     int bksp_is_delete;
 149     int rxvt_homeend;
 150     int funky_type;
 151     int app_cursor;
 152     int app_keypad;
 153     int nethack_keypad;
 154     int alt_f4;                        /* is it special? */
 155     int alt_space;                     /* is it special? */
 156     int ldisc_term;
 157     int scroll_on_key;
 158     /* Terminal options */
 159     int savelines;
 160     int dec_om;
 161     int wrap_mode;
 162     int lfhascr;
 163     int blink_cur;
 164     int beep;
 165     int scrollbar;
 166     int locksize;
 167     int bce;
 168     int blinktext;
 169     int win_name_always;
 170     int width, height;
 171     char font[64];
 172     int fontisbold;
 173     int fontheight;
 174     int fontcharset;
 175     /* Colour options */
 176     int try_palette;
 177     int bold_colour;
 178     unsigned char colours[22][3];
 179     /* Selection options */
 180     int mouse_is_xterm;
 181     short wordness[256];
 182     /* translations */
 183     VT_Mode vtmode;
 184     int xlat_enablekoiwin;
 185     int xlat_88592w1250;
 186     int xlat_capslockcyr;
 187 } Config;
 188
 189 /*
 190  * You can compile with -DSSH_DEFAULT to have ssh by default.
 191  */
 192 #ifndef SSH_DEFAULT
 193 #define DEFAULT_PROTOCOL PROT_TELNET
 194 #define DEFAULT_PORT 23
 195 #else
 196 #define DEFAULT_PROTOCOL PROT_SSH
 197 #define DEFAULT_PORT 22
 198 #endif
 199
 200 /*
 201  * Some global flags denoting the type of application.
 202  */
 203 #define FLAG_VERBOSE  0x0001
 204 #define FLAG_WINDOWED 0x0002
 205 #define FLAG_CONNECTION 0x0004
 206 GLOBAL int flags;
 207
 208 GLOBAL Config cfg;
 209 GLOBAL int default_protocol;
 210 GLOBAL int default_port;
 211
 212 struct RSAKey;                         /* be a little careful of scope */
 213
 214 /*
 215  * Exports from window.c.
 216  */
 217 void request_resize (int, int, int);
 218 void do_text (Context, int, int, char *, int, unsigned long, int);
 219 void set_title (char *);
 220 void set_icon (char *);
 221 void set_sbar (int, int, int);
 222 Context get_ctx(void);
 223 void free_ctx (Context);
 224 void palette_set (int, int, int, int);
 225 void palette_reset (void);
 226 void write_clip (void *, int);
 227 void get_clip (void **, int *);
 228 void optimised_move (int, int, int);
 229 void fatalbox (char *, ...);
 230 void beep (int);
 231 #define OPTIMISE_IS_SCROLL 1
 232
 233 /*
 234  * Exports from noise.c.
 235  */
 236 void noise_get_heavy(void (*func) (void *, int));
 237 void noise_get_light(void (*func) (void *, int));
 238 void noise_ultralight(DWORD data);
 239 void random_save_seed(void);
 240
 241 /*
 242  * Exports from windlg.c.
 243  */
 244 int do_config (void);
 245 int do_reconfig (HWND);
 246 void do_defaults (char *);
 247 void logevent (char *);
 248 void showeventlog (HWND);
 249 void showabout (HWND);
 250 void verify_ssh_host_key(char *host, char *keystr);
 251 void get_sesslist(int allocate);
 252
 253 GLOBAL int nsessions;
 254 GLOBAL char **sessions;
 255
 256 /*
 257  * Exports from terminal.c.
 258  */
 259
 260 void term_init (void);
 261 void term_size (int, int, int);
 262 void term_out (void);
 263 void term_paint (Context, int, int, int, int);
 264 void term_scroll (int, int);
 265 void term_pwron (void);
 266 void term_clrsb (void);
 267 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 268 void term_deselect (void);
 269 void term_update (void);
 270 void term_invalidate(void);
 271 void term_blink(int set_cursor);
 272 void term_paste(void);
 273 void term_nopaste(void);
 274
 275 /*
 276  * Exports from raw.c.
 277  */
 278
 279 extern Backend raw_backend;
 280
 281 /*
 282  * Exports from telnet.c.
 283  */
 284
 285 extern Backend telnet_backend;
 286
 287 /*
 288  * Exports from ssh.c.
 289  */
 290
 291 extern Backend ssh_backend;
 292
 293 /*
 294  * Exports from ldisc.c.
 295  */
 296
 297 extern Ldisc ldisc_term, ldisc_simple;
 298
 299 /*
 300  * Exports from sshrand.c.
 301  */
 302
 303 void random_add_noise(void *noise, int length);
 304 void random_init(void);
 305 int random_byte(void);
 306 void random_get_savedata(void **data, int *len);
 307
 308 /*
 309  * Exports from misc.c.
 310  */
 311
 312 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 313 #ifdef MALLOC_LOG
 314 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 315 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 316 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 317 void mlog(char *, int);
 318 #else
 319 #define smalloc safemalloc
 320 #define srealloc saferealloc
 321 #define sfree safefree
 322 #endif
 323
 324 void *safemalloc(size_t);
 325 void *saferealloc(void *, size_t);
 326 void safefree(void *);
 327
 328 /*
 329  * Exports from version.c.
 330  */
 331 extern char ver[];
 332
 333 /*
 334  * Exports from sizetip.c.
 335  */
 336 void UpdateSizeTip(HWND src, int cx, int cy);
 337 void EnableSizeTip(int bEnable);
 338
 339 /*
 340  * Exports from xlat.c.
 341  */
 342 unsigned char xlat_kbd2tty(unsigned char c);
 343 unsigned char xlat_tty2scr(unsigned char c);
 344 unsigned char xlat_latkbd2win(unsigned char c);
 345
 346 /*
 347  * Exports from mscrypto.c
 348  */
 349 #ifdef MSCRYPTOAPI
 350 int crypto_startup();
 351 void crypto_wrapup();
 352 #endif
 353
 354 /*
 355  * A debug system.
 356  */
 357 #ifdef DEBUG
 358 #include <stdarg.h>
 359 #define debug(x) (dprintf x)
 360 static void dprintf(char *fmt, ...) {
 361     char buf[2048];
 362     DWORD dw;
 363     va_list ap;
 364     static int gotconsole = 0;
 365
 366     if (!gotconsole) {
 367         AllocConsole();
 368         gotconsole = 1;
 369     }
 370
 371     va_start(ap, fmt);
 372     vsprintf(buf, fmt, ap);
 373     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 374     va_end(ap);
 375 }
 376 #else
 377 #define debug(x)
 378 #endif
 379
 380 #endif