[u/mdw/putty] / windows / winstuff.h

/*
 * winstuff.h: Windows-specific inter-module stuff.
 */

#ifndef PUTTY_WINSTUFF_H
#define PUTTY_WINSTUFF_H

#ifndef AUTO_WINSOCK
#include <winsock2.h>
#endif
#include <windows.h>
#include <stdio.h>		       /* for FILENAME_MAX */

#include "tree234.h"

#include "winhelp.h"

struct Filename {
    char path[FILENAME_MAX];
};
#define f_open(filename, mode, isprivate) ( fopen((filename).path, (mode)) )

struct FontSpec {
    char name[64];
    int isbold;
    int height;
    int charset;
};

#ifndef CLEARTYPE_QUALITY
#define CLEARTYPE_QUALITY 5
#endif
#define FONT_QUALITY(fq) ( \
    (fq) == FQ_DEFAULT ? DEFAULT_QUALITY : \
    (fq) == FQ_ANTIALIASED ? ANTIALIASED_QUALITY : \
    (fq) == FQ_NONANTIALIASED ? NONANTIALIASED_QUALITY : \
    CLEARTYPE_QUALITY)

#define PLATFORM_IS_UTF16 /* enable UTF-16 processing when exchanging
			   * wchar_t strings with environment */

/*
 * Where we can, we use GetWindowLongPtr and friends because they're
 * more useful on 64-bit platforms, but they're a relatively recent
 * innovation, missing from VC++ 6 and older MinGW.  Degrade nicely.
 * (NB that on some systems, some of these things are available but
 * not others...)
 */

#ifndef GCLP_HCURSOR
/* GetClassLongPtr and friends */
#undef  GetClassLongPtr
#define GetClassLongPtr GetClassLong
#undef  SetClassLongPtr
#define SetClassLongPtr SetClassLong
#define GCLP_HCURSOR GCL_HCURSOR
/* GetWindowLongPtr and friends */
#undef  GetWindowLongPtr
#define GetWindowLongPtr GetWindowLong
#undef  SetWindowLongPtr
#define SetWindowLongPtr SetWindowLong
#undef  GWLP_USERDATA
#define GWLP_USERDATA GWL_USERDATA
#undef  DWLP_MSGRESULT
#define DWLP_MSGRESULT DWL_MSGRESULT
/* Since we've clobbered the above functions, we should clobber the
 * associated type regardless of whether it's defined. */
#undef LONG_PTR
#define LONG_PTR LONG
#endif

#define BOXFLAGS DLGWINDOWEXTRA
#define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
#define DF_END 0x0001

/*
 * Dynamically linked functions. These come in two flavours:
 *
 *  - GET_WINDOWS_FUNCTION does not expose "name" to the preprocessor,
 *    so will always dynamically link against exactly what is specified
 *    in "name". If you're not sure, use this one.
 *
 *  - GET_WINDOWS_FUNCTION_PP allows "name" to be redirected via
 *    preprocessor definitions like "#define foo bar"; this is principally
 *    intended for the ANSI/Unicode DoSomething/DoSomethingA/DoSomethingW.
 *    If your function has an argument of type "LPTSTR" or similar, this
 *    is the variant to use.
 *    (However, it can't always be used, as it trips over more complicated
 *    macro trickery such as the WspiapiGetAddrInfo wrapper for getaddrinfo.)
 *
 * (DECL_WINDOWS_FUNCTION works with both these variants.)
 */
#define DECL_WINDOWS_FUNCTION(linkage, rettype, name, params) \
    typedef rettype (WINAPI *t_##name) params; \
    linkage t_##name p_##name
#define STR1(x) #x
#define STR(x) STR1(x)
#define GET_WINDOWS_FUNCTION_PP(module, name) \
    (p_##name = module ? (t_##name) GetProcAddress(module, STR(name)) : NULL)
#define GET_WINDOWS_FUNCTION(module, name) \
    (p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL)

/*
 * Global variables. Most modules declare these `extern', but
 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
 * module, and so will get them properly defined.
*/
#ifndef GLOBAL
#ifdef PUTTY_DO_GLOBALS
#define GLOBAL
#else
#define GLOBAL extern
#endif
#endif

#ifndef DONE_TYPEDEFS
#define DONE_TYPEDEFS
typedef struct config_tag Config;
typedef struct backend_tag Backend;
typedef struct terminal_tag Terminal;
#endif

#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
#define PUTTY_REG_PARENT "Software\\SimonTatham"
#define PUTTY_REG_PARENT_CHILD "PuTTY"
#define PUTTY_REG_GPARENT "Software"
#define PUTTY_REG_GPARENT_CHILD "SimonTatham"

/* Result values for the jumplist registry functions. */
#define JUMPLISTREG_OK 0
#define JUMPLISTREG_ERROR_INVALID_PARAMETER 1
#define JUMPLISTREG_ERROR_KEYOPENCREATE_FAILURE 2
#define JUMPLISTREG_ERROR_VALUEREAD_FAILURE 3
#define JUMPLISTREG_ERROR_VALUEWRITE_FAILURE 4
#define JUMPLISTREG_ERROR_INVALID_VALUE 5

#define PUTTY_HELP_FILE "putty.hlp"
#define PUTTY_CHM_FILE "putty.chm"
#define PUTTY_HELP_CONTENTS "putty.cnt"

#define GETTICKCOUNT GetTickCount
#define CURSORBLINK GetCaretBlinkTime()
#define TICKSPERSEC 1000	       /* GetTickCount returns milliseconds */

#define DEFAULT_CODEPAGE CP_ACP

typedef HDC Context;

typedef unsigned int uint32; /* int is 32-bits on Win32 and Win64. */
#define PUTTY_UINT32_DEFINED

#ifndef NO_GSSAPI
/*
 * GSS-API stuff
 */
#define GSS_CC CALLBACK
/*
typedef struct Ssh_gss_buf {
    size_t length;
    char *value;
} Ssh_gss_buf;

#define SSH_GSS_EMPTY_BUF (Ssh_gss_buf) {0,NULL}
typedef void *Ssh_gss_name;
*/
#endif

/*
 * Window handles for the windows that can be running during a
 * PuTTY session.
 */
GLOBAL HWND hwnd;	/* the main terminal window */
GLOBAL HWND logbox;

/*
 * The all-important instance handle.
 */
GLOBAL HINSTANCE hinst;

/*
 * Help file stuff in winhelp.c.
 */
void init_help(void);
void shutdown_help(void);
int has_help(void);
void launch_help(HWND hwnd, const char *topic);
void quit_help(HWND hwnd);

/*
 * The terminal and logging context are notionally local to the
 * Windows front end, but they must be shared between window.c and
 * windlg.c. Likewise the saved-sessions list.
 */
GLOBAL Terminal *term;
GLOBAL void *logctx;

#define WM_NETEVENT  (WM_APP + 5)

/*
 * On Windows, we send MA_2CLK as the only event marking the second
 * press of a mouse button. Compare unix.h.
 */
#define MULTICLICK_ONLY_EVENT 1

/*
 * On Windows, data written to the clipboard must be NUL-terminated.
 */
#define SELECTION_NUL_TERMINATED 1

/*
 * On Windows, copying to the clipboard terminates lines with CRLF.
 */
#define SEL_NL { 13, 10 }

/*
 * sk_getxdmdata() does not exist under Windows (not that I
 * couldn't write it if I wanted to, but I haven't bothered), so
 * it's a macro which always returns NULL. With any luck this will
 * cause the compiler to notice it can optimise away the
 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
 */
#define sk_getxdmdata(socket, lenp) (NULL)

/*
 * File-selector filter strings used in the config box. On Windows,
 * these strings are of exactly the type needed to go in
 * `lpstrFilter' in an OPENFILENAME structure.
 */
#define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
			      "All Files (*.*)\0*\0\0\0")
#define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
			       "All Files (*.*)\0*\0\0\0")
