putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
   5
   6 #ifdef macintosh
   7 #define OPTIMISE_SCROLL
   8 #endif
   9
  10 #ifdef macintosh
  11 #include <MacTypes.h>
  12 #include <Palettes.h>
  13 #include <Controls.h>
  14 #include <Windows.h>
  15 typedef UInt32 DWORD;
  16 #endif /* macintosh */
  17
  18 #ifndef TRUE
  19 #define TRUE 1
  20 #endif
  21 #ifndef FALSE
  22 #define FALSE 0
  23 #endif
  24
  25 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
  26 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
  27 #define ATTR_INVALID 0x20000000UL
  28 #define ATTR_WRAPPED 0x10000000UL
  29
  30 #define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
  31 #define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
  32 #define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
  33
  34 #define ATTR_BOLD    0x00000100UL
  35 #define ATTR_UNDER   0x00000200UL
  36 #define ATTR_REVERSE 0x00000400UL
  37 #define ATTR_FGMASK  0x0000F000UL
  38 #define ATTR_BGMASK  0x000F0000UL
  39 #define ATTR_FGSHIFT 12
  40 #define ATTR_BGSHIFT 16
  41
  42 #define ATTR_DEFAULT 0x00098000UL
  43 #define ATTR_DEFFG   0x00008000UL
  44 #define ATTR_DEFBG   0x00090000UL
  45 #define ATTR_CUR_XOR 0x000BA000UL
  46 #define ERASE_CHAR   (ATTR_DEFAULT | ' ')
  47 #define ATTR_MASK    0xFFFFFF00UL
  48 #define CHAR_MASK    0x000000FFUL
  49
  50 #ifdef macintosh
  51 #define SEL_NL { 13 }
  52 #else
  53 #define SEL_NL { 13, 10 }
  54 #endif
  55
  56 /*
  57  * Global variables. Most modules declare these `extern', but
  58  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  59  * module, and so will get them properly defined.
  60  */
  61 #ifdef PUTTY_DO_GLOBALS
  62 #define GLOBAL
  63 #else
  64 #define GLOBAL extern
  65 #endif
  66
  67 #define INBUF_SIZE 2048
  68 #define INBUF_MASK (INBUF_SIZE-1)
  69
  70 #define OUTBUF_SIZE 2048
  71 #define OUTBUF_MASK (OUTBUF_SIZE-1)
  72
  73 #define WM_NETEVENT  (WM_USER + 1)
  74
  75 typedef enum {
  76     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
  77     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF
  78 } Telnet_Special;
  79
  80 typedef enum {
  81     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
  82 } Mouse_Button;
  83
  84 typedef enum {
  85     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
  86 } Mouse_Action;
  87
  88 typedef enum {
  89     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
  90 } VT_Mode;
  91
  92 typedef struct Session Session;
  93 typedef struct Socket Socket;
  94
  95 /* Types of network event */
  96
  97 typedef enum {
  98     NE_NULL,    /* Nothing happened */
  99     NE_OPEN,    /* Connection successfully opened */
 100     NE_NOHOST,  /* DNS lookup failed for some reason */
 101     NE_REFUSED, /* Port unreachable */
 102     NE_NOOPEN,  /* Connection failed to open for some other reason */
 103     NE_DATA,    /* Incoming normal data */
 104     NE_URGENT,  /* Incoming urgent data */
 105     NE_SENT,    /* Used internally by Mac network stack */
 106     NE_CLOSING, /* Connection closed by remote host */
 107     NE_CLOSED,  /* Connection close completed */
 108     NE_TIMEOUT, /* Remote host vanished */
 109     NE_ABORT,   /* Remote host reset connection */
 110     NE_DIED,    /* Connection has failed for some other reason */
 111 } Net_Event_Type;
 112
 113 #ifdef macintosh
 114 typedef void *SOCKET;
 115 #define INVALID_SOCKET NULL
 116 #endif
 117
 118 typedef struct {
 119     char *(*init) (Session *);
 120     int (*msg)(Session *, SOCKET, Net_Event_Type);
 121     void (*send) (Session *, char *buf, int len);
 122     void (*size) (Session *);
 123     void (*special) (Session *, Telnet_Special code);
 124     void (*shutdown) (Session *);
 125 } Backend;
 126
 127 #ifdef macintosh
 128 typedef struct {
 129     int (*init)(void);
 130     SOCKET (*open)(Session *, char const *, int);
 131     int (*recv)(SOCKET, void *, int, int);
 132     int (*send)(SOCKET, void *, int, int);
 133     void (*poll)(void);
 134     void (*close)(SOCKET);
 135     void (*destroy)(SOCKET);
 136     void (*shutdown)(void);
 137 } Network_Stack;
 138
 139 GLOBAL Network_Stack *net_stack;
 140
 141 #define net_open(s, h, p)       ((*net_stack->open)((s), (h), (p)))
 142 #define net_recv(s, b, l, f)    ((*net_stack->recv)((s), (b), (l), (f)))
 143 #define net_send(s, b, l, f)    ((*net_stack->send)((s), (b), (l), (f)))
 144 #define net_poll()              ((*net_stack->poll)())
 145 #define net_close(s)            ((*net_stack->close)(s))
 146 #define net_destroy(s)          ((*net_stack->destroy)(s))
 147 #define net_shutdown()          ((*net_stack->shutdown)())
 148 #endif
 149
 150 typedef struct {
 151     /* Basic options */
 152     char host[512];
 153     int port;
 154     enum { PROT_TELNET, PROT_SSH } protocol;
 155     int close_on_exit;
 156     /* SSH options */
 157     int nopty;
 158     /* Telnet options */
 159     char termtype[32];
 160     char termspeed[32];
 161     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 162     char username[32];
 163     int rfc_environ;
 164     /* Keyboard options */
 165     int bksp_is_delete;
 166     int rxvt_homeend;
 167     int linux_funkeys;
 168     int app_cursor;
 169     int app_keypad;
 170     int meta_modifiers;
 171     /* Terminal options */
 172     int savelines;
 173     int dec_om;
 174     int wrap_mode;
 175     int lfhascr;
 176     int win_name_always;
 177     int width, height;
 178     char font[64];
 179     int fontisbold;
 180     int fontheight;
 181     VT_Mode vtmode;
 182     /* Colour options */
 183     int try_palette;
 184     int bold_colour;
 185 #ifdef macintosh
 186     PaletteHandle colours;
 187 #else /* not macintosh */
 188     unsigned char colours[22][3];
 189 #endif /* not macintosh */
 190     /* Selection options */
 191     int implicit_copy;
 192 #ifdef macintosh
 193     int mouse_is_xterm;
 194 #endif
 195     short wordness[256];
 196 } Config;
 197
 198 typedef struct {
 199     /* Display buffers and pointers within them */
 200     unsigned long *text;               /* buffer of text on terminal screen */
 201     unsigned long *scrtop;             /* top of working screen */
 202     unsigned long *disptop;            /* top of displayed screen */
 203     unsigned long *sbtop;              /* top of scrollback */
 204     unsigned long *cpos;               /* cursor position (convenience) */
 205     unsigned long *disptext;           /* buffer of text on real screen */
 206     unsigned long *wanttext;           /* buffer of text we want on screen */
 207     unsigned long *alttext;            /* buffer of text on alt. screen */
 208     unsigned char *selspace;           /* buffer for building selections in */
 209
 210     /* Current state */
 211     unsigned long curr_attr;
 212     int curs_x, curs_y;        /* cursor */
 213     int cset;                  /* 0 or 1: which char set is in GL */
 214     unsigned long cset_attr[2]; /* G0 and G1 char sets */
 215
 216     /* Saved state */
 217     unsigned long  save_attr;
 218     int save_x, save_y;        /* saved cursor position */
 219     int save_cset, save_csattr;     /* saved with cursor position */
 220
 221     int marg_t, marg_b;        /* scroll margins */
 222
 223     /* Flags */
 224     int dec_om;                /* DEC origin mode flag */
 225     int wrap, wrapnext;        /* wrap flags */
 226     int insert;                /* insert-mode flag */
 227     int rvideo;                /* global reverse video flag */
 228
 229     /*
 230      * Saved settings on the alternate screen.
 231      */
 232     int alt_x, alt_y, alt_om, alt_wrap, alt_wnext, alt_ins, alt_cset;
 233     int alt_t, alt_b;
 234     int alt_which;
 235
 236     /* Escape sequence handler state */
 237 #define ARGS_MAX 32                    /* max # of esc sequence arguments */
 238     int esc_args[ARGS_MAX];
 239     int esc_nargs;
 240     int esc_query;
 241 #define OSC_STR_MAX 2048
 242     int osc_strlen;
 243     char osc_string[OSC_STR_MAX+1];
 244     int osc_w;
 245
 246     unsigned char *tabs;
 247     int nl_count;
 248
 249     enum {
 250         TOPLEVEL, IGNORE_NEXT,
 251         SEEN_ESC, SEEN_CSI, SET_GL, SET_GR,
 252         SEEN_OSC, SEEN_OSC_P, SEEN_OSC_W, OSC_STRING, OSC_MAYBE_ST,
 253         SEEN_ESCHASH
 254     } termstate;
 255
 256     enum {
 257         NO_SELECTION, ABOUT_TO, DRAGGING, SELECTED
 258     } selstate;
 259     enum {
 260         SM_CHAR, SM_WORD, SM_LINE
 261     } selmode;
 262     unsigned long *selstart, *selend, *selanchor;
 263     short wordness[256];
 264 } Term_State;
 265
 266 typedef struct Session {
 267     /* Config that created this session */
 268     Config cfg;
 269     /* Terminal emulator internal state */
 270     Term_State ts;
 271     /* Display state */
 272     int rows, cols, savelines;
 273     int font_width, font_height;
 274     int has_focus;
 275     /* Buffers */
 276     unsigned char inbuf[INBUF_SIZE];
 277     int inbuf_head, inbuf_reap;
 278     unsigned char outbuf[OUTBUF_SIZE];
 279     int outbuf_head, outbuf_reap;
 280     /* Emulator state */
 281     int app_cursor_keys, app_keypad_keys;
 282     /* Backend */
 283     Backend *back;
 284     /* Conveniences */
 285     unsigned long attr_mask;            /* Mask of attributes to display */
 286 #ifdef macintosh
 287     short               fontnum;
 288     int                 font_ascent;
 289     int                 font_leading;
 290     int                 font_boldadjust;
 291     WindowPtr           window;
 292     PaletteHandle       palette;
 293     ControlHandle       scrollbar;
 294     WCTabHandle         wctab;
 295 #endif
 296 } Session;
 297
 298 typedef struct Socket Socket;
 299
 300 /*
 301  * Exports from display system
 302  */
 303 extern void request_resize(Session *, int, int);
 304 extern void do_text(Session *, int, int, char *, int, unsigned long);
 305 extern void set_title(Session *, char *);
 306 extern void set_icon(Session *, char *);
 307 extern void set_sbar(Session *, int, int, int);
 308 extern void pre_paint(Session *);
 309 extern void post_paint(Session *);
 310 extern void palette_set(Session *, int, int, int, int);
 311 extern void palette_reset(Session *);
 312 extern void write_clip (void *, int);
 313 extern void get_clip (void **, int *);
 314 extern void do_scroll(Session *, int, int, int);
 315 extern void fatalbox(const char *, ...);
 316 #ifdef macintosh
 317 #pragma noreturn (fatalbox)
 318 #endif
 319 extern void beep(Session *s);
 320 extern void lognegot(const char *);
 321
 322 /*
 323  * Exports from the network system
 324  */
 325
 326 #ifndef macintosh
 327 extern Socket *net_open(Session *, char *host, int port);
 328 extern char *net_realname(Socket *);
 329 extern int net_recv(Socket *, void *, int, int);
 330 extern int net_send(Socket *, void *, int, int);
 331 extern void net_close(Socket *); /* ask the remote end to close */
 332 extern void net_destroy(Socket *); /* Tidy up */
 333 #endif
 334 #define SEND_PUSH 0x01
 335 #define SEND_URG 0x02
 336
 337
 338 /*
 339  * Exports from noise.c.
 340  */
 341 void noise_get_heavy(void (*func) (void *, int));
 342 void noise_get_light(void (*func) (void *, int));
 343 void noise_ultralight(DWORD data);
 344 void random_save_seed(void);
 345
 346 #ifndef macintosh
 347 /*
 348  * Exports from windlg.c.
 349  */
 350 int do_config (void);
 351 int do_reconfig (HWND);
 352 void do_defaults (char *);
 353 void lognegot (char *);
 354 void shownegot (HWND);
 355 void showabout (HWND);
 356 void verify_ssh_host_key(char *host, struct RSAKey *key);
 357 #endif
 358
 359 /*
 360  * Exports from terminal.c.
 361  */
 362
 363 extern void term_init(Session *);
 364 extern void term_size(Session *, int, int, int);
 365 extern void term_out(Session *);
 366 extern void term_paint(Session *, int, int, int, int);
 367 extern void term_scroll(Session *, int, int);
 368 extern void term_pwron(Session *);
 369 extern void term_clrsb(Session *);
 370 extern void term_mouse(Session *, Mouse_Button, Mouse_Action, int, int);
 371 extern void term_copy(Session *);
 372 extern void term_paste(Session *);
 373 extern int term_hasselection(Session *);
 374 extern void term_deselect (Session *);
 375 extern void term_update (Session *);
 376 extern void term_invalidate(Session *);
 377
 378 /*
 379  * Exports from telnet.c.
 380  */
 381
 382 extern Backend telnet_backend;
 383
 384 /*
 385  * Exports from ssh.c.
 386  */
 387
 388 extern Backend ssh_backend;
 389
 390 /*
 391  * Exports from sshrand.c.
 392  */
 393
 394 void random_add_noise(void *noise, int length);
 395 void random_init(void);
 396 int random_byte(void);
 397 void random_get_savedata(void **data, int *len);
 398
 399 /*
 400  * Exports from misc.c.
 401  */
 402
 403 /* #define MALLOC_LOG  do this if you suspect putty of leaking memory */
 404 #ifdef MALLOC_LOG
 405 #define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
 406 #define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
 407 #define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
 408 void mlog(char *, int);
 409 #else
 410 #define smalloc safemalloc
 411 #define srealloc saferealloc
 412 #define sfree safefree
 413 #endif
 414
 415 void *safemalloc(size_t);
 416 void *saferealloc(void *, size_t);
 417 void safefree(void *);
 418
 419 /*
 420  * Exports from testback.c
 421  */
 422
 423 extern Backend null_backend;
 424 extern Backend loop_backend;
 425 extern Backend hexdump_backend;
 426
 427 /*
 428  * Exports from version.c.
 429  */
 430 extern char ver[];
 431
 432 /*
 433  * A debug system.
 434  */
 435 #ifdef DEBUG
 436 #include <stdarg.h>
 437 #define debug(x) (dprintf x)
 438 static void dprintf(char *fmt, ...) {
 439     char buf[2048];
 440     DWORD dw;
 441     va_list ap;
 442     static int gotconsole = 0;
 443
 444     if (!gotconsole) {
 445         AllocConsole();
 446         gotconsole = 1;
 447     }
 448
 449     va_start(ap, fmt);
 450     vsprintf(buf, fmt, ap);
 451     WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
 452     va_end(ap);
 453 }
 454 #else
 455 #define debug(x)
 456 #endif
 457
 458 #endif