putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include <stddef.h>                    /* for wchar_t */
   5
   6 /*
   7  * Global variables. Most modules declare these `extern', but
   8  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
   9  * module, and so will get them properly defined.
  10  */
  11 #ifndef GLOBAL
  12 #ifdef PUTTY_DO_GLOBALS
  13 #define GLOBAL
  14 #else
  15 #define GLOBAL extern
  16 #endif
  17 #endif
  18
  19 #ifndef DONE_TYPEDEFS
  20 #define DONE_TYPEDEFS
  21 typedef struct config_tag Config;
  22 typedef struct backend_tag Backend;
  23 typedef struct terminal_tag Terminal;
  24 #endif
  25
  26 #include "puttyps.h"
  27 #include "network.h"
  28 #include "misc.h"
  29
  30 /* Three attribute types:
  31  * The ATTRs (normal attributes) are stored with the characters in
  32  * the main display arrays
  33  *
  34  * The TATTRs (temporary attributes) are generated on the fly, they
  35  * can overlap with characters but not with normal attributes.
  36  *
  37  * The LATTRs (line attributes) are an entirely disjoint space of
  38  * flags.
  39  *
  40  * ATTR_INVALID is an illegal colour combination.
  41  */
  42
  43 #define TATTR_ACTCURS       0x40000000UL      /* active cursor (block) */
  44 #define TATTR_PASCURS       0x20000000UL      /* passive cursor (box) */
  45 #define TATTR_RIGHTCURS     0x10000000UL      /* cursor-on-RHS */
  46 #define TATTR_COMBINING     0x80000000UL      /* combining characters */
  47
  48 #define LATTR_NORM   0x00000000UL
  49 #define LATTR_WIDE   0x00000001UL
  50 #define LATTR_TOP    0x00000002UL
  51 #define LATTR_BOT    0x00000003UL
  52 #define LATTR_MODE   0x00000003UL
  53 #define LATTR_WRAPPED 0x00000010UL
  54 #define LATTR_WRAPPED2 0x00000020UL
  55
  56 #define ATTR_INVALID 0x03FFU
  57
  58 /* Like Linux use the F000 page for direct to font. */
  59 #define CSET_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  60 #define CSET_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  61
  62 /* These are internal use overlapping with the UTF-16 surrogates */
  63 #define CSET_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  64 #define CSET_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  65 #define CSET_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  66 #define CSET_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  67 #define CSET_MASK    0xFFFFFF00UL      /* Character set mask */
  68
  69 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
  70 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
  71
  72 #define UCSERR       (CSET_LINEDRW|'a') /* UCS Format error character. */
  73 /*
  74  * UCSWIDE is a special value used in the terminal data to signify
  75  * the character cell containing the right-hand half of a CJK wide
  76  * character. We use 0xDFFF because it's part of the surrogate
  77  * range and hence won't be used for anything else (it's impossible
  78  * to input it via UTF-8 because our UTF-8 decoder correctly
  79  * rejects surrogates).
  80  */
  81 #define UCSWIDE      0xDFFF
  82
  83 #define ATTR_NARROW  0x800000U
  84 #define ATTR_WIDE    0x400000U
  85 #define ATTR_BOLD    0x040000U
  86 #define ATTR_UNDER   0x080000U
  87 #define ATTR_REVERSE 0x100000U
  88 #define ATTR_BLINK   0x200000U
  89 #define ATTR_FGMASK  0x0001FFU
  90 #define ATTR_BGMASK  0x03FE00U
  91 #define ATTR_COLOURS 0x03FFFFU
  92 #define ATTR_FGSHIFT 0
  93 #define ATTR_BGSHIFT 9
  94
  95 /*
  96  * The definitive list of colour numbers stored in terminal
  97  * attribute words is kept here. It is:
  98  *
  99  *  - 0-7 are ANSI colours (KRGYBMCW).
 100  *  - 8-15 are the bold versions of those colours.
 101  *  - 16-255 are the remains of the xterm 256-colour mode (a
 102  *    216-colour cube with R at most significant and B at least,
 103  *    followed by a uniform series of grey shades running between
 104  *    black and white but not including either on grounds of
 105  *    redundancy).
 106  *  - 256 is default foreground
 107  *  - 257 is default bold foreground
 108  *  - 258 is default background
 109  *  - 259 is default bold background
 110  *  - 260 is cursor foreground
 111  *  - 261 is cursor background
 112  */
 113
 114 #define ATTR_DEFFG   (256 << ATTR_FGSHIFT)
 115 #define ATTR_DEFBG   (258 << ATTR_BGSHIFT)
 116 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
 117
 118 struct sesslist {
 119     int nsessions;
 120     char **sessions;
 121     char *buffer;                      /* so memory can be freed later */
 122 };
 123
 124 struct unicode_data {
 125     char **uni_tbl;
 126     int dbcs_screenfont;
 127     int font_codepage;
 128     int line_codepage;
 129     wchar_t unitab_scoacs[256];
 130     wchar_t unitab_line[256];
 131     wchar_t unitab_font[256];
 132     wchar_t unitab_xterm[256];
 133     wchar_t unitab_oemcp[256];
 134     unsigned char unitab_ctrl[256];
 135 };
 136
 137 #define LGXF_OVR  1                    /* existing logfile overwrite */
 138 #define LGXF_APN  0                    /* existing logfile append */
 139 #define LGXF_ASK -1                    /* existing logfile ask */
 140 #define LGTYP_NONE  0                  /* logmode: no logging */
 141 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 142 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 143 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 144
 145 typedef enum {
 146     /* Actual special commands. Originally Telnet, but some codes have
 147      * been re-used for similar specials in other protocols. */
 148     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 149     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 150     TS_EOL,
 151     /* Special command for SSH. */
 152     TS_REKEY,
 153     /* POSIX-style signals. (not Telnet) */
 154     TS_SIGABRT, TS_SIGALRM, TS_SIGFPE,  TS_SIGHUP,  TS_SIGILL,
 155     TS_SIGINT,  TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV,
 156     TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2,
 157     /* Pseudo-specials used for constructing the specials menu. */
 158     TS_SEP,         /* Separator */
 159     TS_SUBMENU,     /* Start a new submenu with specified name */
 160     TS_EXITMENU     /* Exit current submenu or end of specials */
 161 } Telnet_Special;
 162
 163 struct telnet_special {
 164     const char *name;
 165     int code;
 166 };
 167
 168 typedef enum {
 169     MBT_NOTHING,
 170     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 171     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 172     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 173 } Mouse_Button;
 174
 175 typedef enum {
 176     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 177 } Mouse_Action;
 178
 179 /* Keyboard modifiers -- keys the user is actually holding down */
 180
 181 #define PKM_SHIFT       0x01
 182 #define PKM_CONTROL     0x02
 183 #define PKM_META        0x04
 184 #define PKM_ALT         0x08
 185
 186 /* Keyboard flags that aren't really modifiers */
 187 #define PKF_CAPSLOCK    0x10
 188 #define PKF_NUMLOCK     0x20
 189 #define PKF_REPEAT      0x40
 190
 191 /* Stand-alone keysyms for function keys */
 192
 193 typedef enum {
 194     PK_NULL,            /* No symbol for this key */
 195     /* Main keypad keys */
 196     PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
 197     /* Editing keys */
 198     PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
 199     /* Cursor keys */
 200     PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
 201     /* Numeric keypad */                        /* Real one looks like: */
 202     PK_PF1, PK_PF2, PK_PF3, PK_PF4,             /* PF1 PF2 PF3 PF4 */
 203     PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL,       /*  7   8   9   -  */
 204     PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4,     /*  4   5   6   ,  */
 205     PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9,     /*  1   2   3  en- */
 206     PK_KPBIGPLUS, PK_KPENTER,                   /*    0     .  ter */
 207     /* Top row */
 208     PK_F1,  PK_F2,  PK_F3,  PK_F4,  PK_F5,
 209     PK_F6,  PK_F7,  PK_F8,  PK_F9,  PK_F10,
 210     PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
 211     PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
 212     PK_PAUSE
 213 } Key_Sym;
 214
 215 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
 216 #define PK_ISCURSOR(k)  ((k) >= PK_UP && (k) <= PK_REST)
 217 #define PK_ISKEYPAD(k)  ((k) >= PK_PF1 && (k) <= PK_KPENTER)
 218 #define PK_ISFKEY(k)    ((k) >= PK_F1 && (k) <= PK_F20)
 219
 220 enum {
 221     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 222 };
 223
 224 enum {
 225     /*
 226      * SSH ciphers (both SSH1 and SSH2)
 227      */
 228     CIPHER_WARN,                       /* pseudo 'cipher' */
 229     CIPHER_3DES,
 230     CIPHER_BLOWFISH,
 231     CIPHER_AES,                        /* (SSH 2 only) */
 232     CIPHER_DES,
 233     CIPHER_MAX                         /* no. ciphers (inc warn) */
 234 };
 235
 236 enum {
 237     /*
 238      * Several different bits of the PuTTY configuration seem to be
 239      * three-way settings whose values are `always yes', `always
 240      * no', and `decide by some more complex automated means'. This
 241      * is true of line discipline options (local echo and line
 242      * editing), proxy DNS, Close On Exit, and SSH server bug
 243      * workarounds. Accordingly I supply a single enum here to deal
 244      * with them all.
 245      */
 246     FORCE_ON, FORCE_OFF, AUTO
 247 };
 248
 249 enum {
 250     /*
 251      * Proxy types.
 252      */
 253     PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
 254     PROXY_HTTP, PROXY_TELNET, PROXY_CMD
 255 };
 256
 257 enum {
 258     /*
 259      * Line discipline options which the backend might try to control.
 260      */
 261     LD_EDIT,                           /* local line editing */
 262     LD_ECHO                            /* local echo */
 263 };
 264
 265 enum {
 266     /* Protocol back ends. (cfg.protocol) */
 267     PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
 268 };
 269
 270 enum {
 271     /* Bell settings (cfg.beep) */
 272     BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
 273 };
 274
 275 enum {
 276     /* Taskbar flashing indication on bell (cfg.beep_ind) */
 277     B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 278 };
 279
 280 enum {
 281     /* Resize actions (cfg.resize_action) */
 282     RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
 283 };
 284
 285 enum {
 286     /* Function key types (cfg.funky_type) */
 287     FUNKY_TILDE,
 288     FUNKY_LINUX,
 289     FUNKY_XTERM,
 290     FUNKY_VT400,
 291     FUNKY_VT100P,
 292     FUNKY_SCO
 293 };
 294
 295 struct backend_tag {
 296     const char *(*init) (void *frontend_handle, void **backend_handle,
 297                          Config *cfg,
 298                          char *host, int port, char **realhost, int nodelay,
 299                          int keepalive);
 300     void (*free) (void *handle);
 301     /* back->reconfig() passes in a replacement configuration. */
 302     void (*reconfig) (void *handle, Config *cfg);
 303     /* back->send() returns the current amount of buffered data. */
 304     int (*send) (void *handle, char *buf, int len);
 305     /* back->sendbuffer() does the same thing but without attempting a send */
 306     int (*sendbuffer) (void *handle);
 307     void (*size) (void *handle, int width, int height);
 308     void (*special) (void *handle, Telnet_Special code);
 309     const struct telnet_special *(*get_specials) (void *handle);
 310     Socket(*socket) (void *handle);
 311     int (*exitcode) (void *handle);
 312     int (*sendok) (void *handle);
 313     int (*ldisc) (void *handle, int);
 314     void (*provide_ldisc) (void *handle, void *ldisc);
 315     void (*provide_logctx) (void *handle, void *logctx);
 316     /*
 317      * back->unthrottle() tells the back end that the front end
 318      * buffer is clearing.
 319      */
 320     void (*unthrottle) (void *handle, int);
 321     int default_port;
 322 };
 323
 324 extern struct backend_list {
 325     int protocol;
 326     char *name;
 327     Backend *backend;
 328 } backends[];
 329
 330 /*
 331  * Suggested default protocol provided by the backend link module.
 332  * The application is free to ignore this.
 333  */
 334 extern const int be_default_protocol;
 335
 336 /*
 337  * Name of this particular application, for use in the config box
 338  * and other pieces of text.
 339  */
 340 extern const char *const appname;
 341
 342 /*
 343  * IMPORTANT POLICY POINT: everything in this structure which wants
 344  * to be treated like an integer must be an actual, honest-to-
 345  * goodness `int'. No enum-typed variables. This is because parts
 346  * of the code will want to pass around `int *' pointers to them
 347  * and we can't run the risk of porting to some system on which the
 348  * enum comes out as a different size from int.
 349  */
 350 struct config_tag {
 351     /* Basic options */
 352     char host[512];
 353     int port;
 354     int protocol;
 355     int close_on_exit;
 356     int warn_on_close;
 357     int ping_interval;                 /* in seconds */
 358     int tcp_nodelay;
 359     int tcp_keepalives;
 360     /* Proxy options */
 361     char proxy_exclude_list[512];
 362     int proxy_dns;
 363     int even_proxy_localhost;
 364     int proxy_type;
 365     char proxy_host[512];
 366     int proxy_port;
 367     char proxy_username[128];
 368     char proxy_password[128];
 369     char proxy_telnet_command[512];
 370     /* SSH options */
 371     char remote_cmd[512];
 372     char remote_cmd2[512];             /* fallback if the first fails
 373                                         * (used internally for scp) */
 374     char *remote_cmd_ptr;              /* might point to a larger command
 375                                         * but never for loading/saving */
 376     char *remote_cmd_ptr2;             /* might point to a larger command
 377                                         * but never for loading/saving */
 378     int nopty;
 379     int compression;
 380     int agentfwd;
 381     int change_username;               /* allow username switching in SSH2 */
 382     int ssh_cipherlist[CIPHER_MAX];
 383     Filename keyfile;
 384     int sshprot;                       /* use v1 or v2 when both available */
 385     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
 386     int try_tis_auth;
 387     int try_ki_auth;
 388     int ssh_subsys;                    /* run a subsystem rather than a command */
 389     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 390     int ssh_no_shell;                  /* avoid running a shell */
 391     /* Telnet options */
 392     char termtype[32];
 393     char termspeed[32];
 394     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 395     char username[100];
 396     char localusername[100];
 397     int rfc_environ;
 398     int passive_telnet;
 399     /* Keyboard options */
 400     int bksp_is_delete;
 401     int rxvt_homeend;
 402     int funky_type;
 403     int no_applic_c;                   /* totally disable app cursor keys */
 404     int no_applic_k;                   /* totally disable app keypad */
 405     int no_mouse_rep;                  /* totally disable mouse reporting */
 406     int no_remote_resize;              /* disable remote resizing */
 407     int no_alt_screen;                 /* disable alternate screen */
 408     int no_remote_wintitle;            /* disable remote retitling */
 409     int no_dbackspace;                 /* disable destructive backspace */
 410     int no_remote_charset;             /* disable remote charset config */
 411     int no_remote_qtitle;              /* disable remote win title query */
 412     int app_cursor;
 413     int app_keypad;
 414     int nethack_keypad;
 415     int telnet_keyboard;
 416     int telnet_newline;
 417     int alt_f4;                        /* is it special? */
 418     int alt_space;                     /* is it special? */
 419     int alt_only;                      /* is it special? */
 420     int localecho;
 421     int localedit;
 422     int alwaysontop;
 423     int fullscreenonaltenter;
 424     int scroll_on_key;
 425     int scroll_on_disp;
 426     int erase_to_scrollback;
 427     int compose_key;
 428     int ctrlaltkeys;
 429     char wintitle[256];                /* initial window title */
 430     /* Terminal options */
 431     int savelines;
 432     int dec_om;
 433     int wrap_mode;
 434     int lfhascr;
 435     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 436     int blink_cur;
 437     int beep;
 438     int beep_ind;
 439     int bellovl;                       /* bell overload protection active? */
 440     int bellovl_n;                     /* number of bells to cause overload */
 441     int bellovl_t;                     /* time interval for overload (seconds) */
 442     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 443     Filename bell_wavefile;
 444     int scrollbar;
 445     int scrollbar_in_fullscreen;
 446     int resize_action;
 447     int bce;
 448     int blinktext;
 449     int win_name_always;
 450     int width, height;
 451     FontSpec font;
 452     Filename logfilename;
 453     int logtype;
 454     int logxfovr;
 455     int logomitpass;
 456     int logomitdata;
 457     int hide_mouseptr;
 458     int sunken_edge;
 459     int window_border;
 460     char answerback[256];
 461     char printer[128];
 462     int arabicshaping;
 463     int bidi;
 464     /* Colour options */
 465     int ansi_colour;
 466     int xterm_256_colour;
 467     int system_colour;
 468     int try_palette;
 469     int bold_colour;
 470     unsigned char colours[22][3];
 471     /* Selection options */
 472     int mouse_is_xterm;
 473     int rect_select;
 474     int rawcnp;
 475     int rtf_paste;
 476     int mouse_override;
 477     short wordness[256];
 478     /* translations */
 479     int vtmode;
 480     char line_codepage[128];
 481     int utf8_override;
 482     int xlat_capslockcyr;
 483     /* X11 forwarding */
 484     int x11_forward;
 485     char x11_display[128];
 486     int x11_auth;
 487     /* port forwarding */
 488     int lport_acceptall; /* accept conns from hosts other than localhost */
 489     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
 490     /*
 491      * The port forwarding string contains a number of
 492      * NUL-terminated substrings, terminated in turn by an empty
 493      * string (i.e. a second NUL immediately after the previous
 494      * one). Each string can be of one of the following forms:
 495      *
 496      *   [LR]localport\thost:port
 497      *   [LR]localaddr:localport\thost:port
 498      *   Dlocalport
 499      *   Dlocaladdr:localport
 500      */
 501     char portfwd[1024];
 502     /* SSH bug compatibility modes */
 503     int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
 504         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
 505         sshbug_dhgex2, sshbug_pksessid2;
 506     /* Options for pterm. Should split out into platform-dependent part. */
 507     int stamp_utmp;
 508     int login_shell;
 509     int scrollbar_on_left;
 510     int shadowbold;
 511     FontSpec boldfont;
 512     FontSpec widefont;
 513     FontSpec wideboldfont;
 514     int shadowboldoffset;
 515 };
 516
 517 /*
 518  * Some global flags denoting the type of application.
 519  *
 520  * FLAG_VERBOSE is set when the user requests verbose details.
 521  *
 522  * FLAG_STDERR is set in command-line applications (which have a
 523  * functioning stderr that it makes sense to write to) and not in
 524  * GUI applications (which don't).
 525  *
 526  * FLAG_INTERACTIVE is set when a full interactive shell session is
 527  * being run, _either_ because no remote command has been provided
 528  * _or_ because the application is GUI and can't run non-
 529  * interactively.
 530  *
 531  * These flags describe the type of _application_ - they wouldn't
 532  * vary between individual sessions - and so it's OK to have this
 533  * variable be GLOBAL.
 534  *
 535  * Note that additional flags may be defined in platform-specific
 536  * headers. It's probably best if those ones start from 0x1000, to
 537  * avoid collision.
 538  */
 539 #define FLAG_VERBOSE     0x0001
 540 #define FLAG_STDERR      0x0002
 541 #define FLAG_INTERACTIVE 0x0004
 542 GLOBAL int flags;
 543
 544 /*
 545  * Likewise, these two variables are set up when the application
 546  * initialises, and inform all default-settings accesses after
 547  * that.
 548  */
 549 GLOBAL int default_protocol;
 550 GLOBAL int default_port;
 551
 552 /*
 553  * This is set TRUE by cmdline.c iff a session is loaded with "-load".
 554  */
 555 GLOBAL int loaded_session;
 556
 557 struct RSAKey;                         /* be a little careful of scope */
 558
 559 /*
 560  * Exports from window.c.
 561  */
 562 void request_resize(void *frontend, int, int);
 563 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
 564 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
 565 int char_width(Context ctx, int uc);
 566 #ifdef OPTIMISE_SCROLL
 567 void do_scroll(Context, int, int, int);
 568 #endif
 569 void set_title(void *frontend, char *);
 570 void set_icon(void *frontend, char *);
 571 void set_sbar(void *frontend, int, int, int);
 572 Context get_ctx(void *frontend);
 573 void free_ctx(Context);
 574 void palette_set(void *frontend, int, int, int, int);
 575 void palette_reset(void *frontend);
 576 void write_aclip(void *frontend, char *, int, int);
 577 void write_clip(void *frontend, wchar_t *, int, int);
 578 void get_clip(void *frontend, wchar_t **, int *);
 579 void optimised_move(void *frontend, int, int, int);
 580 void set_raw_mouse_mode(void *frontend, int);
 581 void connection_fatal(void *frontend, char *, ...);
 582 void fatalbox(char *, ...);
 583 void modalfatalbox(char *, ...);
 584 #ifdef macintosh
 585 #pragma noreturn(fatalbox)
 586 #pragma noreturn(modalfatalbox)
 587 #endif
 588 void beep(void *frontend, int);
 589 void begin_session(void *frontend);
 590 void sys_cursor(void *frontend, int x, int y);
 591 void request_paste(void *frontend);
 592 void frontend_keypress(void *frontend);
 593 void ldisc_update(void *frontend, int echo, int edit);
 594 /* It's the backend's responsibility to invoke this at the start of a
 595  * connection, if necessary; it can also invoke it later if the set of
 596  * special commands changes. It does not need to invoke it at session
 597  * shutdown. */
 598 void update_specials_menu(void *frontend);
 599 int from_backend(void *frontend, int is_stderr, const char *data, int len);
 600 void notify_remote_exit(void *frontend);
 601 #define OPTIMISE_IS_SCROLL 1
 602
 603 void set_iconic(void *frontend, int iconic);
 604 void move_window(void *frontend, int x, int y);
 605 void set_zorder(void *frontend, int top);
 606 void refresh_window(void *frontend);
 607 void set_zoomed(void *frontend, int zoomed);
 608 int is_iconic(void *frontend);
 609 void get_window_pos(void *frontend, int *x, int *y);
 610 void get_window_pixels(void *frontend, int *x, int *y);
 611 char *get_window_title(void *frontend, int icon);
 612
 613 void cleanup_exit(int);
 614
 615 /*
 616  * Exports from noise.c.
 617  */
 618 void noise_get_heavy(void (*func) (void *, int));
 619 void noise_get_light(void (*func) (void *, int));
 620 void noise_regular(void);
 621 void noise_ultralight(unsigned long data);
 622 void random_save_seed(void);
 623 void random_destroy_seed(void);
 624
 625 /*
 626  * Exports from settings.c.
 627  */
 628 char *save_settings(char *section, int do_host, Config * cfg);
 629 void save_open_settings(void *sesskey, int do_host, Config *cfg);
 630 void load_settings(char *section, int do_host, Config * cfg);
 631 void load_open_settings(void *sesskey, int do_host, Config *cfg);
 632 void get_sesslist(struct sesslist *, int allocate);
 633 void do_defaults(char *, Config *);
 634 void registry_cleanup(void);
 635
 636 /*
 637  * Functions used by settings.c to provide platform-specific
 638  * default settings.
 639  *
 640  * (The integer one is expected to return `def' if it has no clear
 641  * opinion of its own. This is because there's no integer value
 642  * which I can reliably set aside to indicate `nil'. The string
 643  * function is perfectly all right returning NULL, of course. The
 644  * Filename and FontSpec functions are _not allowed_ to fail to
 645  * return, since these defaults _must_ be per-platform.)
 646  */
 647 char *platform_default_s(const char *name);
 648 int platform_default_i(const char *name, int def);
 649 Filename platform_default_filename(const char *name);
 650 FontSpec platform_default_fontspec(const char *name);
 651
 652 /*
 653  * Exports from terminal.c.
 654  */
 655
 656 Terminal *term_init(Config *, struct unicode_data *, void *);
 657 void term_free(Terminal *);
 658 void term_size(Terminal *, int, int, int);
 659 void term_paint(Terminal *, Context, int, int, int, int, int);
 660 void term_scroll(Terminal *, int, int);
 661 void term_pwron(Terminal *);
 662 void term_clrsb(Terminal *);
 663 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
 664                 int,int,int,int,int);
 665 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
 666               unsigned int);
 667 void term_deselect(Terminal *);
 668 void term_update(Terminal *);
 669 void term_invalidate(Terminal *);
 670 void term_blink(Terminal *, int set_cursor);
 671 void term_do_paste(Terminal *);
 672 int term_paste_pending(Terminal *);
 673 void term_paste(Terminal *);
 674 void term_nopaste(Terminal *);
 675 int term_ldisc(Terminal *, int option);
 676 void term_copyall(Terminal *);
 677 void term_reconfig(Terminal *, Config *);
 678 void term_seen_key_event(Terminal *);
 679 int term_data(Terminal *, int is_stderr, const char *data, int len);
 680 void term_provide_resize_fn(Terminal *term,
 681                             void (*resize_fn)(void *, int, int),
 682                             void *resize_ctx);
 683 void term_provide_logctx(Terminal *term, void *logctx);
 684 void term_set_focus(Terminal *term, int has_focus);
 685
 686 /*
 687  * Exports from logging.c.
 688  */
 689 void *log_init(void *frontend, Config *cfg);
 690 void log_free(void *logctx);
 691 void log_reconfig(void *logctx, Config *cfg);
 692 void logfopen(void *logctx);
 693 void logfclose(void *logctx);
 694 void logtraffic(void *logctx, unsigned char c, int logmode);
 695 void logflush(void *logctx);
 696 void log_eventlog(void *logctx, const char *string);
 697 enum { PKT_INCOMING, PKT_OUTGOING };
 698 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
 699 struct logblank_t {
 700     int offset;
 701     int len;
 702     int type;
 703 };
 704 void log_packet(void *logctx, int direction, int type,
 705                 char *texttype, void *data, int len,
 706                 int n_blanks, const struct logblank_t *blanks);
 707
 708 /*
 709  * Exports from testback.c
 710  */
 711
 712 extern Backend null_backend;
 713 extern Backend loop_backend;
 714
 715 /*
 716  * Exports from raw.c.
 717  */
 718
 719 extern Backend raw_backend;
 720
 721 /*
 722  * Exports from rlogin.c.
 723  */
 724
 725 extern Backend rlogin_backend;
 726
 727 /*
 728  * Exports from telnet.c.
 729  */
 730
 731 extern Backend telnet_backend;
 732
 733 /*
 734  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
 735  * so that PuTTYtel will still compile - otherwise it would depend
 736  * on ssh.c.)
 737  */
 738
 739 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 740                             int is_pw);
 741 GLOBAL int ssh_getline_pw_only;
 742 extern Backend ssh_backend;
 743
 744 /*
 745  * Exports from ldisc.c.
 746  */
 747 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
 748 void ldisc_free(void *);
 749 void ldisc_send(void *handle, char *buf, int len, int interactive);
 750
 751 /*
 752  * Exports from ldiscucs.c.
 753  */
 754 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
 755 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
 756
 757 /*
 758  * Exports from sshrand.c.
 759  */
 760
 761 void random_add_noise(void *noise, int length);
 762 int random_byte(void);
 763 void random_get_savedata(void **data, int *len);
 764 extern int random_active;
 765 /* The random number subsystem is activated if at least one other entity
 766  * within the program expresses an interest in it. So each SSH session
 767  * calls random_ref on startup and random_unref on shutdown. */
 768 void random_ref(void);
 769 void random_unref(void);
 770
 771 /*
 772  * Exports from pinger.c.
 773  */
 774 typedef struct pinger_tag *Pinger;
 775 Pinger pinger_new(Config *cfg, Backend *back, void *backhandle);
 776 void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg);
 777 void pinger_free(Pinger);
 778
 779 /*
 780  * Exports from misc.c.
 781  */
 782
 783 #include "misc.h"
 784
 785 /*
 786  * Exports from version.c.
 787  */
 788 extern char ver[];
 789
 790 /*
 791  * Exports from unicode.c.
 792  */
 793 #ifndef CP_UTF8
 794 #define CP_UTF8 65001
 795 #endif
 796 /* void init_ucs(void); -- this is now in platform-specific headers */
 797 int is_dbcs_leadbyte(int codepage, char byte);
 798 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
 799              wchar_t *wcstr, int wclen);
 800 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
 801              char *mbstr, int mblen, char *defchr, int *defused,
 802              struct unicode_data *ucsdata);
 803 wchar_t xlat_uskbd2cyrllic(int ch);
 804 int check_compose(int first, int second);
 805 int decode_codepage(char *cp_name);
 806 const char *cp_enumerate (int index);
 807 const char *cp_name(int codepage);
 808 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 809
 810 /*
 811  * Exports from wcwidth.c
 812  */
 813 int wcwidth(wchar_t ucs);
 814 int wcswidth(const wchar_t *pwcs, size_t n);
 815
 816 /*
 817  * Exports from mscrypto.c
 818  */
 819 #ifdef MSCRYPTOAPI
 820 int crypto_startup();
 821 void crypto_wrapup();
 822 #endif
 823
 824 /*
 825  * Exports from pageantc.c.
 826  *
 827  * agent_query returns 1 for here's-a-response, and 0 for query-in-
 828  * progress. In the latter case there will be a call to `callback'
 829  * at some future point, passing callback_ctx as the first
 830  * parameter and the actual reply data as the second and third.
 831  *
 832  * The response may be a NULL pointer (in either of the synchronous
 833  * or asynchronous cases), which indicates failure to receive a
 834  * response.
 835  */
 836 int agent_query(void *in, int inlen, void **out, int *outlen,
 837                 void (*callback)(void *, void *, int), void *callback_ctx);
 838 int agent_exists(void);
 839
 840 /*
 841  * Exports from wildcard.c
 842  */
 843 const char *wc_error(int value);
 844 int wc_match(const char *wildcard, const char *target);
 845 int wc_unescape(char *output, const char *wildcard);
 846
 847 /*
 848  * Exports from windlg.c
 849  */
 850 void logevent(void *frontend, const char *);
 851 void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
 852                          char *keystr, char *fingerprint);
 853 void askcipher(void *frontend, char *ciphername, int cs);
 854 int askappend(void *frontend, Filename filename);
 855
 856 /*
 857  * Exports from console.c (that aren't equivalents to things in
 858  * windlg.c).
 859  */
 860 extern int console_batch_mode;
 861 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 862 void console_provide_logctx(void *logctx);
 863 int is_interactive(void);
 864
 865 /*
 866  * Exports from printing.c.
 867  */
 868 typedef struct printer_enum_tag printer_enum;
 869 typedef struct printer_job_tag printer_job;
 870 printer_enum *printer_start_enum(int *nprinters);
 871 char *printer_get_name(printer_enum *, int);
 872 void printer_finish_enum(printer_enum *);
 873 printer_job *printer_start_job(char *printer);
 874 void printer_job_data(printer_job *, void *, int);
 875 void printer_finish_job(printer_job *);
 876
 877 /*
 878  * Exports from cmdline.c (and also cmdline_error(), which is
 879  * defined differently in various places and required _by_
 880  * cmdline.c).
 881  */
 882 int cmdline_process_param(char *, char *, int, Config *);
 883 void cmdline_run_saved(Config *);
 884 void cmdline_cleanup(void);
 885 extern char *cmdline_password;
 886 #define TOOLTYPE_FILETRANSFER 1
 887 #define TOOLTYPE_NONNETWORK 2
 888 extern int cmdline_tooltype;
 889
 890 void cmdline_error(char *, ...);
 891
 892 /*
 893  * Exports from config.c.
 894  */
 895 struct controlbox;
 896 void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
 897                       int midsession, int protocol);
 898
 899 /*
 900  * Exports from minibidi.c.
 901  */
 902 typedef struct bidi_char {
 903     wchar_t origwc, wc;
 904     unsigned short index;
 905 } bidi_char;
 906 int do_bidi(bidi_char *line, int count);
 907 int do_shape(bidi_char *line, bidi_char *to, int count);
 908
 909 /*
 910  * X11 auth mechanisms we know about.
 911  */
 912 enum {
 913     X11_NO_AUTH,
 914     X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
 915     X11_XDM,                           /* XDM-AUTHORIZATION-1 */
 916     X11_NAUTHS
 917 };
 918 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
 919
 920 /*
 921  * Miscellaneous exports from the platform-specific code.
 922  */
 923 Filename filename_from_str(const char *string);
 924 const char *filename_to_str(const Filename *fn);
 925 int filename_equal(Filename f1, Filename f2);
 926 int filename_is_null(Filename fn);
 927 char *get_username(void);              /* return value needs freeing */
 928 char *get_random_data(int bytes);      /* used in cmdgen.c */
 929
 930 /*
 931  * Exports and imports from timing.c.
 932  *
 933  * schedule_timer() asks the front end to schedule a callback to a
 934  * timer function in a given number of ticks. The returned value is
 935  * the time (in ticks since an arbitrary offset) at which the
 936  * callback can be expected. This value will also be passed as the
 937  * `now' parameter to the callback function. Hence, you can (for
 938  * example) schedule an event at a particular time by calling
 939  * schedule_timer() and storing the return value in your context
 940  * structure as the time when that event is due. The first time a
 941  * callback function gives you that value or more as `now', you do
 942  * the thing.
 943  *
 944  * expire_timer_context() drops all current timers associated with
 945  * a given value of ctx (for when you're about to free ctx).
 946  *
 947  * run_timers() is called from the front end when it has reason to
 948  * think some timers have reached their moment, or when it simply
 949  * needs to know how long to wait next. We pass it the time we
 950  * think it is. It returns TRUE and places the time when the next
 951  * timer needs to go off in `next', or alternatively it returns
 952  * FALSE if there are no timers at all pending.
 953  *
 954  * timer_change_notify() must be supplied by the front end; it
 955  * notifies the front end that a new timer has been added to the
 956  * list which is sooner than any existing ones. It provides the
 957  * time when that timer needs to go off.
 958  */
 959 typedef void (*timer_fn_t)(void *ctx, long now);
 960 long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
 961 void expire_timer_context(void *ctx);
 962 int run_timers(long now, long *next);
 963 void timer_change_notify(long next);
 964
 965 #endif