#define FILTER_DYNLIB_FILES ("Dynamic Library Files (*.dll)\0*.dll\0" \
				 "All Files (*.*)\0*\0\0\0")

/*
 * On some versions of Windows, it has been known for WM_TIMER to
 * occasionally get its callback time simply wrong, and call us
 * back several minutes early. Defining these symbols enables
 * compensation code in timing.c.
 */
#define TIMING_SYNC
#define TIMING_SYNC_TICKCOUNT

/*
 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
 * what it can get, which means any WinSock routines used outside
 * that module must be exported from it as function pointers. So
 * here they are.
 */
DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAAsyncSelect,
		      (SOCKET, HWND, u_int, long));
DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAEventSelect,
		      (SOCKET, WSAEVENT, long));
DECL_WINDOWS_FUNCTION(GLOBAL, int, select,
		      (int, fd_set FAR *, fd_set FAR *,
		       fd_set FAR *, const struct timeval FAR *));
DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAGetLastError, (void));
DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAEnumNetworkEvents,
		      (SOCKET, WSAEVENT, LPWSANETWORKEVENTS));

extern int socket_writable(SOCKET skt);

extern void socket_reselect_all(void);

/*
 * Exports from winctrls.c.
 */

struct ctlpos {
    HWND hwnd;
    WPARAM font;
    int dlu4inpix;
    int ypos, width;
    int xoff;
    int boxystart, boxid;
    char *boxtext;
};

/*
 * Exports from winutils.c.
 */
typedef struct filereq_tag filereq; /* cwd for file requester */
BOOL request_file(filereq *state, OPENFILENAME *of, int preserve, int save);
filereq *filereq_new(void);
void filereq_free(filereq *state);
int message_box(LPCTSTR text, LPCTSTR caption, DWORD style, DWORD helpctxid);
void split_into_argv(char *, int *, char ***, char ***);

/*
 * Private structure for prefslist state. Only in the header file
 * so that we can delegate allocation to callers.
 */
struct prefslist {
    int listid, upbid, dnbid;
    int srcitem;
    int dummyitem;
    int dragging;
};

/*
 * This structure is passed to event handler functions as the `dlg'
 * parameter, and hence is passed back to winctrls access functions.
 */
struct dlgparam {
    HWND hwnd;			       /* the hwnd of the dialog box */
    struct winctrls *controltrees[8];  /* can have several of these */
    int nctrltrees;
    char *wintitle;		       /* title of actual window */
    char *errtitle;		       /* title of error sub-messageboxes */
    void *data;			       /* data to pass in refresh events */
    union control *focused, *lastfocused; /* which ctrl has focus now/before */
    char shortcuts[128];	       /* track which shortcuts in use */
    int coloursel_wanted;	       /* has an event handler asked for
					* a colour selector? */
    struct { unsigned char r, g, b, ok; } coloursel_result;   /* 0-255 */
    tree234 *privdata;		       /* stores per-control private data */
    int ended, endresult;	       /* has the dialog been ended? */
};

/*
 * Exports from winctrls.c.
 */
void ctlposinit(struct ctlpos *cp, HWND hwnd,
		int leftborder, int rightborder, int topborder);
HWND doctl(struct ctlpos *cp, RECT r,
	   char *wclass, int wstyle, int exstyle, char *wtext, int wid);
void bartitle(struct ctlpos *cp, char *name, int id);
void beginbox(struct ctlpos *cp, char *name, int idbox);
void endbox(struct ctlpos *cp);
void editboxfw(struct ctlpos *cp, int password, char *text,
	       int staticid, int editid);
