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 /* Three attribute types:
  24  * The ATTRs (normal attributes) are stored with the characters in the main
  25  * display arrays
  26  *
  27  * The TATTRs (temporary attributes) are generated on the fly, they can overlap
  28  * with characters but not with normal attributes.
  29  *
  30  * The LATTRs (line attributes) conflict with no others and only have one
  31  * value per line. But on area clears the LATTR cells are set to the erase_char
  32  * (or DEFAULT_ATTR + 'E')
  33  *
  34  * ATTR_INVALID is an illegal colour combination.
  35  */
  36
  37 #define TATTR_ACTCURS       0x4UL      /* active cursor (block) */
  38 #define TATTR_PASCURS       0x2UL      /* passive cursor (box) */
  39 #define TATTR_RIGHTCURS     0x1UL      /* cursor-on-RHS */
  40
  41 #define LATTR_NORM   0x00000000UL
  42 #define LATTR_WIDE   0x01000000UL
  43 #define LATTR_TOP    0x02000000UL
  44 #define LATTR_BOT    0x03000000UL
  45 #define LATTR_MODE   0x03000000UL
  46 #define LATTR_WRAPPED 0x10000000UL
  47
  48 #define ATTR_INVALID 0x00FF0000UL
  49
  50 /* Like Linux use the F000 page for direct to font. */
  51 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  52 #define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  53
  54 /* These are internal use overlapping with the UTF-16 surrogates */
  55 #define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  56 #define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  57 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  58 #define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  59 #define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */
  60
  61 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
  62 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
  63
  64 #define UCSERR       (ATTR_LINEDRW|'a') /* UCS Format error character. */
  65 #define UCSWIDE      0x303F
  66
  67 #define ATTR_WIDE    0x10000000UL
  68 #define ATTR_BOLD    0x01000000UL
  69 #define ATTR_UNDER   0x02000000UL
  70 #define ATTR_REVERSE 0x04000000UL
  71 #define ATTR_BLINK   0x08000000UL
  72 #define ATTR_FGMASK  0x000F0000UL
  73 #define ATTR_BGMASK  0x00F00000UL
  74 #define ATTR_COLOURS 0x00FF0000UL
  75 #define ATTR_FGSHIFT 16
  76 #define ATTR_BGSHIFT 20
  77
  78 #define ATTR_DEFAULT 0x00980000UL
  79 #define ATTR_DEFFG   0x00080000UL
  80 #define ATTR_DEFBG   0x00900000UL
  81 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
  82 #define ATTR_MASK    0xFFFFFF00UL
  83 #define CHAR_MASK    0x000000FFUL
  84
  85 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
  86 #define ATTR_CUR_XOR 0x00BA0000UL
  87
  88 typedef HDC Context;
  89 #define SEL_NL { 13, 10 }
  90
  91 GLOBAL int rows, cols, savelines;
  92
  93 GLOBAL int font_width, font_height;
  94
  95 #define INBUF_SIZE 2048
  96 GLOBAL unsigned char inbuf[INBUF_SIZE];
  97 GLOBAL int inbuf_head;
  98
  99 #define OUTBUF_SIZE 2048
 100 #define OUTBUF_MASK (OUTBUF_SIZE-1)
 101 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
 102 GLOBAL int outbuf_head, outbuf_reap;
 103
 104 GLOBAL int has_focus;
 105
 106 GLOBAL int in_vbell;
 107 GLOBAL long vbell_timeout;
 108
 109 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
 110 GLOBAL int repeat_off, cr_lf_return;
 111
 112 GLOBAL int seen_key_event;
 113 GLOBAL int seen_disp_event;
 114
 115 GLOBAL int session_closed;
 116
 117 GLOBAL int big_cursor;
 118
 119 GLOBAL int utf;
 120 GLOBAL int dbcs_screenfont;
 121 GLOBAL int font_codepage;
 122 GLOBAL int kbd_codepage;
 123 GLOBAL int line_codepage;
 124 GLOBAL WCHAR unitab_scoacs[256];
 125 GLOBAL WCHAR unitab_line[256];
 126 GLOBAL WCHAR unitab_font[256];
 127 GLOBAL WCHAR unitab_xterm[256];
 128 GLOBAL WCHAR unitab_oemcp[256];
 129 GLOBAL unsigned char unitab_ctrl[256];
 130 #define in_utf (utf || line_codepage==CP_UTF8)
 131
 132 #define LGXF_OVR  1                    /* existing logfile overwrite */
 133 #define LGXF_APN  0                    /* existing logfile append */
 134 #define LGXF_ASK -1                    /* existing logfile ask */
 135 #define LGTYP_NONE  0                  /* logmode: no logging */
 136 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 137 #define LGTYP_DEBUG 2                  /* logmode: all chars of taffic */
 138 GLOBAL char *logfile;
 139
 140 /*
 141  * Window handles for the dialog boxes that can be running during a
 142  * PuTTY session.
 143  */
 144 GLOBAL HWND logbox;
 145
 146 /*
 147  * I've just looked in the windows standard headr files for WM_USER, there
 148  * are hundreds of flags defined using the form WM_USER+123 so I've
 149  * renumbered this NETEVENT value and the two in window.c
 150  */
 151 #define WM_XUSER     (WM_USER + 0x2000)
 152 #define WM_NETEVENT  (WM_XUSER + 5)
 153
 154 typedef enum {
 155     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 156     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 157     TS_EOL
 158 } Telnet_Special;
 159
 160 typedef enum {
 161     MBT_NOTHING,
 162     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 163     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 164     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 165 } Mouse_Button;
 166
 167 typedef enum {
 168     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 169 } Mouse_Action;
 170
 171 typedef enum {
 172     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 173 } VT_Mode;
 174
 175 enum {
 176     /*
 177      * Line discipline option states: off, on, up to the backend.
 178      */
 179     LD_YES, LD_NO, LD_BACKEND
 180 };
 181
 182 enum {
 183     /*
 184      * Line discipline options which the backend might try to control.
 185      */
 186     LD_EDIT,                           /* local line editing */
 187     LD_ECHO                            /* local echo */
 188 };
 189
 190 enum {
 191     /*
 192      * Close On Exit behaviours. (cfg.close_on_exit)
 193      */
 194     COE_NEVER,                         /* Never close the window */
 195     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
 196     COE_ALWAYS                         /* Always close the window */
 197 };
 198
 199 typedef struct {
 200     char *(*init) (char *host, int port, char **realhost);
 201     void (*send) (char *buf, int len);
 202     void (*size) (void);
 203     void (*special) (Telnet_Special code);
 204      Socket(*socket) (void);
 205     int (*sendok) (void);
 206     int (*ldisc) (int);
 207     int default_port;
 208 } Backend;
 209
 210 GLOBAL Backend *back;
 211
 212 extern struct backend_list {
 213     int protocol;
 214     char *name;
 215     Backend *backend;
 216 } backends[];
 217
 218 typedef struct {
 219     /* Basic options */
 220     char host[512];
 221     int port;
 222     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 223     int close_on_exit;
 224     int warn_on_close;
 225     int ping_interval;                 /* in seconds */
 226     /* SSH options */
 227     char remote_cmd[512];
 228     char *remote_cmd_ptr;              /* might point to a larger command
 229                                         * but never for loading/saving */
 230     int nopty;
 231     int compression;
 232     int agentfwd;
 233     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
 234     char keyfile[FILENAME_MAX];
 235     int sshprot;                       /* use v1 or v2 when both available */
 236     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 237     int try_tis_auth;
 238     int ssh_subsys;                    /* run a subsystem rather than a command */
 239     /* Telnet options */
 240     char termtype[32];
 241     char termspeed[32];
 242     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 243     char username[32];
 244     char localusername[32];
 245     int rfc_environ;
 246     int passive_telnet;
 247     /* Keyboard options */
 248     int bksp_is_delete;
 249     int rxvt_homeend;
 250     int funky_type;
 251     int no_applic_c;                   /* totally disable app cursor keys */
 252     int no_applic_k;                   /* totally disable app keypad */
 253     int app_cursor;
 254     int app_keypad;
 255     int nethack_keypad;
 256     int telnet_keyboard;
 257     int alt_f4;                        /* is it special? */
 258     int alt_space;                     /* is it special? */
 259     int alt_only;                      /* is it special? */
 260     int localecho;
 261     int localedit;
 262     int alwaysontop;
 263     int scroll_on_key;
 264     int scroll_on_disp;
 265     int compose_key;
 266     int ctrlaltkeys;
 267     char wintitle[256];                /* initial window title */
 268     /* Terminal options */
 269     int savelines;
 270     int dec_om;
 271     int wrap_mode;
 272     int lfhascr;
 273     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 274     int blink_cur;
 275     enum {
 276         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 277     } beep;
 278     enum {
 279         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 280     } beep_ind;
 281     int bellovl;                       /* bell overload protection active? */
 282     int bellovl_n;                     /* number of bells to cause overload */
 283     int bellovl_t;                     /* time interval for overload (seconds) */
 284     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 285     char bell_wavefile[FILENAME_MAX];
 286     int scrollbar;
 287     int locksize;
 288     int bce;
 289     int blinktext;
 290     int win_name_always;
 291     int width, height;
 292     char font[64];
 293     int fontisbold;
 294     int fontheight;
 295     int fontcharset;
 296     char logfilename[FILENAME_MAX];
 297     int logtype;
 298     int logxfovr;
 299     int hide_mouseptr;
 300     int sunken_edge;
 301     char answerback[256];
 302     /* Colour options */
 303     int try_palette;
 304     int bold_colour;
 305     unsigned char colours[22][3];
 306     /* Selection options */
 307     int mouse_is_xterm;
 308     int rawcnp;
 309     short wordness[256];
 310     /* translations */
 311     VT_Mode vtmode;
 312     char line_codepage[32];
 313     /* X11 forwarding */
 314     int x11_forward;
 315     char x11_display[128];
 316 } Config;
 317
 318 /*
 319  * You can compile with -DSSH_DEFAULT to have ssh by default.
 320  */
 321 #ifndef SSH_DEFAULT
 322 #define DEFAULT_PROTOCOL PROT_TELNET
 323 #define DEFAULT_PORT 23
 324 #else
 325 #define DEFAULT_PROTOCOL PROT_SSH
 326 #define DEFAULT_PORT 22
 327 #endif
 328
 329 /*
 330  * Some global flags denoting the type of application.
 331  *
 332  * FLAG_VERBOSE is set when the user requests verbose details.
 333  *
 334  * FLAG_STDERR is set in command-line applications (which have a
 335  * functioning stderr that it makes sense to write to) and not in
 336  * GUI applications (which don't).
 337  *
 338  * FLAG_INTERACTIVE is set when a full interactive shell session is
 339  * being run, _either_ because no remote command has been provided
 340  * _or_ because the application is GUI and can't run non-
 341  * interactively.
 342  */
 343 #define FLAG_VERBOSE     0x0001
 344 #define FLAG_STDERR      0x0002
 345 #define FLAG_INTERACTIVE 0x0004
 346 GLOBAL int flags;
 347
 348 GLOBAL Config cfg;
 349 GLOBAL int default_protocol;
 350 GLOBAL int default_port;
 351
 352 struct RSAKey;                         /* be a little careful of scope */
 353
 354 /*
 355  * Exports from window.c.
 356  */
 357 void request_resize(int, int, int);
 358 void do_text(Context, int, int, char *, int, unsigned long, int);
 359 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 360 void set_title(char *);
 361 void set_icon(char *);
 362 void set_sbar(int, int, int);
 363 Context get_ctx(void);
 364 void free_ctx(Context);
 365 void palette_set(int, int, int, int);
 366 void palette_reset(void);
 367 void write_aclip(char *, int, int);
 368 void write_clip(wchar_t *, int, int);
 369 void get_clip(wchar_t **, int *);
 370 void optimised_move(int, int, int);
 371 void set_raw_mouse_mode(int);
 372 Mouse_Button translate_button(Mouse_Button b);
 373 void connection_fatal(char *, ...);
 374 void fatalbox(char *, ...);
 375 void beep(int);
 376 void begin_session(void);
 377 void sys_cursor(int x, int y);
 378 #define OPTIMISE_IS_SCROLL 1
 379
 380 /*
 381  * Exports from noise.c.
 382  */
 383 void noise_get_heavy(void (*func) (void *, int));
 384 void noise_get_light(void (*func) (void *, int));
 385 void noise_regular(void);
 386 void noise_ultralight(DWORD data);
 387 void random_save_seed(void);
 388 void random_destroy_seed(void);
 389
 390 /*
 391  * Exports from windlg.c.
 392  */
 393 void defuse_showwindow(void);
 394 int do_config(void);
 395 int do_reconfig(HWND);
 396 void do_defaults(char *, Config *);
 397 void logevent(char *);
 398 void showeventlog(HWND);
 399 void showabout(HWND);
 400 void verify_ssh_host_key(char *host, int port, char *keytype,
 401                          char *keystr, char *fingerprint);
 402 int askappend(char *filename);
 403 void registry_cleanup(void);
 404 void force_normal(HWND hwnd);
 405
 406 GLOBAL int nsessions;
 407 GLOBAL char **sessions;
 408
 409 /*
 410  * Exports from settings.c.
 411  */
 412 void save_settings(char *section, int do_host, Config * cfg);
 413 void load_settings(char *section, int do_host, Config * cfg);
 414 void get_sesslist(int allocate);
 415
 416 /*
 417  * Exports from terminal.c.
 418  */
 419
 420 void term_init(void);
 421 void term_size(int, int, int);
 422 void term_out(void);
 423 void term_paint(Context, int, int, int, int);
 424 void term_scroll(int, int);
 425 void term_pwron(void);
 426 void term_clrsb(void);
 427 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int);
 428 void term_deselect(void);
 429 void term_update(void);
 430 void term_invalidate(void);
 431 void term_blink(int set_cursor);
 432 void term_do_paste(void);
 433 void term_paste(void);
 434 void term_nopaste(void);
 435 int term_ldisc(int option);
 436 void from_backend(int is_stderr, char *data, int len);
 437 void logfopen(void);
 438 void logfclose(void);
 439 void term_copyall(void);
 440
 441 /*
 442  * Exports from raw.c.
 443  */
 444
 445 extern Backend raw_backend;
 446
 447 /*
 448  * Exports from rlogin.c.
 449  */
 450
 451 extern Backend rlogin_backend;
 452
 453 /*
 454  * Exports from telnet.c.
 455  */
 456
 457 extern Backend telnet_backend;
 458
 459 /*
 460  * Exports from ssh.c.
 461  */
 462
 463 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 464                             int is_pw);
 465 extern Backend ssh_backend;
 466
 467 /*
 468  * Exports from ldisc.c.
 469  */
 470
 471 extern void ldisc_send(char *buf, int len);
 472
 473 /*
 474  * Exports from sshrand.c.
 475  */
 476
 477 void random_add_noise(void *noise, int length);
 478 void random_init(void);
 479 int random_byte(void);
 480 void random_get_savedata(void **data, int *len);
 481
 482 /*
 483  * Exports from misc.c.
 484  */
 485
 486 #include "misc.h"
 487
 488 /*
 489  * Exports from version.c.
 490  */
 491 extern char ver[];
 492
 493 /*
 494  * Exports from sizetip.c.
 495  */
 496 void UpdateSizeTip(HWND src, int cx, int cy);
 497 void EnableSizeTip(int bEnable);
 498
 499 /*
 500  * Exports from unicode.c.
 501  */
 502 #ifndef CP_UTF8
 503 #define CP_UTF8 65001
 504 #endif
 505 void init_ucs_tables(void);
 506 void lpage_send(int codepage, char *buf, int len);
 507 void luni_send(wchar_t * widebuf, int len);
 508 int check_compose(int first, int second);
 509 int decode_codepage(char *cp_name);
 510 char *cp_name(int codepage);
 511
 512 /*
 513  * Exports from mscrypto.c
 514  */
 515 #ifdef MSCRYPTOAPI
 516 int crypto_startup();
 517 void crypto_wrapup();
 518 #endif
 519
 520 /*
 521  * Exports from pageantc.c
 522  */
 523 void agent_query(void *in, int inlen, void **out, int *outlen);
 524 int agent_exists(void);
 525
 526
 527 #endif