git.distorted.org.uk Git - u/mdw/putty/blob - 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 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
  22 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
  23 #define ATTR_INVALID 0x20000000UL
  24 #define ATTR_WRAPPED 0x10000000UL
  25
  26 #define LATTR_NORM   0x00000000UL
  27 #define LATTR_WIDE   0x01000000UL
  28 #define LATTR_TOP    0x02000000UL
  29 #define LATTR_BOT    0x03000000UL
  30 #define LATTR_MODE   0x03000000UL
  31
  32 #define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
  33 #define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
  34 #define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
  35
  36 #define ATTR_BOLD    0x00000100UL
  37 #define ATTR_UNDER   0x00000200UL
  38 #define ATTR_REVERSE 0x00000400UL
  39 #define ATTR_BLINK   0x00000800UL
  40 #define ATTR_FGMASK  0x0000F000UL
  41 #define ATTR_BGMASK  0x000F0000UL
  42 #define ATTR_FGSHIFT 12
  43 #define ATTR_BGSHIFT 16
  44
  45 #define ATTR_DEFAULT 0x00098000UL
  46 #define ATTR_DEFFG   0x00008000UL
  47 #define ATTR_DEFBG   0x00090000UL
  48 #define ATTR_CUR_XOR 0x000BA000UL
  49 #define ERASE_CHAR   (ATTR_DEFAULT | ' ')
  50 #define ATTR_MASK    0xFFFFFF00UL
  51 #define CHAR_MASK    0x000000FFUL
  52
  53 typedef HDC Context;
  54 #define SEL_NL { 13, 10 }
  55
  56 GLOBAL int rows, cols, savelines;
  57
  58 GLOBAL int font_width, font_height;
  59
  60 #define c_write1(_C) do { if (inbuf_head >= INBUF_SIZE) term_out(); \
  61                           inbuf[inbuf_head++] = (_C) ; } while(0)
  62 #define INBUF_SIZE 2048
  63 GLOBAL unsigned char inbuf[INBUF_SIZE];
  64 GLOBAL int inbuf_head;
  65
  66 #define OUTBUF_SIZE 2048
  67 #define OUTBUF_MASK (OUTBUF_SIZE-1)
  68 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
  69 GLOBAL int outbuf_head, outbuf_reap;
  70
  71 GLOBAL int has_focus;
  72
  73 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
  74 GLOBAL int repeat_off, cr_lf_return;
  75
  76 GLOBAL int seen_key_event;
  77 GLOBAL int seen_disp_event;
  78
  79 GLOBAL int session_closed;
  80
  81 GLOBAL char *logfile;
  82
  83 /*
  84  * I've just looked in the windows standard headr files for WM_USER, there
  85  * are hundreds of flags defined using the form WM_USER+123 so I've
  86  * renumbered this NETEVENT value and the two in window.c
  87  */
  88 #define WM_XUSER     (WM_USER + 0x2000)
  89 #define WM_NETEVENT  (WM_XUSER + 5)
  90
  91 typedef enum {
  92     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
  93     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
  94 } Telnet_Special;
  95
  96 typedef enum {
  97     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
  98 } Mouse_Button;
  99
 100 typedef enum {
 101     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 102 } Mouse_Action;
 103
 104 typedef enum {
 105     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
 106 } VT_Mode;
 107
 108 typedef struct {
 109     char *(*init) (HWND hwnd, char *host, int port, char **realhost);
 110     int (*msg) (WPARAM wParam, LPARAM lParam);
 111     void (*send) (char *buf, int len);
 112     void (*size) (void);
 113     void (*special) (Telnet_Special code);
 114     SOCKET (*socket) (void);
 115     int (*sendok) (void);
 116     int default_port;
 117 } Backend;
 118
 119 GLOBAL Backend *back;
 120
 121 extern struct backend_list {
 122     int protocol;
 123     char *name;
 124     Backend *backend;
 125 } backends[];
 126
 127 typedef struct {
 128     void (*send) (char *buf, int len);
 129 } Ldisc;
 130
 131 GLOBAL Ldisc *ldisc;
 132
 133 typedef struct {
 134     /* Basic options */
 135     char host[512];
 136     int port;
 137     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
 138     int close_on_exit;
 139     int warn_on_close;
 140     int ping_interval;
 141     /* SSH options */
 142     char remote_cmd[512];
 143     int nopty;
 144     int agentfwd;
 145     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 146     char keyfile[FILENAME_MAX];
 147     int sshprot;                       /* use v1 or v2 when both available */
 148     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 149     int try_tis_auth;
 150     /* Telnet options */
 151     char termtype[32];
 152     char termspeed[32];
 153     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 154     char username[32];
 155     int rfc_environ;
 156     /* Keyboard options */
 157     int bksp_is_delete;
 158     int rxvt_homeend;
 159     int funky_type;
 160     int app_cursor;
 161     int app_keypad;
 162     int nethack_keypad;
 163     int alt_f4;                        /* is it special? */
 164     int alt_space;                     /* is it special? */
 165     int ldisc_term;
 166     int scroll_on_key;
 167     char wintitle[256];                /* initial window title */
 168     /* Terminal options */
 169     int savelines;
 170     int dec_om;
 171     int wrap_mode;
 172     int lfhascr;
 173     int blink_cur;
 174     int beep;
 175     int scrollbar;
 176     int locksize;
 177     int bce;
 178     int blinktext;
 179     int win_name_always;
 180     int width, height;
 181     char font[64];
 182     int fontisbold;
 183     int fontheight;
 184     int fontcharset;
 185     /* Colour options */
 186     int try_palette;
 187     int bold_colour;
 188     unsigned char colours[22][3];
 189     /* Selection options */
 190     int mouse_is_xterm;
 191     short wordness[256];
 192     /* translations */
 193     VT_Mode vtmode;
 194     int xlat_enablekoiwin;
 195     int xlat_88592w1250;
 196     int xlat_88592cp852;
 197     int xlat_capslockcyr;
 198 } Config;
 199
 200 /*
 201  * You can compile with -DSSH_DEFAULT to have ssh by default.
 202  */
 203 #ifndef SSH_DEFAULT
 204 #define DEFAULT_PROTOCOL PROT_TELNET
 205 #define DEFAULT_PORT 23
 206 #else
 207 #define DEFAULT_PROTOCOL PROT_SSH
 208 #define DEFAULT_PORT 22
 209 #endif
 210
 211 /*
 212  * Some global flags denoting the type of application.
 213  *
 214  * FLAG_VERBOSE is set when the user requests verbose details.
 215  *
 216  * FLAG_STDERR is set in command-line applications (which have a
 217  * functioning stderr that it makes sense to write to) and not in
 218  * GUI applications (which don't).
 219  *
 220  * FLAG_INTERACTIVE is set when a full interactive shell session is
 221  * being run, _either_ because no remote command has been provided
 222  * _or_ because the application is GUI and can't run non-
 223  * interactively.
 224  */
 225 #define FLAG_VERBOSE     0x0001
 226 #define FLAG_STDERR      0x0002
 227 #define FLAG_INTERACTIVE 0x0004
 228 GLOBAL int flags;
 229
 230 GLOBAL Config cfg;
 231 GLOBAL int default_protocol;
 232 GLOBAL int default_port;
 233
 234 struct RSAKey;                         /* be a little careful of scope */
 235
 236 /*
 237  * Exports from window.c.
 238  */
 239 void request_resize (int, int, int);
 240 void do_text (Context, int, int, char *, int, unsigned long, int);
 241 void set_title (char *);
 242 void set_icon (char *);
 243 void set_sbar (int, int, int);
 244 Context get_ctx(void);
 245 void free_ctx (Context);
 246 void palette_set (int, int, int, int);
 247 void palette_reset (void);
 248 void write_clip (void *, int, int);
 249 void get_clip (void **, int *);
 250 void optimised_move (int, int, int);
 251 void connection_fatal(char *, ...);
 252 void fatalbox (char *, ...);
 253 void beep (int);
 254 void begin_session(void);
 255 void sys_cursor(int x, int y);
 256 #define OPTIMISE_IS_SCROLL 1
 257
 258 /*
 259  * Exports from noise.c.
 260  */
 261 void noise_get_heavy(void (*func) (void *, int));
 262 void noise_get_light(void (*func) (void *, int));
 263 void noise_ultralight(DWORD data);
 264 void random_save_seed(void);
 265 void random_destroy_seed(void);
 266
 267 /*
 268  * Exports from windlg.c.
 269  */
 270 void defuse_showwindow(void);
 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