void radioline(struct ctlpos *cp, char *text, int id, int nacross, ...);
void bareradioline(struct ctlpos *cp, int nacross, ...);
void radiobig(struct ctlpos *cp, char *text, int id, ...);
void checkbox(struct ctlpos *cp, char *text, int id);
void statictext(struct ctlpos *cp, char *text, int lines, int id);
void staticbtn(struct ctlpos *cp, char *stext, int sid,
	       char *btext, int bid);
void static2btn(struct ctlpos *cp, char *stext, int sid,
		char *btext1, int bid1, char *btext2, int bid2);
void staticedit(struct ctlpos *cp, char *stext,
		int sid, int eid, int percentedit);
void staticddl(struct ctlpos *cp, char *stext,
	       int sid, int lid, int percentlist);
void combobox(struct ctlpos *cp, char *text, int staticid, int listid);
void staticpassedit(struct ctlpos *cp, char *stext,
		    int sid, int eid, int percentedit);
void bigeditctrl(struct ctlpos *cp, char *stext,
		 int sid, int eid, int lines);
void ersatztab(struct ctlpos *cp, char *stext, int sid, int lid, int s2id);
void editbutton(struct ctlpos *cp, char *stext, int sid,
		int eid, char *btext, int bid);
void sesssaver(struct ctlpos *cp, char *text,
	       int staticid, int editid, int listid, ...);
void envsetter(struct ctlpos *cp, char *stext, int sid,
	       char *e1stext, int e1sid, int e1id,
	       char *e2stext, int e2sid, int e2id,
	       int listid, char *b1text, int b1id, char *b2text, int b2id);
void charclass(struct ctlpos *cp, char *stext, int sid, int listid,
	       char *btext, int bid, int eid, char *s2text, int s2id);
void colouredit(struct ctlpos *cp, char *stext, int sid, int listid,
		char *btext, int bid, ...);
void prefslist(struct prefslist *hdl, struct ctlpos *cp, int lines,
	       char *stext, int sid, int listid, int upbid, int dnbid);
int handle_prefslist(struct prefslist *hdl,
		     int *array, int maxmemb,
		     int is_dlmsg, HWND hwnd,
		     WPARAM wParam, LPARAM lParam);
void progressbar(struct ctlpos *cp, int id);
void fwdsetter(struct ctlpos *cp, int listid, char *stext, int sid,
	       char *e1stext, int e1sid, int e1id,
	       char *e2stext, int e2sid, int e2id,
	       char *btext, int bid,
	       char *r1text, int r1id, char *r2text, int r2id);

#define MAX_SHORTCUTS_PER_CTRL 16

/*
 * This structure is what's stored for each `union control' in the
 * portable-dialog interface.
 */
struct winctrl {
    union control *ctrl;
    /*
     * The control may have several components at the Windows
     * level, with different dialog IDs. To avoid needing N
     * separate platformsidectrl structures (which could be stored
     * separately in a tree234 so that lookup by ID worked), we
     * impose the constraint that those IDs must be in a contiguous
     * block.
     */
    int base_id;
    int num_ids;
    /*
     * Remember what keyboard shortcuts were used by this control,
     * so that when we remove it again we can take them out of the
     * list in the dlgparam.
     */
    char shortcuts[MAX_SHORTCUTS_PER_CTRL];
    /*
     * Some controls need a piece of allocated memory in which to
     * store temporary data about the control.
     */
    void *data;
};
/*
 * And this structure holds a set of the above, in two separate
 * tree234s so that it can find an item by `union control' or by
 * dialog ID.
 */
struct winctrls {
    tree234 *byctrl, *byid;
};
struct controlset;
struct controlbox;

void winctrl_init(struct winctrls *);
void winctrl_cleanup(struct winctrls *);
void winctrl_add(struct winctrls *, struct winctrl *);
void winctrl_remove(struct winctrls *, struct winctrl *);
struct winctrl *winctrl_findbyctrl(struct winctrls *, union control *);
struct winctrl *winctrl_findbyid(struct winctrls *, int);
struct winctrl *winctrl_findbyindex(struct winctrls *, int);
void winctrl_layout(struct dlgparam *dp, struct winctrls *wc,
		    struct ctlpos *cp, struct controlset *s, int *id);
int winctrl_handle_command(struct dlgparam *dp, UINT msg,
			   WPARAM wParam, LPARAM lParam);
void winctrl_rem_shortcuts(struct dlgparam *dp, struct winctrl *c);
int winctrl_context_help(struct dlgparam *dp, HWND hwnd, int id);

void dp_init(struct dlgparam *dp);
void dp_add_tree(struct dlgparam *dp, struct winctrls *tree);
void dp_cleanup(struct dlgparam *dp);

/*
 * Exports from wincfg.c.
 */
void win_setup_config_box(struct controlbox *b, HWND *hwndp, int has_help,
			  int midsession, int protocol);

/*
 * Exports from windlg.c.
 */
void defuse_showwindow(void);
int do_config(void);
int do_reconfig(HWND, int);
void showeventlog(HWND);
void showabout(HWND);
void force_normal(HWND hwnd);
void modal_about_box(HWND hwnd);
void show_help(HWND hwnd);

/*
 * Exports from winmisc.c.
 */
extern OSVERSIONINFO osVersion;
BOOL init_winver(void);
HMODULE load_system32_dll(const char *libname);

/*
 * Exports from sizetip.c.
 */
void UpdateSizeTip(HWND src, int cx, int cy);
void EnableSizeTip(int bEnable);

/*
 * Exports from unicode.c.
 */
struct unicode_data;
void init_ucs(Config *, struct unicode_data *);

