~mdw / sgt / putty / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Make resizeline() and lineptr() static and give them prototypes.
[sgt/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 { PROXYDNS_NO, PROXYDNS_AUTO, PROXYDNS_YES } proxy_dns;
218 int even_proxy_localhost;
219 enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
220 char proxy_host[512];
221 int proxy_port;
222 char proxy_username[32];
223 char proxy_password[32];
224 char proxy_telnet_command[512];
225 int proxy_socks_version;
226 /* SSH options */
227 char remote_cmd[512];
228 char remote_cmd2[512]; /* fallback if the first fails
229 * (used internally for scp) */
230 char *remote_cmd_ptr; /* might point to a larger command
231 * but never for loading/saving */
232 char *remote_cmd_ptr2; /* might point to a larger command
233 * but never for loading/saving */
234 int nopty;
235 int compression;
236 int agentfwd;
237 int change_username; /* allow username switching in SSH2 */
238 int ssh_cipherlist[CIPHER_MAX];
239 char keyfile[FILENAME_MAX];
240 int sshprot; /* use v1 or v2 when both available */
241 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
242 int try_tis_auth;
243 int try_ki_auth;
244 int ssh_subsys; /* run a subsystem rather than a command */
245 int ssh_subsys2; /* fallback to go with remote_cmd2 */
246 /* Telnet options */
247 char termtype[32];
248 char termspeed[32];
249 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
250 char username[100];
251 char localusername[100];
252 int rfc_environ;
253 int passive_telnet;
254 /* Keyboard options */
255 int bksp_is_delete;
256 int rxvt_homeend;
257 int funky_type;
258 int no_applic_c; /* totally disable app cursor keys */
259 int no_applic_k; /* totally disable app keypad */
260 int no_mouse_rep; /* totally disable mouse reporting */
261 int no_remote_resize; /* disable remote resizing */
262 int no_alt_screen; /* disable alternate screen */
263 int no_remote_wintitle; /* disable remote retitling */
264 int no_dbackspace; /* disable destructive backspace */
265 int no_remote_charset; /* disable remote charset config */
266 int app_cursor;
267 int app_keypad;
268 int nethack_keypad;
269 int telnet_keyboard;
270 int telnet_newline;
271 int alt_f4; /* is it special? */
272 int alt_space; /* is it special? */
273 int alt_only; /* is it special? */
274 int localecho;
275 int localedit;
276 int alwaysontop;
277 int fullscreenonaltenter;
278 int scroll_on_key;
279 int scroll_on_disp;
280 int compose_key;
281 int ctrlaltkeys;
282 char wintitle[256]; /* initial window title */
283 /* Terminal options */
284 int savelines;
285 int dec_om;
286 int wrap_mode;
287 int lfhascr;
288 int cursor_type; /* 0=block 1=underline 2=vertical */
289 int blink_cur;
290 enum {
291 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
292 } beep;
293 enum {
294 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
295 } beep_ind;
296 int bellovl; /* bell overload protection active? */
297 int bellovl_n; /* number of bells to cause overload */
298 int bellovl_t; /* time interval for overload (seconds) */
299 int bellovl_s; /* period of silence to re-enable bell (s) */
300 char bell_wavefile[FILENAME_MAX];
301 int scrollbar;
302 int scrollbar_in_fullscreen;
303 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
304 int bce;
305 int blinktext;
306 int win_name_always;
307 int width, height;
308 char font[256];
309 int fontisbold;
310 int fontheight;
311 int fontcharset;
312 char logfilename[FILENAME_MAX];
313 int logtype;
314 int logxfovr;
315 int hide_mouseptr;
316 int sunken_edge;
317 int window_border;
318 char answerback[256];
319 char printer[128];
320 /* Colour options */
321 int try_palette;
322 int bold_colour;
323 unsigned char colours[22][3];
324 /* Selection options */
325 int mouse_is_xterm;
326 int rect_select;
327 int rawcnp;
328 int rtf_paste;
329 int mouse_override;
330 short wordness[256];
331 /* translations */
332 VT_Mode vtmode;
333 char line_codepage[128];
334 int xlat_capslockcyr;
335 /* X11 forwarding */
336 int x11_forward;
337 char x11_display[128];
338 /* port forwarding */
339 int lport_acceptall; /* accept conns from hosts other than localhost */
340 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
341 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
342 /* SSH bug compatibility modes */
343 enum {
344 BUG_AUTO, BUG_OFF, BUG_ON
345 } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
346 sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
347 sshbug_dhgex2;
348 /* Options for pterm. Should split out into platform-dependent part. */
349 int stamp_utmp;
350 int login_shell;
351 int scrollbar_on_left;
352 char boldfont[64];
353 int shadowboldoffset;
354};
355
356/*
357 * You can compile with -DSSH_DEFAULT to have ssh by default.
358 */
359#ifndef SSH_DEFAULT
360#define DEFAULT_PROTOCOL PROT_TELNET
361#define DEFAULT_PORT 23
362#else
363#define DEFAULT_PROTOCOL PROT_SSH
364#define DEFAULT_PORT 22
365#endif
366
367/*
368 * Some global flags denoting the type of application.
369 *
370 * FLAG_VERBOSE is set when the user requests verbose details.
371 *
372 * FLAG_STDERR is set in command-line applications (which have a
373 * functioning stderr that it makes sense to write to) and not in
374 * GUI applications (which don't).
375 *
376 * FLAG_INTERACTIVE is set when a full interactive shell session is
377 * being run, _either_ because no remote command has been provided
378 * _or_ because the application is GUI and can't run non-
379 * interactively.
380 *
381 * These flags describe the type of _application_ - they wouldn't
382 * vary between individual sessions - and so it's OK to have this
383 * variable be GLOBAL.
384 */
385#define FLAG_VERBOSE 0x0001
386#define FLAG_STDERR 0x0002
387#define FLAG_INTERACTIVE 0x0004
388GLOBAL int flags;
389
390/*
391 * Likewise, these two variables are set up when the application
392 * initialises, and inform all default-settings accesses after
393 * that.
394 */
395GLOBAL int default_protocol;
396GLOBAL int default_port;
397
398/* This variable, OTOH, needs to be made non-global ASAP. FIXME. */
399GLOBAL Config cfg;
400
401struct RSAKey; /* be a little careful of scope */
402
403/*
404 * Exports from window.c.
405 */
406void request_resize(void *frontend, int, int);
407void do_text(Context, int, int, char *, int, unsigned long, int);
408void do_cursor(Context, int, int, char *, int, unsigned long, int);
409int char_width(Context ctx, int uc);
410#ifdef OPTIMISE_SCROLL
411void do_scroll(void *, int, int, int);
412#endif
413void set_title(void *frontend, char *);
414void set_icon(void *frontend, char *);
415void set_sbar(void *frontend, int, int, int);
416Context get_ctx(void *frontend);
417void free_ctx(Context);
418void palette_set(void *frontend, int, int, int, int);
419void palette_reset(void *frontend);
420void write_aclip(void *frontend, char *, int, int);
421void write_clip(void *frontend, wchar_t *, int, int);
422void get_clip(void *frontend, wchar_t **, int *);
423void optimised_move(void *frontend, int, int, int);
424void set_raw_mouse_mode(void *frontend, int);
425Mouse_Button translate_button(void *frontend, Mouse_Button b);
426void connection_fatal(void *frontend, char *, ...);
427void fatalbox(char *, ...);
428void modalfatalbox(char *, ...);
429#ifdef macintosh
430#pragma noreturn(fatalbox)
431#pragma noreturn(modalfatalbox)
432#endif
433void beep(void *frontend, int);
434void begin_session(void *frontend);
435void sys_cursor(void *frontend, int x, int y);
436void request_paste(void *frontend);
437void frontend_keypress(void *frontend);
438void ldisc_update(void *frontend, int echo, int edit);
439#define OPTIMISE_IS_SCROLL 1
440
441void set_iconic(void *frontend, int iconic);
442void move_window(void *frontend, int x, int y);
443void set_zorder(void *frontend, int top);
444void refresh_window(void *frontend);
445void set_zoomed(void *frontend, int zoomed);
446int is_iconic(void *frontend);
447void get_window_pos(void *frontend, int *x, int *y);
448void get_window_pixels(void *frontend, int *x, int *y);
449char *get_window_title(void *frontend, int icon);
450
451void cleanup_exit(int);
452
453/*
454 * Exports from noise.c.
455 */
456void noise_get_heavy(void (*func) (void *, int));
457void noise_get_light(void (*func) (void *, int));
458void noise_regular(void);
459void noise_ultralight(unsigned long data);
460void random_save_seed(void);
461void random_destroy_seed(void);
462
463/*
464 * Exports from settings.c.
465 */
466void save_settings(char *section, int do_host, Config * cfg);
467void load_settings(char *section, int do_host, Config * cfg);
468void get_sesslist(struct sesslist *, int allocate);
469void do_defaults(char *, Config *);
470void registry_cleanup(void);
471
472/*
473 * Exports from terminal.c.
474 */
475
476Terminal *term_init(Config *, void *);
477void term_size(Terminal *, int, int, int);
478void term_out(Terminal *);
479void term_paint(Terminal *, Context, int, int, int, int, int);
480void term_scroll(Terminal *, int, int);
481void term_pwron(Terminal *);
482void term_clrsb(Terminal *);
483void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int);
484void term_deselect(Terminal *);
485void term_update(Terminal *);
486void term_invalidate(Terminal *);
487void term_blink(Terminal *, int set_cursor);
488void term_do_paste(Terminal *);
489int term_paste_pending(Terminal *);
490void term_paste(Terminal *);
491void term_nopaste(Terminal *);
492int term_ldisc(Terminal *, int option);
493void term_copyall(Terminal *);
494void term_reconfig(Terminal *);
495void term_seen_key_event(Terminal *);
496int from_backend(void *, int is_stderr, char *data, int len);
497void term_provide_resize_fn(Terminal *term,
498 void (*resize_fn)(void *, int, int),
499 void *resize_ctx);
500void term_provide_logctx(Terminal *term, void *logctx);
501
502/*
503 * Exports from logging.c.
504 */
505void *log_init(void *frontend);
506void logfopen(void *logctx);
507void logfclose(void *logctx);
508void logtraffic(void *logctx, unsigned char c, int logmode);
509void log_eventlog(void *logctx, char *string);
510enum { PKT_INCOMING, PKT_OUTGOING };
511void log_packet(void *logctx, int direction, int type,
512 char *texttype, void *data, int len);
513
514/*
515 * Exports from testback.c
516 */
517
518extern Backend null_backend;
519extern Backend loop_backend;
520
521/*
522 * Exports from raw.c.
523 */
524
525extern Backend raw_backend;
526
527/*
528 * Exports from rlogin.c.
529 */
530
531extern Backend rlogin_backend;
532
533/*
534 * Exports from telnet.c.
535 */
536
537extern Backend telnet_backend;
538
539/*
540 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
541 * so that PuTTYtel will still compile - otherwise it would depend
542 * on ssh.c.)
543 */
544
545GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
546 int is_pw);
547GLOBAL int ssh_getline_pw_only;
548extern Backend ssh_backend;
549
550/*
551 * Exports from ldisc.c.
552 */
553void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
554void ldisc_send(void *handle, char *buf, int len, int interactive);
555
556/*
557 * Exports from ldiscucs.c.
558 */
559void lpage_send(void *, int codepage, char *buf, int len, int interactive);
560void luni_send(void *, wchar_t * widebuf, int len, int interactive);
561
562/*
563 * Exports from sshrand.c.
564 */
565
566void random_add_noise(void *noise, int length);
567void random_init(void);
568int random_byte(void);
569void random_get_savedata(void **data, int *len);
570extern int random_active;
571
572/*
573 * Exports from misc.c.
574 */
575
576#include "misc.h"
577
578/*
579 * Exports from version.c.
580 */
581extern char ver[];
582
583/*
584 * Exports from unicode.c.
585 */
586#ifndef CP_UTF8
587#define CP_UTF8 65001
588#endif
589void init_ucs(void);
590int is_dbcs_leadbyte(int codepage, char byte);
591int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
592 wchar_t *wcstr, int wclen);
593int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
594 char *mbstr, int mblen, char *defchr, int *defused);
595wchar_t xlat_uskbd2cyrllic(int ch);
596int check_compose(int first, int second);
597int decode_codepage(char *cp_name);
598char *cp_enumerate (int index);
599char *cp_name(int codepage);
600void get_unitab(int codepage, wchar_t * unitab, int ftype);
601
602/*
603 * Exports from mscrypto.c
604 */
605#ifdef MSCRYPTOAPI
606int crypto_startup();
607void crypto_wrapup();
608#endif
609
610/*
611 * Exports from pageantc.c
612 */
613void agent_query(void *in, int inlen, void **out, int *outlen);
614int agent_exists(void);
615
616/*
617 * Exports from wildcard.c
618 */
619const char *wc_error(int value);
620int wc_match(const char *wildcard, const char *target);
621int wc_unescape(char *output, const char *wildcard);
622
623/*
624 * Exports from windlg.c
625 */
626void logevent(void *frontend, char *);
627void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
628 char *keystr, char *fingerprint);
629void askcipher(void *frontend, char *ciphername, int cs);
630int askappend(void *frontend, char *filename);
631
632/*
633 * Exports from console.c (that aren't equivalents to things in
634 * windlg.c).
635 */
636extern int console_batch_mode;
637int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
638
639/*
640 * Exports from printing.c.
641 */
642typedef struct printer_enum_tag printer_enum;
643typedef struct printer_job_tag printer_job;
644printer_enum *printer_start_enum(int *nprinters);
645char *printer_get_name(printer_enum *, int);
646void printer_finish_enum(printer_enum *);
647printer_job *printer_start_job(char *printer);
648void printer_job_data(printer_job *, void *, int);
649void printer_finish_job(printer_job *);
650
651/*
652 * Exports from cmdline.c (and also cmdline_error(), which is
653 * defined differently in various places and required _by_
654 * cmdline.c).
655 */
656int cmdline_process_param(char *, char *, int);
657void cmdline_run_saved(void);
658extern char *cmdline_password;
659#define TOOLTYPE_FILETRANSFER 1
660extern int cmdline_tooltype;
661
662void cmdline_error(char *, ...);
663
664#endif
Simon Tatham's PuTTY GUI SSH client; import of svn://svn.tartarus.org/sgt/putty