putty.h

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