/*
 * Exports from winhandl.c.
 */
#define HANDLE_FLAG_OVERLAPPED 1
#define HANDLE_FLAG_IGNOREEOF 2
#define HANDLE_FLAG_UNITBUFFER 4
struct handle;
typedef int (*handle_inputfn_t)(struct handle *h, void *data, int len);
typedef void (*handle_outputfn_t)(struct handle *h, int new_backlog);
struct handle *handle_input_new(HANDLE handle, handle_inputfn_t gotdata,
				void *privdata, int flags);
struct handle *handle_output_new(HANDLE handle, handle_outputfn_t sentdata,
				 void *privdata, int flags);
int handle_write(struct handle *h, const void *data, int len);
HANDLE *handle_get_events(int *nevents);
void handle_free(struct handle *h);
void handle_got_event(HANDLE event);
void handle_unthrottle(struct handle *h, int backlog);
int handle_backlog(struct handle *h);
void *handle_get_privdata(struct handle *h);

/*
 * pageantc.c needs to schedule callbacks for asynchronous agent
 * requests. This has to be done differently in GUI and console, so
 * there's an exported function used for the purpose.
 * 
 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
 * synchronous in pscp and psftp.
 */
void agent_schedule_callback(void (*callback)(void *, void *, int),
			     void *callback_ctx, void *data, int len);
#define FLAG_SYNCAGENT 0x1000

/*
 * Exports from winser.c.
 */
extern Backend serial_backend;

/*
 * Exports from winjump.c.
 */
#define JUMPLIST_SUPPORTED             /* suppress #defines in putty.h */
void add_session_to_jumplist(const char * const sessionname);
void remove_session_from_jumplist(const char * const sessionname);

/*
 * Extra functions in winstore.c over and above the interface in
 * storage.h.
 *
 * These functions manipulate the Registry section which mirrors the
 * current Windows 7 jump list. (Because the real jump list storage is
 * write-only, we need to keep another copy of whatever we put in it,
 * so that we can put in a slightly modified version the next time.)
 */

/* Adds a saved session to the registry jump list mirror. 'item' is a
 * string naming a saved session. */
int add_to_jumplist_registry(const char *item);

/* Removes an item from the registry jump list mirror. */
int remove_from_jumplist_registry(const char *item);

/* Returns the current jump list entries from the registry. Caller
 * must free the returned pointer, which points to a contiguous
 * sequence of NUL-terminated strings in memory, terminated with an
 * empty one. */
char *get_jumplist_registry_entries(void);

#endif
Commit	Line	Data
8c3cd914	1	/*
	2	* winstuff.h: Windows-specific inter-module stuff.
	3	*/
	4
f7f27309	5	#ifndef PUTTY_WINSTUFF_H
	6	#define PUTTY_WINSTUFF_H
	7
7440fd44	8	#ifndef AUTO_WINSOCK
	9	#include <winsock2.h>
	10	#endif
	11	#include <windows.h>
9a30e26b	12	#include <stdio.h> /* for FILENAME_MAX */
9a30e26b	13
fe8abbf4	14	#include "tree234.h"
	15
	16	#include "winhelp.h"
	17
9a30e26b	18	struct Filename {
	19	char path[FILENAME_MAX];
	20	};
c6940f12	21	#define f_open(filename, mode, isprivate) ( fopen((filename).path, (mode)) )
9a30e26b	22
	23	struct FontSpec {
	24	char name[64];
	25	int isbold;
	26	int height;
	27	int charset;
	28	};
	29
17c7fed1	30	#ifndef CLEARTYPE_QUALITY
	31	#define CLEARTYPE_QUALITY 5
	32	#endif
	33	#define FONT_QUALITY(fq) ( \
	34	(fq) == FQ_DEFAULT ? DEFAULT_QUALITY : \
	35	(fq) == FQ_ANTIALIASED ? ANTIALIASED_QUALITY : \
	36	(fq) == FQ_NONANTIALIASED ? NONANTIALIASED_QUALITY : \
	37	CLEARTYPE_QUALITY)
	38
61ef0c16	39	#define PLATFORM_IS_UTF16 /* enable UTF-16 processing when exchanging
	40	* wchar_t strings with environment */
	41
158cb9b1	42	/*
	43	* Where we can, we use GetWindowLongPtr and friends because they're
	44	* more useful on 64-bit platforms, but they're a relatively recent
	45	* innovation, missing from VC++ 6 and older MinGW. Degrade nicely.
	46	* (NB that on some systems, some of these things are available but
	47	* not others...)
	48	*/
17c7fed1	49
158cb9b1	50	#ifndef GCLP_HCURSOR
	51	/* GetClassLongPtr and friends */
	52	#undef GetClassLongPtr
	53	#define GetClassLongPtr GetClassLong
	54	#undef SetClassLongPtr
	55	#define SetClassLongPtr SetClassLong
	56	#define GCLP_HCURSOR GCL_HCURSOR
	57	/* GetWindowLongPtr and friends */
	58	#undef GetWindowLongPtr
17c7fed1	59	#define GetWindowLongPtr GetWindowLong
158cb9b1	60	#undef SetWindowLongPtr
17c7fed1	61	#define SetWindowLongPtr SetWindowLong
158cb9b1	62	#undef GWLP_USERDATA
17c7fed1	63	#define GWLP_USERDATA GWL_USERDATA
158cb9b1	64	#undef DWLP_MSGRESULT
17c7fed1	65	#define DWLP_MSGRESULT DWL_MSGRESULT
158cb9b1	66	/* Since we've clobbered the above functions, we should clobber the
	67	* associated type regardless of whether it's defined. */
	68	#undef LONG_PTR
	69	#define LONG_PTR LONG
