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