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 GLOBAL int seen_key_event;
  66 GLOBAL int seen_disp_event;
  67
  68 typedef enum {
  69     US_NONE = 0, US_KEY = 1, US_DISP = 2, US_BOTH = 3
  70 } Unscroll_Trigger;
  71
  72 GLOBAL Unscroll_Trigger unscroll_event;
  73
  74 #define WM_NETEVENT  (WM_USER + 1)
  75
  76 typedef enum {
  77     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
  78     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF
  79 } Telnet_Special;
  80
  81 typedef enum {
  82     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
  83 } Mouse_Button;
  84
  85 typedef enum {
  86     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
  87 } Mouse_Action;
  88
  89 typedef enum {
  90     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
  91 } VT_Mode;
  92
  93 typedef struct {
  94     char *(*init) (HWND hwnd, char *host, int port, char **realhost);
  95     int (*msg) (WPARAM wParam, LPARAM lParam);
  96     void (*send) (char *buf, int len);
  97     void (*size) (void);
  98     void (*special) (Telnet_Special code);
  99 } Backend;
 100
 101 GLOBAL Backend *back;
 102
 103 typedef struct {
 104     void (*send) (char *buf, int len);
 105 } Ldisc;
 106
 107 GLOBAL Ldisc *ldisc;
 108
 109 typedef struct {
 110     /* Basic options */
 111     char host[512];
 112     int port;
 113     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
 114     int close_on_exit;
 115     int warn_on_close;
 116     /* SSH options */
 117     int nopty;
 118     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 119     int try_tis_auth;
 120     /* Telnet options */
 121     char termtype[32];
 122     char termspeed[32];
 123     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 124     char username[32];
 125     int rfc_environ;
 126     /* Keyboard options */
 127     int bksp_is_delete;
 128     int rxvt_homeend;
 129     int linux_funkeys;
 130     int app_cursor;
 131     int app_keypad;
 132     int nethack_keypad;
 133     int alt_f4;                        /* is it special? */
 134     int alt_space;                     /* is it special? */
 135     int ldisc_term;
 136     /* Terminal options */
 137     int savelines;
 138     int dec_om;
 139     int wrap_mode;
 140     int lfhascr;
 141     int win_name_always;
 142     int width, height;
 143     char font[64];
 144     int fontisbold;
 145     int fontheight;
 146     int fontcharset;
 147     VT_Mode vtmode;
 148     /* Colour options */
 149     int try_palette;
 150     int bold_colour;
 151     unsigned char colours[22][3];
 152     /* Selection options */
 153     int mouse_is_xterm;
 154     short wordness[256];
 155     /* russian language translation */
 156     int xlat_enablekoiwin;
 157     int xlat_88592w1250;
 158     int xlat_capslockcyr;
 159 } Config;
 160
 161 /*
 162  * You can compile with -DSSH_DEFAULT to have ssh by default.
 163  */
 164 #ifndef SSH_DEFAULT
 165 #define DEFAULT_PROTOCOL PROT_TELNET
 166 #define DEFAULT_PORT 23
 167 #else
 168 #define DEFAULT_PROTOCOL PROT_SSH
 169 #define DEFAULT_PORT 22
 170 #endif
 171
 172 GLOBAL Config cfg;
 173 GLOBAL int default_protocol;
 174 GLOBAL int default_port;
 175
 176 struct RSAKey;                         /* be a little careful of scope */
 177
 178 /*
 179  * Exports from window.c.
 180  */
 181 void request_resize (int, int);
 182 void do_text (Context, int, int, char *, int, unsigned long);
 183 void set_title (char *);
 184 void set_icon (char *);
 185 void set_sbar (int, int, int);
 186 Context get_ctx(void);
 187 void free_ctx (Context);
 188 void palette_set (int, int, int, int);
 189 void palette_reset (void);
 190 void write_clip (void *, int);
 191 void get_clip (void **, int *);
 192 void optimised_move (int, int, int);
 193 void fatalbox (char *, ...);
 194 void beep (void);
 195 #define OPTIMISE_IS_SCROLL 1
 196
 197 /*
 198  * Exports from noise.c.
 199  */
 200 void noise_get_heavy(void (*func) (void *, int));
 201 void noise_get_light(void (*func) (void *, int));
 202 void noise_ultralight(DWORD data);
 203 void random_save_seed(void);
 204
 205 /*
 206  * Exports from windlg.c.
 207  */
 208 int do_config (void);
 209 int do_reconfig (HWND);
 210 void do_defaults (char *);
 211 void logevent (char *);
 212 void showeventlog (HWND);
 213 void showabout (HWND);
 214 void verify_ssh_host_key(char *host, struct RSAKey *key);
 215 void get_sesslist(int allocate);
 216
 217 GLOBAL int nsessions;
 218 GLOBAL char **sessions;
 219
 220 /*
 221  * Exports from terminal.c.
 222  */
 223
 224 void term_init (void);
 225 void term_size (int, int, int);
 226 void term_out (void);
 227 void term_paint (Context, int, int, int, int);
 228 void term_scroll (int, int);
 229 void term_pwron (void);
 230 void term_clrsb (void);
 231 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 232 void term_deselect (void);
 233 void term_update (void);
 234 void term_invalidate(void);
 235
 236 /*
 237  * Exports from raw.c.
 238  */
 239
 240 extern Backend raw_backend;
 241
 242 /*
 243  * Exports from telnet.c.
 244  */
 245
 246 extern Backend telnet_backend;
 247
 248 /*
 249  * Exports from ssh.c.
 250  */
 251
 252 extern Backend ssh_backend;
 253
 254 /*
 255  * Exports from ldisc.c.
 256  */
 257
 258 extern Ldisc ldisc_term, ldisc_simple;
 259
 260 /*
 261  * Exports from sshrand.c.
 262  */
 263
 264 void random_add_noise(void *noise, int length);
 265 void random_init(void);
 266 int random_byte(void);
 267 void random_get_savedata(void **data, int *len);
 268
 269 /*
 270  * Exports from misc.c.
 271  */
 272
 273 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 274 #ifdef MALLOC_LOG
 275 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 276 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 277 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 278 void mlog(char *, int);
 279 #else
 280 #define smalloc safemalloc
 281 #define srealloc saferealloc
 282 #define sfree safefree
 283 #endif
 284
 285 void *safemalloc(size_t);
 286 void *saferealloc(void *, size_t);
 287 void safefree(void *);
 288
 289 /*
 290  * Exports from version.c.
 291  */
 292 extern char ver[];
 293
 294 /*
 295  * Exports from sizetip.c.
 296  */
 297 void UpdateSizeTip(HWND src, int cx, int cy);
 298 void EnableSizeTip(int bEnable);
 299
 300 /*
 301  * Exports from xlat.c.
 302  */
 303 unsigned char xlat_kbd2tty(unsigned char c);
 304 unsigned char xlat_tty2scr(unsigned char c);
 305 unsigned char xlat_latkbd2win(unsigned char c);
 306
 307 /*
 308  * A debug system.
 309  */
 310 #ifdef DEBUG
 311 #include <stdarg.h>
 312 #define debug(x) (dprintf x)
 313 static void dprintf(char *fmt, ...) {
 314     char buf[2048];
 315     DWORD dw;
 316     va_list ap;
 317     static int gotconsole = 0;
 318
 319     if (!gotconsole) {
 320         AllocConsole();
 321         gotconsole = 1;
 322     }
 323
 324     va_start(ap, fmt);
 325     vsprintf(buf, fmt, ap);
 326     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 327     va_end(ap);
 328 }
 329 #else
 330 #define debug(x)
 331 #endif
 332
 333 #endif