17c7fed1	70	#endif
17c7fed1	71
2979718a	72	#define BOXFLAGS DLGWINDOWEXTRA
1e5eefb6	73	#define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
8ee3ff16	74	#define DF_END 0x0001
8ee3ff16	75
8c3cd914	76	/*
d0f67860	77	* Dynamically linked functions. These come in two flavours:
	78	*
	79	* - GET_WINDOWS_FUNCTION does not expose "name" to the preprocessor,
	80	* so will always dynamically link against exactly what is specified
	81	* in "name". If you're not sure, use this one.
	82	*
	83	* - GET_WINDOWS_FUNCTION_PP allows "name" to be redirected via
	84	* preprocessor definitions like "#define foo bar"; this is principally
	85	* intended for the ANSI/Unicode DoSomething/DoSomethingA/DoSomethingW.
	86	* If your function has an argument of type "LPTSTR" or similar, this
	87	* is the variant to use.
	88	* (However, it can't always be used, as it trips over more complicated
	89	* macro trickery such as the WspiapiGetAddrInfo wrapper for getaddrinfo.)
	90	*
	91	* (DECL_WINDOWS_FUNCTION works with both these variants.)
65d1432e	92	*/
	93	#define DECL_WINDOWS_FUNCTION(linkage, rettype, name, params) \
	94	typedef rettype (WINAPI *t_##name) params; \
	95	linkage t_##name p_##name
	96	#define STR1(x) #x
	97	#define STR(x) STR1(x)
d0f67860	98	#define GET_WINDOWS_FUNCTION_PP(module, name) \
a197b711	99	(p_##name = module ? (t_##name) GetProcAddress(module, STR(name)) : NULL)
d0f67860	100	#define GET_WINDOWS_FUNCTION(module, name) \
a197b711	101	(p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL)
65d1432e	102
65d1432e	103	/*
8c3cd914	104	* Global variables. Most modules declare these `extern', but
	105	* window.c will do `#define PUTTY_DO_GLOBALS' before including this
	106	* module, and so will get them properly defined.
2979718a	107	*/
f7f27309	108	#ifndef GLOBAL
8c3cd914	109	#ifdef PUTTY_DO_GLOBALS
	110	#define GLOBAL
	111	#else
	112	#define GLOBAL extern
	113	#endif
f7f27309	114	#endif
f7f27309	115
a8327734	116	#ifndef DONE_TYPEDEFS
	117	#define DONE_TYPEDEFS
	118	typedef struct config_tag Config;
	119	typedef struct backend_tag Backend;
	120	typedef struct terminal_tag Terminal;
	121	#endif
	122
f7f27309	123	#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
	124	#define PUTTY_REG_PARENT "Software\\SimonTatham"
	125	#define PUTTY_REG_PARENT_CHILD "PuTTY"
	126	#define PUTTY_REG_GPARENT "Software"
	127	#define PUTTY_REG_GPARENT_CHILD "SimonTatham"
	128
073e9f42	129	/* Result values for the jumplist registry functions. */
	130	#define JUMPLISTREG_OK 0
	131	#define JUMPLISTREG_ERROR_INVALID_PARAMETER 1
	132	#define JUMPLISTREG_ERROR_KEYOPENCREATE_FAILURE 2
	133	#define JUMPLISTREG_ERROR_VALUEREAD_FAILURE 3
	134	#define JUMPLISTREG_ERROR_VALUEWRITE_FAILURE 4
	135	#define JUMPLISTREG_ERROR_INVALID_VALUE 5
	136
a9dc49af	137	#define PUTTY_HELP_FILE "putty.hlp"
cb2708d3	138	#define PUTTY_CHM_FILE "putty.chm"
a9dc49af	139	#define PUTTY_HELP_CONTENTS "putty.cnt"
a9dc49af	140
f7f27309	141	#define GETTICKCOUNT GetTickCount
	142	#define CURSORBLINK GetCaretBlinkTime()
	143	#define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
	144
	145	#define DEFAULT_CODEPAGE CP_ACP
	146
	147	typedef HDC Context;
8c3cd914	148
b3d375b2	149	typedef unsigned int uint32; /* int is 32-bits on Win32 and Win64. */
	150	#define PUTTY_UINT32_DEFINED
	151
86557057	152	#ifndef NO_GSSAPI
	153	/*
	154	* GSS-API stuff
	155	*/
b3d375b2	156	#define GSS_CC CALLBACK
b3d375b2	157	/*
86557057	158	typedef struct Ssh_gss_buf {
b3d375b2	159	size_t length;
86557057	160	char *value;
	161	} Ssh_gss_buf;
	162
	163	#define SSH_GSS_EMPTY_BUF (Ssh_gss_buf) {0,NULL}
2c2bce14	164	typedef void *Ssh_gss_name;
b3d375b2	165	*/
86557057	166	#endif
86557057	167
f7f27309	168	/*
5321c0c6	169	* Window handles for the windows that can be running during a
f7f27309	170	* PuTTY session.
f7f27309	171	*/
5321c0c6	172	GLOBAL HWND hwnd; /* the main terminal window */
f7f27309	173	GLOBAL HWND logbox;
	174
	175	/*
	176	* The all-important instance handle.
	177	*/
8c3cd914	178	GLOBAL HINSTANCE hinst;
	179
	180	/*
cb2708d3	181	* Help file stuff in winhelp.c.
6b78788a	182	*/
cb2708d3	183	void init_help(void);
	184	void shutdown_help(void);
	185	int has_help(void);
	186	void launch_help(HWND hwnd, const char *topic);
	187	void quit_help(HWND hwnd);
6b78788a	188
6b78788a	189	/*
a8327734	190	* The terminal and logging context are notionally local to the
a8327734	191	* Windows front end, but they must be shared between window.c and
0b4f0bc0	192	* windlg.c. Likewise the saved-sessions list.
a8327734	193	*/
	194	GLOBAL Terminal *term;
	195	GLOBAL void *logctx;
	196
604fab0c	197	#define WM_NETEVENT (WM_APP + 5)
f7f27309	198
f7f27309	199	/*
e6346999	200	* On Windows, we send MA_2CLK as the only event marking the second
	201	* press of a mouse button. Compare unix.h.
	202	*/
	203	#define MULTICLICK_ONLY_EVENT 1
	204
	205	/*
	206	* On Windows, data written to the clipboard must be NUL-terminated.
	207	*/
	208	#define SELECTION_NUL_TERMINATED 1
	209
	210	/*
0f351587	211	* On Windows, copying to the clipboard terminates lines with CRLF.
	212	*/
	213	#define SEL_NL { 13, 10 }
	214
	215	/*
2f92b717	216	* sk_getxdmdata() does not exist under Windows (not that I
2f92b717	217	* couldn't write it if I wanted to, but I haven't bothered), so
0a4022a1	218	* it's a macro which always returns NULL. With any luck this will
2f92b717	219	* cause the compiler to notice it can optimise away the
	220	* implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
	221	*/
0a4022a1	222	#define sk_getxdmdata(socket, lenp) (NULL)
2f92b717	223
2f92b717	224	/*
fe8abbf4	225	* File-selector filter strings used in the config box. On Windows,
	226	* these strings are of exactly the type needed to go in
	227	* `lpstrFilter' in an OPENFILENAME structure.
	228	*/
	229	#define FILTER_KEY_FILES ("PuTTY Private Key Files (.ppk)\0.ppk\0" \
	230	"All Files (.)\0*\0\0\0")
	231	#define FILTER_WAVE_FILES ("Wave Files (.wav)\0.WAV\0" \
	232	"All Files (.)\0*\0\0\0")
