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