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