1e00c92b	233	#define FILTER_DYNLIB_FILES ("Dynamic Library Files (.dll)\0.dll\0" \
1e00c92b	234	"All Files (.)\0*\0\0\0")
fe8abbf4	235
fe8abbf4	236	/*
2ac3322e	237	* On some versions of Windows, it has been known for WM_TIMER to
	238	* occasionally get its callback time simply wrong, and call us
	239	* back several minutes early. Defining these symbols enables
	240	* compensation code in timing.c.
	241	*/
	242	#define TIMING_SYNC
	243	#define TIMING_SYNC_TICKCOUNT
	244
	245	/*
7440fd44	246	* winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
	247	* what it can get, which means any WinSock routines used outside
	248	* that module must be exported from it as function pointers. So
	249	* here they are.
	250	*/
65d1432e	251	DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAAsyncSelect,
	252	(SOCKET, HWND, u_int, long));
	253	DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAEventSelect,
	254	(SOCKET, WSAEVENT, long));
	255	DECL_WINDOWS_FUNCTION(GLOBAL, int, select,
	256	(int, fd_set FAR , fd_set FAR ,
	257	fd_set FAR , const struct timeval FAR ));
	258	DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAGetLastError, (void));
	259	DECL_WINDOWS_FUNCTION(GLOBAL, int, WSAEnumNetworkEvents,
	260	(SOCKET, WSAEVENT, LPWSANETWORKEVENTS));
7440fd44	261
39934deb	262	extern int socket_writable(SOCKET skt);
39934deb	263
9f7ebadc	264	extern void socket_reselect_all(void);
9f7ebadc	265
7440fd44	266	/*
8c3cd914	267	* Exports from winctrls.c.
	268	*/
	269
	270	struct ctlpos {
	271	HWND hwnd;
	272	WPARAM font;
	273	int dlu4inpix;
	274	int ypos, width;
	275	int xoff;
3ac9cd9f	276	int boxystart, boxid;
8c3cd914	277	char *boxtext;
	278	};
	279
ca20bfcf	280	/*
c0a81592	281	* Exports from winutils.c.
c0a81592	282	*/
9754e5ca	283	typedef struct filereq_tag filereq; /* cwd for file requester */
	284	BOOL request_file(filereq state, OPENFILENAME of, int preserve, int save);
	285	filereq *filereq_new(void);
	286	void filereq_free(filereq *state);
690695e0	287	int message_box(LPCTSTR text, LPCTSTR caption, DWORD style, DWORD helpctxid);
d3a1a808	288	void split_into_argv(char , int , char *, char *);
c0a81592	289
c0a81592	290	/*
ca20bfcf	291	* Private structure for prefslist state. Only in the header file
	292	* so that we can delegate allocation to callers.
	293	*/
	294	struct prefslist {
	295	int listid, upbid, dnbid;
	296	int srcitem;
	297	int dummyitem;
	298	int dragging;
	299	};
	300
