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 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, TS_PING
  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     int default_port;
 115 } Backend;
 116
 117 GLOBAL Backend *back;
 118
 119 extern struct backend_list {
 120     int protocol;
 121     char *name;
 122     Backend *backend;
 123 } backends[];
 124
 125 typedef struct {
 126     void (*send) (char *buf, int len);
 127 } Ldisc;
 128
 129 GLOBAL Ldisc *ldisc;
 130
 131 typedef struct {
 132     /* Basic options */
 133     char host[512];
 134     int port;
 135     enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
 136     int close_on_exit;
 137     int warn_on_close;
 138     int ping_interval;
 139     /* SSH options */
 140     char remote_cmd[512];
 141     int nopty;
 142     int agentfwd;
 143     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 144     char keyfile[FILENAME_MAX];
 145     int sshprot;                       /* use v1 or v2 when both available */
 146     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 147     int try_tis_auth;
 148     /* Telnet options */
 149     char termtype[32];
 150     char termspeed[32];
 151     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 152     char username[32];
 153     int rfc_environ;
 154     /* Keyboard options */
 155     int bksp_is_delete;
 156     int rxvt_homeend;
 157     int funky_type;
 158     int app_cursor;
 159     int app_keypad;
 160     int nethack_keypad;
 161     int alt_f4;                        /* is it special? */
 162     int alt_space;                     /* is it special? */
 163     int alt_only;                      /* is it special? */
 164     int ldisc_term;
 165     int scroll_on_key;
 166     int scroll_on_disp;
 167     int compose_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 void defuse_showwindow(void);
 272 int do_config (void);
 273 int do_reconfig (HWND);
 274 void do_defaults (char *, Config *);
 275 void logevent (char *);
 276 void showeventlog (HWND);
 277 void showabout (HWND);
 278 void verify_ssh_host_key(char *host, int port, char *keytype,
 279                          char *keystr, char *fingerprint);
 280 void registry_cleanup(void);
 281
 282 GLOBAL int nsessions;
 283 GLOBAL char **sessions;
 284
 285 /*
 286  * Exports from settings.c.
 287  */
 288 void save_settings (char *section, int do_host, Config *cfg);
 289 void load_settings (char *section, int do_host, Config *cfg);
 290 void get_sesslist(int allocate);
 291
 292 /*
 293  * Exports from terminal.c.
 294  */
 295
 296 void term_init (void);
 297 void term_size (int, int, int);
 298 void term_out (void);
 299 void term_paint (Context, int, int, int, int);
 300 void term_scroll (int, int);
 301 void term_pwron (void);
 302 void term_clrsb (void);
 303 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 304 void term_deselect (void);
 305 void term_update (void);
 306 void term_invalidate(void);
 307 void term_blink(int set_cursor);
 308 void term_paste(void);
 309 void term_nopaste(void);
 310 void from_backend(int is_stderr, char *data, int len);
 311
 312 /*
 313  * Exports from raw.c.
 314  */
 315
 316 extern Backend raw_backend;
 317
 318 /*
 319  * Exports from telnet.c.
 320  */
 321
 322 extern Backend telnet_backend;
 323
 324 /*
 325  * Exports from ssh.c.
 326  */
 327
 328 extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
 329 extern Backend ssh_backend;
 330
 331 /*
 332  * Exports from ldisc.c.
 333  */
 334
 335 extern Ldisc ldisc_term, ldisc_simple;
 336
 337 /*
 338  * Exports from sshrand.c.
 339  */
 340
 341 void random_add_noise(void *noise, int length);
 342 void random_init(void);
 343 int random_byte(void);
 344 void random_get_savedata(void **data, int *len);
 345
 346 /*
 347  * Exports from misc.c.
 348  */
 349
 350 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 351 #ifdef MALLOC_LOG
 352 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 353 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 354 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 355 void mlog(char *, int);
 356 #else
 357 #define smalloc safemalloc
 358 #define srealloc saferealloc
 359 #define sfree safefree
 360 #endif
 361
 362 void *safemalloc(size_t);
 363 void *saferealloc(void *, size_t);
 364 void safefree(void *);
 365
 366 /*
 367  * Exports from version.c.
 368  */
 369 extern char ver[];
 370
 371 /*
 372  * Exports from sizetip.c.
 373  */
 374 void UpdateSizeTip(HWND src, int cx, int cy);
 375 void EnableSizeTip(int bEnable);
 376
 377 /*
 378  * Exports from xlat.c.
 379  */
 380 unsigned char xlat_kbd2tty(unsigned char c);
 381 unsigned char xlat_tty2scr(unsigned char c);
 382 unsigned char xlat_latkbd2win(unsigned char c);
 383
 384 /*
 385  * Exports from mscrypto.c
 386  */
 387 #ifdef MSCRYPTOAPI
 388 int crypto_startup();
 389 void crypto_wrapup();
 390 #endif
 391
 392 /*
 393  * Exports from pageantc.c
 394  */
 395 void agent_query(void *in, int inlen, void **out, int *outlen);
 396 int agent_exists(void);
 397
 398 /*
 399  * A debug system.
 400  */
 401 #ifdef DEBUG
 402 #include <stdarg.h>
 403 #define debug(x) (dprintf x)
 404 static void dprintf(char *fmt, ...) {
 405     char buf[2048];
 406     DWORD dw;
 407     va_list ap;
 408     static int gotconsole = 0;
 409
 410     if (!gotconsole) {
 411         AllocConsole();
 412         gotconsole = 1;
 413     }
 414
 415     va_start(ap, fmt);
 416     vsprintf(buf, fmt, ap);
 417     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 418     va_end(ap);
 419 }
 420 #else
 421 #define debug(x)
 422 #endif
 423
 424 #endif