putty.h

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