git.distorted.org.uk Git - u/mdw/putty/blob - putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include <stdio.h>                     /* for FILENAME_MAX */
   5
   6 #include "network.h"
   7
   8 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
   9 #define PUTTY_REG_PARENT "Software\\SimonTatham"
  10 #define PUTTY_REG_PARENT_CHILD "PuTTY"
  11 #define PUTTY_REG_GPARENT "Software"
  12 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
  13
  14 /*
  15  * Global variables. Most modules declare these `extern', but
  16  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  17  * module, and so will get them properly defined.
  18  */
  19 #ifdef PUTTY_DO_GLOBALS
  20 #define GLOBAL
  21 #else
  22 #define GLOBAL extern
  23 #endif
  24
  25 /* Three attribute types:
  26  * The ATTRs (normal attributes) are stored with the characters in the main
  27  * display arrays
  28  *
  29  * The TATTRs (temporary attributes) are generated on the fly, they can overlap
  30  * with characters but not with normal attributes.
  31  *
  32  * The LATTRs (line attributes) conflict with no others and only have one
  33  * value per line. But on area clears the LATTR cells are set to the erase_char
  34  * (or DEFAULT_ATTR + 'E')
  35  *
  36  * ATTR_INVALID is an illegal colour combination.
  37  */
  38
  39 #define TATTR_ACTCURS       0x4UL      /* active cursor (block) */
  40 #define TATTR_PASCURS       0x2UL      /* passive cursor (box) */
  41 #define TATTR_RIGHTCURS     0x1UL      /* cursor-on-RHS */
  42
  43 #define LATTR_NORM   0x00000000UL
  44 #define LATTR_WIDE   0x01000000UL
  45 #define LATTR_TOP    0x02000000UL
  46 #define LATTR_BOT    0x03000000UL
  47 #define LATTR_MODE   0x03000000UL
  48 #define LATTR_WRAPPED 0x10000000UL
  49
  50 #define ATTR_INVALID 0x00FF0000UL
  51
  52 /* Like Linux use the F000 page for direct to font. */
  53 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  54 #define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  55
  56 /* These are internal use overlapping with the UTF-16 surrogates */
  57 #define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  58 #define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  59 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  60 #define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  61 #define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */
  62
  63 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
  64 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
  65
  66 #define UCSERR       (ATTR_LINEDRW|'a') /* UCS Format error character. */
  67 #define UCSWIDE      0x303F
  68
  69 #define ATTR_NARROW  0x20000000UL
  70 #define ATTR_WIDE    0x10000000UL
  71 #define ATTR_BOLD    0x01000000UL
  72 #define ATTR_UNDER   0x02000000UL
  73 #define ATTR_REVERSE 0x04000000UL
  74 #define ATTR_BLINK   0x08000000UL
  75 #define ATTR_FGMASK  0x000F0000UL
  76 #define ATTR_BGMASK  0x00F00000UL
  77 #define ATTR_COLOURS 0x00FF0000UL
  78 #define ATTR_FGSHIFT 16
  79 #define ATTR_BGSHIFT 20
  80
  81 #define ATTR_DEFAULT 0x00980000UL
  82 #define ATTR_DEFFG   0x00080000UL
  83 #define ATTR_DEFBG   0x00900000UL
  84 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
  85 #define ATTR_MASK    0xFFFFFF00UL
  86 #define CHAR_MASK    0x000000FFUL
  87
  88 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
  89 #define ATTR_CUR_XOR 0x00BA0000UL
  90
  91 typedef HDC Context;
  92 #define SEL_NL { 13, 10 }
  93
  94 GLOBAL int rows, cols, savelines;
  95
  96 GLOBAL int has_focus;
  97
  98 GLOBAL int in_vbell;
  99 GLOBAL unsigned long vbell_startpoint;
 100
 101 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
 102 GLOBAL int repeat_off, cr_lf_return;
 103
 104 GLOBAL int seen_key_event;
 105 GLOBAL int seen_disp_event;
 106 GLOBAL int alt_pressed;
 107
 108 GLOBAL int session_closed;
 109
 110 GLOBAL int big_cursor;
 111
 112 GLOBAL char *help_path;
 113 GLOBAL int help_has_contents;
 114
 115 GLOBAL int utf;
 116 GLOBAL int dbcs_screenfont;
 117 GLOBAL int font_codepage;
 118 GLOBAL int kbd_codepage;
 119 GLOBAL int line_codepage;
 120 GLOBAL WCHAR unitab_scoacs[256];
 121 GLOBAL WCHAR unitab_line[256];
 122 GLOBAL WCHAR unitab_font[256];
 123 GLOBAL WCHAR unitab_xterm[256];
 124 GLOBAL WCHAR unitab_oemcp[256];
 125 GLOBAL unsigned char unitab_ctrl[256];
 126 #define in_utf (utf || line_codepage==CP_UTF8)
 127
 128 #define LGXF_OVR  1                    /* existing logfile overwrite */
 129 #define LGXF_APN  0                    /* existing logfile append */
 130 #define LGXF_ASK -1                    /* existing logfile ask */
 131 #define LGTYP_NONE  0                  /* logmode: no logging */
 132 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 133 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 134 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 135 GLOBAL char *logfile;
 136
 137 /*
 138  * Window handles for the dialog boxes that can be running during a
 139  * PuTTY session.
 140  */
 141 GLOBAL HWND logbox;
 142
 143 /*
 144  * I've just looked in the windows standard headr files for WM_USER, there
 145  * are hundreds of flags defined using the form WM_USER+123 so I've
 146  * renumbered this NETEVENT value and the two in window.c
 147  */
 148 #define WM_XUSER     (WM_USER + 0x2000)
 149 #define WM_NETEVENT  (WM_XUSER + 5)
 150
 151 typedef enum {
 152     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 153     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 154     TS_EOL
 155 } Telnet_Special;
 156
 157 typedef enum {
 158     MBT_NOTHING,
 159     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 160     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 161     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 162 } Mouse_Button;
 163
 164 typedef enum {
 165     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 166 } Mouse_Action;
 167
 168 typedef enum {
 169     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 170 } VT_Mode;
 171
 172 enum {
 173     /*
 174      * SSH ciphers (both SSH1 and SSH2)
 175      */
 176     CIPHER_WARN,                       /* pseudo 'cipher' */
 177     CIPHER_3DES,
 178     CIPHER_BLOWFISH,
 179     CIPHER_AES,                        /* (SSH 2 only) */
 180     CIPHER_DES,
 181     CIPHER_MAX                         /* no. ciphers (inc warn) */
 182 };
 183
 184 enum {
 185     /*
 186      * Line discipline option states: off, on, up to the backend.
 187      */
 188     LD_YES, LD_NO, LD_BACKEND
 189 };
 190
 191 enum {
 192     /*
 193      * Line discipline options which the backend might try to control.
 194      */
 195     LD_EDIT,                           /* local line editing */
 196     LD_ECHO                            /* local echo */
 197 };
 198
 199 enum {
 200     /*
 201      * Close On Exit behaviours. (cfg.close_on_exit)
 202      */
 203     COE_NEVER,                         /* Never close the window */
 204     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
 205     COE_ALWAYS                         /* Always close the window */
 206 };
 207
 208 typedef struct {
 209     char *(*init) (char *host, int port, char **realhost, int nodelay);
 210     /* back->send() returns the current amount of buffered data. */
 211     int (*send) (char *buf, int len);
 212     /* back->sendbuffer() does the same thing but without attempting a send */
 213     int (*sendbuffer) (void);
 214     void (*size) (void);
 215     void (*special) (Telnet_Special code);
 216     Socket(*socket) (void);
 217     int (*exitcode) (void);
 218     int (*sendok) (void);
 219     int (*ldisc) (int);
 220     /*
 221      * back->unthrottle() tells the back end that the front end
 222      * buffer is clearing.
 223      */
 224     void (*unthrottle) (int);
 225     int default_port;
 226 } Backend;
 227
 228 GLOBAL Backend *back;
 229
 230 extern struct backend_list {
 231     int protocol;
 232     char *name;
 233     Backend *backend;
 234 } backends[];
 235
 236 typedef struct {
 237     /* Basic options */
 238     char host[512];
 239     int port;
 240     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 241     int close_on_exit;
 242     int warn_on_close;
 243     int ping_interval;                 /* in seconds */
 244     int tcp_nodelay;
 245     /* Proxy options */
 246     char proxy_exclude_list[512];
 247     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
 248     char proxy_host[512];
 249     int proxy_port;
 250     char proxy_username[32];
 251     char proxy_password[32];
 252     char proxy_telnet_command[512];
 253     int proxy_socks_version;
 254     /* SSH options */
 255     char remote_cmd[512];
 256     char remote_cmd2[512];             /* fallback if the first fails
 257                                         * (used internally for scp) */
 258     char *remote_cmd_ptr;              /* might point to a larger command
 259                                         * but never for loading/saving */
 260     char *remote_cmd_ptr2;             /* might point to a larger command
 261                                         * but never for loading/saving */
 262     int nopty;
 263     int compression;
 264     int agentfwd;
 265     int change_username;               /* allow username switching in SSH2 */
 266     int ssh_cipherlist[CIPHER_MAX];
 267     char keyfile[FILENAME_MAX];
 268     int sshprot;                       /* use v1 or v2 when both available */
 269     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 270     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
 271     int try_tis_auth;
 272     int try_ki_auth;
 273     int ssh_subsys;                    /* run a subsystem rather than a command */
 274     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 275     /* Telnet options */
 276     char termtype[32];
 277     char termspeed[32];
 278     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 279     char username[32];
 280     char localusername[32];
 281     int rfc_environ;
 282     int passive_telnet;
 283     /* Keyboard options */
 284     int bksp_is_delete;
 285     int rxvt_homeend;
 286     int funky_type;
 287     int no_applic_c;                   /* totally disable app cursor keys */
 288     int no_applic_k;                   /* totally disable app keypad */
 289     int no_mouse_rep;                  /* totally disable mouse reporting */
 290     int no_remote_resize;              /* disable remote resizing */
 291     int no_alt_screen;                 /* disable alternate screen */
 292     int no_remote_wintitle;            /* disable remote retitling */
 293     int no_dbackspace;                 /* disable destructive backspace */
 294     int no_remote_charset;             /* disable remote charset config */
 295     int app_cursor;
 296     int app_keypad;
 297     int nethack_keypad;
 298     int telnet_keyboard;
 299     int telnet_newline;
 300     int alt_f4;                        /* is it special? */
 301     int alt_space;                     /* is it special? */
 302     int alt_only;                      /* is it special? */
 303     int localecho;
 304     int localedit;
 305     int alwaysontop;
 306     int fullscreenonaltenter;
 307     int scroll_on_key;
 308     int scroll_on_disp;
 309     int compose_key;
 310     int ctrlaltkeys;
 311     char wintitle[256];                /* initial window title */
 312     /* Terminal options */
 313     int savelines;
 314     int dec_om;
 315     int wrap_mode;
 316     int lfhascr;
 317     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 318     int blink_cur;
 319     enum {
 320         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 321     } beep;
 322     enum {
 323         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 324     } beep_ind;
 325     int bellovl;                       /* bell overload protection active? */
 326     int bellovl_n;                     /* number of bells to cause overload */
 327     int bellovl_t;                     /* time interval for overload (seconds) */
 328     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 329     char bell_wavefile[FILENAME_MAX];
 330     int scrollbar;
 331     int scrollbar_in_fullscreen;
 332     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
 333     int bce;
 334     int blinktext;
 335     int win_name_always;
 336     int width, height;
 337     char font[64];
 338     int fontisbold;
 339     int fontheight;
 340     int fontcharset;
 341     char logfilename[FILENAME_MAX];
 342     int logtype;
 343     int logxfovr;
 344     int hide_mouseptr;
 345     int sunken_edge;
 346     int window_border;
 347     char answerback[256];
 348     char printer[128];
 349     /* Colour options */
 350     int try_palette;
 351     int bold_colour;
 352     unsigned char colours[22][3];
 353     /* Selection options */
 354     int mouse_is_xterm;
 355     int rect_select;
 356     int rawcnp;
 357     int rtf_paste;
 358     int mouse_override;
 359     short wordness[256];
 360     /* translations */
 361     VT_Mode vtmode;
 362     char line_codepage[128];
 363     int xlat_capslockcyr;
 364     /* X11 forwarding */
 365     int x11_forward;
 366     char x11_display[128];
 367     /* port forwarding */
 368     int lport_acceptall; /* accept conns from hosts other than localhost */
 369     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
 370     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 371 } Config;
 372
 373 /*
 374  * You can compile with -DSSH_DEFAULT to have ssh by default.
 375  */
 376 #ifndef SSH_DEFAULT
 377 #define DEFAULT_PROTOCOL PROT_TELNET
 378 #define DEFAULT_PORT 23
 379 #else
 380 #define DEFAULT_PROTOCOL PROT_SSH
 381 #define DEFAULT_PORT 22
 382 #endif
 383
 384 /*
 385  * Some global flags denoting the type of application.
 386  *
 387  * FLAG_VERBOSE is set when the user requests verbose details.
 388  *
 389  * FLAG_STDERR is set in command-line applications (which have a
 390  * functioning stderr that it makes sense to write to) and not in
 391  * GUI applications (which don't).
 392  *
 393  * FLAG_INTERACTIVE is set when a full interactive shell session is
 394  * being run, _either_ because no remote command has been provided
 395  * _or_ because the application is GUI and can't run non-
 396  * interactively.
 397  */
 398 #define FLAG_VERBOSE     0x0001
 399 #define FLAG_STDERR      0x0002
 400 #define FLAG_INTERACTIVE 0x0004
 401 GLOBAL int flags;
 402
 403 GLOBAL Config cfg;
 404 GLOBAL int default_protocol;
 405 GLOBAL int default_port;
 406
 407 struct RSAKey;                         /* be a little careful of scope */
 408
 409 /*
 410  * Exports from window.c.
 411  */
 412 void request_resize(int, int);
 413 void do_text(Context, int, int, char *, int, unsigned long, int);
 414 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 415 int CharWidth(Context ctx, int uc);
 416 void set_title(char *);
 417 void set_icon(char *);
 418 void set_sbar(int, int, int);
 419 Context get_ctx(void);
 420 void free_ctx(Context);
 421 void palette_set(int, int, int, int);
 422 void palette_reset(void);
 423 void write_aclip(char *, int, int);
 424 void write_clip(wchar_t *, int, int);
 425 void get_clip(wchar_t **, int *);
 426 void optimised_move(int, int, int);
 427 void set_raw_mouse_mode(int);
 428 Mouse_Button translate_button(Mouse_Button b);
 429 void connection_fatal(char *, ...);
 430 void fatalbox(char *, ...);
 431 void beep(int);
 432 void begin_session(void);
 433 void sys_cursor(int x, int y);
 434 #define OPTIMISE_IS_SCROLL 1
 435
 436 void set_iconic(int iconic);
 437 void move_window(int x, int y);
 438 void set_zorder(int top);
 439 void refresh_window(void);
 440 void set_zoomed(int zoomed);
 441 int is_iconic(void);
 442 void get_window_pos(int *x, int *y);
 443 void get_window_pixels(int *x, int *y);
 444 char *get_window_title(int icon);
 445
 446 void cleanup_exit(int);
 447
 448 /*
 449  * Exports from noise.c.
 450  */
 451 void noise_get_heavy(void (*func) (void *, int));
 452 void noise_get_light(void (*func) (void *, int));
 453 void noise_regular(void);
 454 void noise_ultralight(DWORD data);
 455 void random_save_seed(void);
 456 void random_destroy_seed(void);
 457
 458 /*
 459  * Exports from windlg.c.
 460  */
 461 void defuse_showwindow(void);
 462 int do_config(void);
 463 int do_reconfig(HWND);
 464 void do_defaults(char *, Config *);
 465 void logevent(char *);
 466 void showeventlog(HWND);
 467 void showabout(HWND);
 468 void verify_ssh_host_key(char *host, int port, char *keytype,
 469                          char *keystr, char *fingerprint);
 470 void askcipher(char *ciphername, int cs);
 471 int askappend(char *filename);
 472 void registry_cleanup(void);
 473 void force_normal(HWND hwnd);
 474
 475 GLOBAL int nsessions;
 476 GLOBAL char **sessions;
 477
 478 /*
 479  * Exports from settings.c.
 480  */
 481 void save_settings(char *section, int do_host, Config * cfg);
 482 void load_settings(char *section, int do_host, Config * cfg);
 483 void get_sesslist(int allocate);
 484
 485 /*
 486  * Exports from terminal.c.
 487  */
 488
 489 void term_init(void);
 490 void term_size(int, int, int);
 491 void term_out(void);
 492 void term_paint(Context, int, int, int, int);
 493 void term_scroll(int, int);
 494 void term_pwron(void);
 495 void term_clrsb(void);
 496 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
 497 void term_deselect(void);
 498 void term_update(void);
 499 void term_invalidate(void);
 500 void term_blink(int set_cursor);
 501 void term_do_paste(void);
 502 void term_paste(void);
 503 void term_nopaste(void);
 504 int term_ldisc(int option);
 505 int from_backend(int is_stderr, char *data, int len);
 506 void logfopen(void);
 507 void logfclose(void);
 508 void term_copyall(void);
 509 void term_reconfig(void);
 510
 511 /*
 512  * Exports from logging.c.
 513  */
 514 void logtraffic(unsigned char c, int logmode);
 515 enum { PKT_INCOMING, PKT_OUTGOING };
 516 void log_packet(int direction, int type, char *texttype, void *data, int len);
 517
 518 /*
 519  * Exports from raw.c.
 520  */
 521
 522 extern Backend raw_backend;
 523
 524 /*
 525  * Exports from rlogin.c.
 526  */
 527
 528 extern Backend rlogin_backend;
 529
 530 /*
 531  * Exports from telnet.c.
 532  */
 533
 534 extern Backend telnet_backend;
 535
 536 /*
 537  * Exports from ssh.c.
 538  */
 539
 540 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 541                             int is_pw);
 542 extern Backend ssh_backend;
 543
 544 /*
 545  * Exports from ldisc.c.
 546  */
 547
 548 extern void ldisc_send(char *buf, int len, int interactive);
 549
 550 /*
 551  * Exports from sshrand.c.
 552  */
 553
 554 void random_add_noise(void *noise, int length);
 555 void random_init(void);
 556 int random_byte(void);
 557 void random_get_savedata(void **data, int *len);
 558 extern int random_active;
 559
 560 /*
 561  * Exports from misc.c.
 562  */
 563
 564 #include "misc.h"
 565
 566 /*
 567  * Exports from version.c.
 568  */
 569 extern char ver[];
 570
 571 /*
 572  * Exports from sizetip.c.
 573  */
 574 void UpdateSizeTip(HWND src, int cx, int cy);
 575 void EnableSizeTip(int bEnable);
 576
 577 /*
 578  * Exports from unicode.c.
 579  */
 580 #ifndef CP_UTF8
 581 #define CP_UTF8 65001
 582 #endif
 583 void init_ucs_tables(void);
 584 void lpage_send(int codepage, char *buf, int len, int interactive);
 585 void luni_send(wchar_t * widebuf, int len, int interactive);
 586 wchar_t xlat_uskbd2cyrllic(int ch);
 587 int check_compose(int first, int second);
 588 int decode_codepage(char *cp_name);
 589 char *cp_enumerate (int index);
 590 char *cp_name(int codepage);
 591 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 592
 593 /*
 594  * Exports from mscrypto.c
 595  */
 596 #ifdef MSCRYPTOAPI
 597 int crypto_startup();
 598 void crypto_wrapup();
 599 #endif
 600
 601 /*
 602  * Exports from pageantc.c
 603  */
 604 void agent_query(void *in, int inlen, void **out, int *outlen);
 605 int agent_exists(void);
 606
 607 /*
 608  * Exports from wildcard.c
 609  */
 610 const char *wc_error(int value);
 611 int wc_match(const char *wildcard, const char *target);
 612 int wc_unescape(char *output, const char *wildcard);
 613
 614 /*
 615  * Exports from console.c (that aren't equivalents to things in
 616  * windlg.c).
 617  */
 618 extern int console_batch_mode;
 619 extern char *console_password;
 620 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 621
 622 /*
 623  * Exports from printing.c.
 624  */
 625 typedef struct printer_enum_tag printer_enum;
 626 typedef struct printer_job_tag printer_job;
 627 printer_enum *printer_start_enum(int *nprinters);
 628 char *printer_get_name(printer_enum *, int);
 629 void printer_finish_enum(printer_enum *);
 630 printer_job *printer_start_job(char *printer);
 631 void printer_job_data(printer_job *, void *, int);
 632 void printer_finish_job(printer_job *);
 633
 634 #endif