Note about CTRL-C trick for copying text of error dialogs
[u/mdw/putty] / putty.h
... / ...
CommitLineData
1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
4#include <stdio.h> /* for FILENAME_MAX */
5#include <stddef.h> /* for wchar_t */
6
7/*
8 * Global variables. Most modules declare these `extern', but
9 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
10 * module, and so will get them properly defined.
11 */
12#ifndef GLOBAL
13#ifdef PUTTY_DO_GLOBALS
14#define GLOBAL
15#else
16#define GLOBAL extern
17#endif
18#endif
19
20#ifndef DONE_TYPEDEFS
21#define DONE_TYPEDEFS
22typedef struct config_tag Config;
23typedef struct backend_tag Backend;
24typedef struct terminal_tag Terminal;
25#endif
26
27#include "puttyps.h"
28#include "network.h"
29
30/* Three attribute types:
31 * The ATTRs (normal attributes) are stored with the characters in the main
32 * display arrays
33 *
34 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
35 * with characters but not with normal attributes.
36 *
37 * The LATTRs (line attributes) conflict with no others and only have one
38 * value per line. But on area clears the LATTR cells are set to the erase_char
39 * (or DEFAULT_ATTR + 'E')
40 *
41 * ATTR_INVALID is an illegal colour combination.
42 */
43
44#define TATTR_ACTCURS 0x4UL /* active cursor (block) */
45#define TATTR_PASCURS 0x2UL /* passive cursor (box) */
46#define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
47
48#define LATTR_NORM 0x00000000UL
49#define LATTR_WIDE 0x01000000UL
50#define LATTR_TOP 0x02000000UL
51#define LATTR_BOT 0x03000000UL
52#define LATTR_MODE 0x03000000UL
53#define LATTR_WRAPPED 0x10000000UL
54
55#define ATTR_INVALID 0x00FF0000UL
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#define UCSWIDE 0x303F
73
74#define ATTR_NARROW 0x20000000UL
75#define ATTR_WIDE 0x10000000UL
76#define ATTR_BOLD 0x01000000UL
77#define ATTR_UNDER 0x02000000UL
78#define ATTR_REVERSE 0x04000000UL
79#define ATTR_BLINK 0x08000000UL
80#define ATTR_FGMASK 0x000F0000UL
81#define ATTR_BGMASK 0x00F00000UL
82#define ATTR_COLOURS 0x00FF0000UL
83#define ATTR_FGSHIFT 16
84#define ATTR_BGSHIFT 20
85
86#define ATTR_DEFAULT 0x00980000UL
87#define ATTR_DEFFG 0x00080000UL
88#define ATTR_DEFBG 0x00900000UL
89#define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
90#define ATTR_MASK 0xFFFFFF00UL
91#define CHAR_MASK 0x000000FFUL
92
93#define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
94#define ATTR_CUR_XOR 0x00BA0000UL
95
96struct sesslist {
97 int nsessions;
98 char **sessions;
99 char *buffer; /* so memory can be freed later */
100};
101
102GLOBAL int dbcs_screenfont;
103GLOBAL int font_codepage;
104GLOBAL int line_codepage;
105GLOBAL wchar_t unitab_scoacs[256];
106GLOBAL wchar_t unitab_line[256];
107GLOBAL wchar_t unitab_font[256];
108GLOBAL wchar_t unitab_xterm[256];
109GLOBAL wchar_t unitab_oemcp[256];
110GLOBAL unsigned char unitab_ctrl[256];
111
112#define LGXF_OVR 1 /* existing logfile overwrite */
113#define LGXF_APN 0 /* existing logfile append */
114#define LGXF_ASK -1 /* existing logfile ask */
115#define LGTYP_NONE 0 /* logmode: no logging */
116#define LGTYP_ASCII 1 /* logmode: pure ascii */
117#define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
118#define LGTYP_PACKETS 3 /* logmode: SSH data packets */
119
120typedef enum {
121 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
122 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
123 TS_EOL
124} Telnet_Special;
125
126typedef enum {
127 MBT_NOTHING,
128 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
129 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
130 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
131} Mouse_Button;
132
133typedef enum {
134 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
135} Mouse_Action;
136
137typedef enum {
138 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
139} VT_Mode;
140
141enum {
142 /*
143 * SSH ciphers (both SSH1 and SSH2)
144 */
145 CIPHER_WARN, /* pseudo 'cipher' */
146 CIPHER_3DES,
147 CIPHER_BLOWFISH,
148 CIPHER_AES, /* (SSH 2 only) */
149 CIPHER_DES,
150 CIPHER_MAX /* no. ciphers (inc warn) */
151};
152
153enum {
154 /*
155 * Line discipline option states: off, on, up to the backend.
156 */
157 LD_YES, LD_NO, LD_BACKEND
158};
159
160enum {
161 /*
162 * Line discipline options which the backend might try to control.
163 */
164 LD_EDIT, /* local line editing */
165 LD_ECHO /* local echo */
166};
167
168enum {
169 /*
170 * Close On Exit behaviours. (cfg.close_on_exit)
171 */
172 COE_NEVER, /* Never close the window */
173 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
174 COE_ALWAYS /* Always close the window */
175};
176
177struct backend_tag {
178 char *(*init) (void *frontend_handle, void **backend_handle,
179 char *host, int port, char **realhost, int nodelay);
180 /* back->send() returns the current amount of buffered data. */
181 int (*send) (void *handle, char *buf, int len);
182 /* back->sendbuffer() does the same thing but without attempting a send */
183 int (*sendbuffer) (void *handle);
184 void (*size) (void *handle, int width, int height);
185 void (*special) (void *handle, Telnet_Special code);
186 Socket(*socket) (void *handle);
187 int (*exitcode) (void *handle);
188 int (*sendok) (void *handle);
189 int (*ldisc) (void *handle, int);
190 void (*provide_ldisc) (void *handle, void *ldisc);
191 void (*provide_logctx) (void *handle, void *logctx);
192 /*
193 * back->unthrottle() tells the back end that the front end
194 * buffer is clearing.
195 */
196 void (*unthrottle) (void *handle, int);
197 int default_port;
198};
199
200extern struct backend_list {
201 int protocol;
202 char *name;
203 Backend *backend;
204} backends[];
205
206struct config_tag {
207 /* Basic options */
208 char host[512];
209 int port;
210 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
211 int close_on_exit;
212 int warn_on_close;
213 int ping_interval; /* in seconds */
214 int tcp_nodelay;
215 /* Proxy options */
216 char proxy_exclude_list[512];
217 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
218 char proxy_host[512];
219 int proxy_port;
220 char proxy_username[32];
221 char proxy_password[32];
222 char proxy_telnet_command[512];
223 int proxy_socks_version;
224 /* SSH options */
225 char remote_cmd[512];
226 char remote_cmd2[512]; /* fallback if the first fails
227 * (used internally for scp) */
228 char *remote_cmd_ptr; /* might point to a larger command
229 * but never for loading/saving */
230 char *remote_cmd_ptr2; /* might point to a larger command
231 * but never for loading/saving */
232 int nopty;
233 int compression;
234 int agentfwd;
235 int change_username; /* allow username switching in SSH2 */
236 int ssh_cipherlist[CIPHER_MAX];
237 char keyfile[FILENAME_MAX];
238 int sshprot; /* use v1 or v2 when both available */
239 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
240 int try_tis_auth;
241 int try_ki_auth;
242 int ssh_subsys; /* run a subsystem rather than a command */
243 int ssh_subsys2; /* fallback to go with remote_cmd2 */
244 /* Telnet options */
245 char termtype[32];
246 char termspeed[32];
247 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
248 char username[100];
249 char localusername[100];
250 int rfc_environ;
251 int passive_telnet;
252 /* Keyboard options */
253 int bksp_is_delete;
254 int rxvt_homeend;
255 int funky_type;
256 int no_applic_c; /* totally disable app cursor keys */
257 int no_applic_k; /* totally disable app keypad */
258 int no_mouse_rep; /* totally disable mouse reporting */
259 int no_remote_resize; /* disable remote resizing */
260 int no_alt_screen; /* disable alternate screen */
261 int no_remote_wintitle; /* disable remote retitling */
262 int no_dbackspace; /* disable destructive backspace */
263 int no_remote_charset; /* disable remote charset config */
264 int app_cursor;
265 int app_keypad;
266 int nethack_keypad;
267 int telnet_keyboard;
268 int telnet_newline;
269 int alt_f4; /* is it special? */
270 int alt_space; /* is it special? */
271 int alt_only; /* is it special? */
272 int localecho;
273 int localedit;
274 int alwaysontop;
275 int fullscreenonaltenter;
276 int scroll_on_key;
277 int scroll_on_disp;
278 int compose_key;
279 int ctrlaltkeys;
280 char wintitle[256]; /* initial window title */
281 /* Terminal options */
282 int savelines;
283 int dec_om;
284 int wrap_mode;
285 int lfhascr;
286 int cursor_type; /* 0=block 1=underline 2=vertical */
287 int blink_cur;
288 enum {
289 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
290 } beep;
291 enum {
292 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
293 } beep_ind;
294 int bellovl; /* bell overload protection active? */
295 int bellovl_n; /* number of bells to cause overload */
296 int bellovl_t; /* time interval for overload (seconds) */
297 int bellovl_s; /* period of silence to re-enable bell (s) */
298 char bell_wavefile[FILENAME_MAX];
299 int scrollbar;
300 int scrollbar_in_fullscreen;
301 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
302 int bce;
303 int blinktext;
304 int win_name_always;
305 int width, height;
306 char font[64];
307 int fontisbold;
308 int fontheight;
309 int fontcharset;
310 char logfilename[FILENAME_MAX];
311 int logtype;
312 int logxfovr;
313 int hide_mouseptr;
314 int sunken_edge;
315 int window_border;
316 char answerback[256];
317 char printer[128];
318 /* Colour options */
319 int try_palette;
320 int bold_colour;
321 unsigned char colours[22][3];
322 /* Selection options */
323 int mouse_is_xterm;
324 int rect_select;
325 int rawcnp;
326 int rtf_paste;
327 int mouse_override;
328 short wordness[256];
329 /* translations */
330 VT_Mode vtmode;
331 char line_codepage[128];
332 int xlat_capslockcyr;
333 /* X11 forwarding */
334 int x11_forward;
335 char x11_display[128];
336 /* port forwarding */
337 int lport_acceptall; /* accept conns from hosts other than localhost */
338 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
339 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
340 /* SSH bug compatibility modes */
341 enum {
342 BUG_AUTO, BUG_OFF, BUG_ON
343 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
344 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
345 sshbug_dhgex2;
346 /* Options for pterm. Should split out into platform-dependent part. */
347 int stamp_utmp;
348 int login_shell;
349 int scrollbar_on_left;
350 char boldfont[64];
351 int shadowboldoffset;
352};
353
354/*
355 * You can compile with -DSSH_DEFAULT to have ssh by default.
356 */
357#ifndef SSH_DEFAULT
358#define DEFAULT_PROTOCOL PROT_TELNET
359#define DEFAULT_PORT 23
360#else
361#define DEFAULT_PROTOCOL PROT_SSH
362#define DEFAULT_PORT 22
363#endif
364
365/*
366 * Some global flags denoting the type of application.
367 *
368 * FLAG_VERBOSE is set when the user requests verbose details.
369 *
370 * FLAG_STDERR is set in command-line applications (which have a
371 * functioning stderr that it makes sense to write to) and not in
372 * GUI applications (which don't).
373 *
374 * FLAG_INTERACTIVE is set when a full interactive shell session is
375 * being run, _either_ because no remote command has been provided
376 * _or_ because the application is GUI and can't run non-
377 * interactively.
378 *
379 * These flags describe the type of _application_ - they wouldn't
380 * vary between individual sessions - and so it's OK to have this
381 * variable be GLOBAL.
382 */
383#define FLAG_VERBOSE 0x0001
384#define FLAG_STDERR 0x0002
385#define FLAG_INTERACTIVE 0x0004
386GLOBAL int flags;
387
388/*
389 * Likewise, these two variables are set up when the application
390 * initialises, and inform all default-settings accesses after
391 * that.
392 */
393GLOBAL int default_protocol;
394GLOBAL int default_port;
395
396/* This variable, OTOH, needs to be made non-global ASAP. FIXME. */
397GLOBAL Config cfg;
398
399struct RSAKey; /* be a little careful of scope */
400
401/*
402 * Exports from window.c.
403 */
404void request_resize(void *frontend, int, int);
405void do_text(Context, int, int, char *, int, unsigned long, int);
406void do_cursor(Context, int, int, char *, int, unsigned long, int);
407int char_width(Context ctx, int uc);
408void set_title(void *frontend, char *);
409void set_icon(void *frontend, char *);
410void set_sbar(void *frontend, int, int, int);
411Context get_ctx(void *frontend);
412void free_ctx(Context);
413void palette_set(void *frontend, int, int, int, int);
414void palette_reset(void *frontend);
415void write_aclip(void *frontend, char *, int, int);
416void write_clip(void *frontend, wchar_t *, int, int);
417void get_clip(void *frontend, wchar_t **, int *);
418void optimised_move(void *frontend, int, int, int);
419void set_raw_mouse_mode(void *frontend, int);
420Mouse_Button translate_button(void *frontend, Mouse_Button b);
421void connection_fatal(void *frontend, char *, ...);
422void fatalbox(char *, ...);
423void modalfatalbox(char *, ...);
424void beep(void *frontend, int);
425void begin_session(void *frontend);
426void sys_cursor(void *frontend, int x, int y);
427void request_paste(void *frontend);
428void frontend_keypress(void *frontend);
429void ldisc_update(void *frontend, int echo, int edit);
430#define OPTIMISE_IS_SCROLL 1
431
432void set_iconic(void *frontend, int iconic);
433void move_window(void *frontend, int x, int y);
434void set_zorder(void *frontend, int top);
435void refresh_window(void *frontend);
436void set_zoomed(void *frontend, int zoomed);
437int is_iconic(void *frontend);
438void get_window_pos(void *frontend, int *x, int *y);
439void get_window_pixels(void *frontend, int *x, int *y);
440char *get_window_title(void *frontend, int icon);
441
442void cleanup_exit(int);
443
444/*
445 * Exports from noise.c.
446 */
447void noise_get_heavy(void (*func) (void *, int));
448void noise_get_light(void (*func) (void *, int));
449void noise_regular(void);
450void noise_ultralight(unsigned long data);
451void random_save_seed(void);
452void random_destroy_seed(void);
453
454/*
455 * Exports from settings.c.
456 */
457void save_settings(char *section, int do_host, Config * cfg);
458void load_settings(char *section, int do_host, Config * cfg);
459void get_sesslist(struct sesslist *, int allocate);
460void do_defaults(char *, Config *);
461void registry_cleanup(void);
462
463/*
464 * Exports from terminal.c.
465 */
466
467Terminal *term_init(void *frontend);
468void term_size(Terminal *, int, int, int);
469void term_out(Terminal *);
470void term_paint(Terminal *, Context, int, int, int, int, int);
471void term_scroll(Terminal *, int, int);
472void term_pwron(Terminal *);
473void term_clrsb(Terminal *);
474void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
475void term_deselect(Terminal *);
476void term_update(Terminal *);
477void term_invalidate(Terminal *);
478void term_blink(Terminal *, int set_cursor);
479void term_do_paste(Terminal *);
480int term_paste_pending(Terminal *);
481void term_paste(Terminal *);
482void term_nopaste(Terminal *);
483int term_ldisc(Terminal *, int option);
484void term_copyall(Terminal *);
485void term_reconfig(Terminal *);
486void term_seen_key_event(Terminal *);
487int from_backend(void *, int is_stderr, char *data, int len);
488void term_provide_resize_fn(Terminal *term,
489 void (*resize_fn)(void *, int, int),
490 void *resize_ctx);
491void term_provide_logctx(Terminal *term, void *logctx);
492
493/*
494 * Exports from logging.c.
495 */
496void *log_init(void *frontend);
497void logfopen(void *logctx);
498void logfclose(void *logctx);
499void logtraffic(void *logctx, unsigned char c, int logmode);
500void log_eventlog(void *logctx, char *string);
501enum { PKT_INCOMING, PKT_OUTGOING };
502void log_packet(void *logctx, int direction, int type,
503 char *texttype, void *data, int len);
504
505/*
506 * Exports from testback.c
507 */
508
509extern Backend null_backend;
510extern Backend loop_backend;
511
512/*
513 * Exports from raw.c.
514 */
515
516extern Backend raw_backend;
517
518/*
519 * Exports from rlogin.c.
520 */
521
522extern Backend rlogin_backend;
523
524/*
525 * Exports from telnet.c.
526 */
527
528extern Backend telnet_backend;
529
530/*
531 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
532 * so that PuTTYtel will still compile - otherwise it would depend
533 * on ssh.c.)
534 */
535
536GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
537 int is_pw);
538GLOBAL int ssh_getline_pw_only;
539extern Backend ssh_backend;
540
541/*
542 * Exports from ldisc.c.
543 */
544void *ldisc_create(Terminal *, Backend *, void *, void *);
545void ldisc_send(void *handle, char *buf, int len, int interactive);
546
547/*
548 * Exports from ldiscucs.c.
549 */
550void lpage_send(void *, int codepage, char *buf, int len, int interactive);
551void luni_send(void *, wchar_t * widebuf, int len, int interactive);
552
553/*
554 * Exports from sshrand.c.
555 */
556
557void random_add_noise(void *noise, int length);
558void random_init(void);
559int random_byte(void);
560void random_get_savedata(void **data, int *len);
561extern int random_active;
562
563/*
564 * Exports from misc.c.
565 */
566
567#include "misc.h"
568
569/*
570 * Exports from version.c.
571 */
572extern char ver[];
573
574/*
575 * Exports from unicode.c.
576 */
577#ifndef CP_UTF8
578#define CP_UTF8 65001
579#endif
580void init_ucs(void);
581int is_dbcs_leadbyte(int codepage, char byte);
582int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
583 wchar_t *wcstr, int wclen);
584int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
585 char *mbstr, int mblen, char *defchr, int *defused);
586wchar_t xlat_uskbd2cyrllic(int ch);
587int check_compose(int first, int second);
588int decode_codepage(char *cp_name);
589char *cp_enumerate (int index);
590char *cp_name(int codepage);
591void get_unitab(int codepage, wchar_t * unitab, int ftype);
592
593/*
594 * Exports from mscrypto.c
595 */
596#ifdef MSCRYPTOAPI
597int crypto_startup();
598void crypto_wrapup();
599#endif
600
601/*
602 * Exports from pageantc.c
603 */
604void agent_query(void *in, int inlen, void **out, int *outlen);
605int agent_exists(void);
606
607/*
608 * Exports from wildcard.c
609 */
610const char *wc_error(int value);
611int wc_match(const char *wildcard, const char *target);
612int wc_unescape(char *output, const char *wildcard);
613
614/*
615 * Exports from windlg.c
616 */
617void logevent(void *frontend, char *);
618void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
619 char *keystr, char *fingerprint);
620void askcipher(void *frontend, char *ciphername, int cs);
621int askappend(void *frontend, char *filename);
622
623/*
624 * Exports from console.c (that aren't equivalents to things in
625 * windlg.c).
626 */
627extern int console_batch_mode;
628int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
629
630/*
631 * Exports from printing.c.
632 */
633typedef struct printer_enum_tag printer_enum;
634typedef struct printer_job_tag printer_job;
635printer_enum *printer_start_enum(int *nprinters);
636char *printer_get_name(printer_enum *, int);
637void printer_finish_enum(printer_enum *);
638printer_job *printer_start_job(char *printer);
639void printer_job_data(printer_job *, void *, int);
640void printer_finish_job(printer_job *);
641
642/*
643 * Exports from cmdline.c (and also cmdline_error(), which is
644 * defined differently in various places and required _by_
645 * cmdline.c).
646 */
647int cmdline_process_param(char *, char *, int);
648void cmdline_run_saved(void);
649extern char *cmdline_password;
650#define TOOLTYPE_FILETRANSFER 1
651extern int cmdline_tooltype;
652
653void cmdline_error(char *, ...);
654
655#endif