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