f7f27309	301	/*
fe8abbf4	302	* This structure is passed to event handler functions as the `dlg'
	303	* parameter, and hence is passed back to winctrls access functions.
	304	*/
	305	struct dlgparam {
	306	HWND hwnd; /* the hwnd of the dialog box */
	307	struct winctrls controltrees[8]; / can have several of these */
	308	int nctrltrees;
f6f450e2	309	char wintitle; / title of actual window */
fe8abbf4	310	char errtitle; / title of error sub-messageboxes */
	311	void data; / data to pass in refresh events */
	312	union control focused, lastfocused; /* which ctrl has focus now/before */
4e6d4091	313	char shortcuts[128]; /* track which shortcuts in use */
fe8abbf4	314	int coloursel_wanted; /* has an event handler asked for
fe8abbf4	315	* a colour selector? */
fe8abbf4	316	struct { unsigned char r, g, b, ok; } coloursel_result; /* 0-255 */
4e6d4091	317	tree234 privdata; / stores per-control private data */
fe8abbf4	318	int ended, endresult; /* has the dialog been ended? */
	319	};
	320
	321	/*
f7f27309	322	* Exports from winctrls.c.
f7f27309	323	*/
8c3cd914	324	void ctlposinit(struct ctlpos *cp, HWND hwnd,
32874aea	325	int leftborder, int rightborder, int topborder);
ca20bfcf	326	HWND doctl(struct ctlpos *cp, RECT r,
32874aea	327	char wclass, int wstyle, int exstyle, char wtext, int wid);
8c3cd914	328	void bartitle(struct ctlpos cp, char name, int id);
3ac9cd9f	329	void beginbox(struct ctlpos cp, char name, int idbox);
8c3cd914	330	void endbox(struct ctlpos *cp);
e73667f3	331	void editboxfw(struct ctlpos cp, int password, char text,
e73667f3	332	int staticid, int editid);
32874aea	333	void radioline(struct ctlpos cp, char text, int id, int nacross, ...);
d74d141c	334	void bareradioline(struct ctlpos *cp, int nacross, ...);
8c3cd914	335	void radiobig(struct ctlpos cp, char text, int id, ...);
8c3cd914	336	void checkbox(struct ctlpos cp, char text, int id);
66ee282a	337	void statictext(struct ctlpos cp, char text, int lines, int id);
8c3cd914	338	void staticbtn(struct ctlpos cp, char stext, int sid,
32874aea	339	char *btext, int bid);
af282e3b	340	void static2btn(struct ctlpos cp, char stext, int sid,
af282e3b	341	char btext1, int bid1, char btext2, int bid2);
8c3cd914	342	void staticedit(struct ctlpos cp, char stext,
32874aea	343	int sid, int eid, int percentedit);
2c9c6388	344	void staticddl(struct ctlpos cp, char stext,
2c9c6388	345	int sid, int lid, int percentlist);
b8ae1f0f	346	void combobox(struct ctlpos cp, char text, int staticid, int listid);
6e522441	347	void staticpassedit(struct ctlpos cp, char stext,
32874aea	348	int sid, int eid, int percentedit);
6e522441	349	void bigeditctrl(struct ctlpos cp, char stext,
32874aea	350	int sid, int eid, int lines);
32874aea	351	void ersatztab(struct ctlpos cp, char stext, int sid, int lid, int s2id);
8c3cd914	352	void editbutton(struct ctlpos cp, char stext, int sid,
32874aea	353	int eid, char *btext, int bid);
8c3cd914	354	void sesssaver(struct ctlpos cp, char text,
32874aea	355	int staticid, int editid, int listid, ...);
8c3cd914	356	void envsetter(struct ctlpos cp, char stext, int sid,
32874aea	357	char *e1stext, int e1sid, int e1id,
	358	char *e2stext, int e2sid, int e2id,
	359	int listid, char b1text, int b1id, char b2text, int b2id);
8c3cd914	360	void charclass(struct ctlpos cp, char stext, int sid, int listid,
32874aea	361	char btext, int bid, int eid, char s2text, int s2id);
8c3cd914	362	void colouredit(struct ctlpos cp, char stext, int sid, int listid,
32874aea	363	char *btext, int bid, ...);
fe8abbf4	364	void prefslist(struct prefslist hdl, struct ctlpos cp, int lines,
fe8abbf4	365	char *stext, int sid, int listid, int upbid, int dnbid);
ca20bfcf	366	int handle_prefslist(struct prefslist *hdl,
	367	int *array, int maxmemb,
	368	int is_dlmsg, HWND hwnd,
	369	WPARAM wParam, LPARAM lParam);
6e522441	370	void progressbar(struct ctlpos *cp, int id);
d74d141c	371	void fwdsetter(struct ctlpos cp, int listid, char stext, int sid,
	372	char *e1stext, int e1sid, int e1id,
	373	char *e2stext, int e2sid, int e2id,
a4b92c62	374	char *btext, int bid,
a4b92c62	375	char r1text, int r1id, char r2text, int r2id);
f7f27309	376
fe8abbf4	377	#define MAX_SHORTCUTS_PER_CTRL 16
	378
	379	/*
	380	* This structure is what's stored for each `union control' in the
	381	* portable-dialog interface.
	382	*/
	383	struct winctrl {
	384	union control *ctrl;
	385	/*
	386	* The control may have several components at the Windows
	387	* level, with different dialog IDs. To avoid needing N
	388	* separate platformsidectrl structures (which could be stored
	389	* separately in a tree234 so that lookup by ID worked), we
	390	* impose the constraint that those IDs must be in a contiguous
	391	* block.
	392	*/
	393	int base_id;
	394	int num_ids;
	395	/*
	396	* Remember what keyboard shortcuts were used by this control,
	397	* so that when we remove it again we can take them out of the
	398	* list in the dlgparam.
	399	*/
	400	char shortcuts[MAX_SHORTCUTS_PER_CTRL];
	401	/*
	402	* Some controls need a piece of allocated memory in which to
	403	* store temporary data about the control.
	404	*/
	405	void *data;
	406	};
	407	/*
	408	* And this structure holds a set of the above, in two separate
	409	* tree234s so that it can find an item by `union control' or by
	410	* dialog ID.
	411	*/
	412	struct winctrls {
	413	tree234 byctrl, byid;
	414	};
d1582b2e	415	struct controlset;
	416	struct controlbox;
	417
