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