fe8abbf4	418	void winctrl_init(struct winctrls *);
	419	void winctrl_cleanup(struct winctrls *);
	420	void winctrl_add(struct winctrls , struct winctrl );
	421	void winctrl_remove(struct winctrls , struct winctrl );
	422	struct winctrl winctrl_findbyctrl(struct winctrls , union control *);
	423	struct winctrl winctrl_findbyid(struct winctrls , int);
	424	struct winctrl winctrl_findbyindex(struct winctrls , int);
	425	void winctrl_layout(struct dlgparam dp, struct winctrls wc,
	426	struct ctlpos cp, struct controlset s, int *id);
	427	int winctrl_handle_command(struct dlgparam *dp, UINT msg,
	428	WPARAM wParam, LPARAM lParam);
d1582b2e	429	void winctrl_rem_shortcuts(struct dlgparam dp, struct winctrl c);
	430	int winctrl_context_help(struct dlgparam *dp, HWND hwnd, int id);
	431
4e6d4091	432	void dp_init(struct dlgparam *dp);
	433	void dp_add_tree(struct dlgparam dp, struct winctrls tree);
	434	void dp_cleanup(struct dlgparam *dp);
	435
d1582b2e	436	/*
	437	* Exports from wincfg.c.
	438	*/
	439	void win_setup_config_box(struct controlbox b, HWND hwndp, int has_help,
8a7f1392	440	int midsession, int protocol);
fe8abbf4	441
f7f27309	442	/*
	443	* Exports from windlg.c.
	444	*/
	445	void defuse_showwindow(void);
	446	int do_config(void);
f89c3294	447	int do_reconfig(HWND, int);
f7f27309	448	void showeventlog(HWND);
f7f27309	449	void showabout(HWND);
f7f27309	450	void force_normal(HWND hwnd);
d1582b2e	451	void modal_about_box(HWND hwnd);
d1582b2e	452	void show_help(HWND hwnd);
f7f27309	453
f7f27309	454	/*
8ee3ff16	455	* Exports from winmisc.c.
8ee3ff16	456	*/
4c48c989	457	extern OSVERSIONINFO osVersion;
4c48c989	458	BOOL init_winver(void);
bda368a5	459	HMODULE load_system32_dll(const char *libname);
4c48c989	460
8ee3ff16	461	/*
f7f27309	462	* Exports from sizetip.c.
	463	*/
	464	void UpdateSizeTip(HWND src, int cx, int cy);
	465	void EnableSizeTip(int bEnable);
	466
facd762c	467	/*
	468	* Exports from unicode.c.
	469	*/
07b2a9cd	470	struct unicode_data;
21d2b241	471	void init_ucs(Config , struct unicode_data );
facd762c	472
c44bf5bd	473	/*
34292b1d	474	* Exports from winhandl.c.
34292b1d	475	*/
bdebd7e9	476	#define HANDLE_FLAG_OVERLAPPED 1
bdebd7e9	477	#define HANDLE_FLAG_IGNOREEOF 2
799e067e	478	#define HANDLE_FLAG_UNITBUFFER 4
34292b1d	479	struct handle;
	480	typedef int (handle_inputfn_t)(struct handle h, void *data, int len);
	481	typedef void (handle_outputfn_t)(struct handle h, int new_backlog);
0e03ceff	482	struct handle *handle_input_new(HANDLE handle, handle_inputfn_t gotdata,
bdebd7e9	483	void *privdata, int flags);
0e03ceff	484	struct handle *handle_output_new(HANDLE handle, handle_outputfn_t sentdata,
bdebd7e9	485	void *privdata, int flags);
34292b1d	486	int handle_write(struct handle h, const void data, int len);
	487	HANDLE handle_get_events(int nevents);
	488	void handle_free(struct handle *h);
	489	void handle_got_event(HANDLE event);
	490	void handle_unthrottle(struct handle *h, int backlog);
	491	int handle_backlog(struct handle *h);
0e03ceff	492	void handle_get_privdata(struct handle h);
34292b1d	493
34292b1d	494	/*
c44bf5bd	495	* pageantc.c needs to schedule callbacks for asynchronous agent
	496	* requests. This has to be done differently in GUI and console, so
	497	* there's an exported function used for the purpose.
	498	*
	499	* Also, we supply FLAG_SYNCAGENT to force agent requests to be
	500	* synchronous in pscp and psftp.
	501	*/
	502	void agent_schedule_callback(void (callback)(void , void *, int),
	503	void callback_ctx, void data, int len);
	504	#define FLAG_SYNCAGENT 0x1000
	505
7374c779	506	/*
	507	* Exports from winser.c.
	508	*/
	509	extern Backend serial_backend;
	510
073e9f42	511	/*
	512	* Exports from winjump.c.
	513	*/
	514	#define JUMPLIST_SUPPORTED /* suppress #defines in putty.h */
	515	void add_session_to_jumplist(const char * const sessionname);
	516	void remove_session_from_jumplist(const char * const sessionname);
	517
	518	/*
	519	* Extra functions in winstore.c over and above the interface in
	520	* storage.h.
	521	*
	522	* These functions manipulate the Registry section which mirrors the
	523	* current Windows 7 jump list. (Because the real jump list storage is
	524	* write-only, we need to keep another copy of whatever we put in it,
	525	* so that we can put in a slightly modified version the next time.)
	526	*/
	527
	528	/* Adds a saved session to the registry jump list mirror. 'item' is a
	529	* string naming a saved session. */
	530	int add_to_jumplist_registry(const char *item);
	531
	532	/* Removes an item from the registry jump list mirror. */
	533	int remove_from_jumplist_registry(const char *item);
	534
	535	/* Returns the current jump list entries from the registry. Caller
	536	* must free the returned pointer, which points to a contiguous
	537	* sequence of NUL-terminated strings in memory, terminated with an
	538	* empty one. */
	539	char *get_jumplist_registry_entries(void);
	540
f7f27309	541	#endif