2 * winstuff.h: Windows-specific inter-module stuff.
5 #ifndef PUTTY_WINSTUFF_H
6 #define PUTTY_WINSTUFF_H
12 #include <stdio.h> /* for FILENAME_MAX */
19 char path[FILENAME_MAX];
21 #define f_open(filename, mode, isprivate) ( fopen((filename).path, (mode)) )
30 #ifndef CLEARTYPE_QUALITY
31 #define CLEARTYPE_QUALITY 5
33 #define FONT_QUALITY(fq) ( \
34 (fq) == FQ_DEFAULT ? DEFAULT_QUALITY : \
35 (fq) == FQ_ANTIALIASED ? ANTIALIASED_QUALITY : \
36 (fq) == FQ_NONANTIALIASED ? NONANTIALIASED_QUALITY : \
40 * Where we can, we use GetWindowLongPtr and friends because they're
41 * more useful on 64-bit platforms, but they're a relatively recent
42 * innovation, missing from VC++ 6 and older MinGW. Degrade nicely.
43 * (NB that on some systems, some of these things are available but
48 /* GetClassLongPtr and friends */
49 #undef GetClassLongPtr
50 #define GetClassLongPtr GetClassLong
51 #undef SetClassLongPtr
52 #define SetClassLongPtr SetClassLong
53 #define GCLP_HCURSOR GCL_HCURSOR
54 /* GetWindowLongPtr and friends */
55 #undef GetWindowLongPtr
56 #define GetWindowLongPtr GetWindowLong
57 #undef SetWindowLongPtr
58 #define SetWindowLongPtr SetWindowLong
60 #define GWLP_USERDATA GWL_USERDATA
62 #define DWLP_MSGRESULT DWL_MSGRESULT
63 /* Since we've clobbered the above functions, we should clobber the
64 * associated type regardless of whether it's defined. */
69 #define BOXFLAGS DLGWINDOWEXTRA
70 #define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
74 * Global variables. Most modules declare these `extern', but
75 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
76 * module, and so will get them properly defined.
79 #ifdef PUTTY_DO_GLOBALS
88 typedef struct config_tag Config;
89 typedef struct backend_tag Backend;
90 typedef struct terminal_tag Terminal;
93 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
94 #define PUTTY_REG_PARENT "Software\\SimonTatham"
95 #define PUTTY_REG_PARENT_CHILD "PuTTY"
96 #define PUTTY_REG_GPARENT "Software"
97 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
99 #define PUTTY_HELP_FILE "putty.hlp"
100 #define PUTTY_CHM_FILE "putty.chm"
101 #define PUTTY_HELP_CONTENTS "putty.cnt"
103 #define GETTICKCOUNT GetTickCount
104 #define CURSORBLINK GetCaretBlinkTime()
105 #define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
107 #define DEFAULT_CODEPAGE CP_ACP
112 * Window handles for the windows that can be running during a
115 GLOBAL HWND hwnd; /* the main terminal window */
119 * The all-important instance handle.
121 GLOBAL HINSTANCE hinst;
124 * Help file stuff in winhelp.c.
126 void init_help(void);
127 void shutdown_help(void);
129 void launch_help(HWND hwnd, const char *topic);
130 void quit_help(HWND hwnd);
133 * The terminal and logging context are notionally local to the
134 * Windows front end, but they must be shared between window.c and
135 * windlg.c. Likewise the saved-sessions list.
137 GLOBAL Terminal *term;
140 #define WM_NETEVENT (WM_APP + 5)
143 * On Windows, we send MA_2CLK as the only event marking the second
144 * press of a mouse button. Compare unix.h.
146 #define MULTICLICK_ONLY_EVENT 1
149 * On Windows, data written to the clipboard must be NUL-terminated.
151 #define SELECTION_NUL_TERMINATED 1
154 * On Windows, copying to the clipboard terminates lines with CRLF.
156 #define SEL_NL { 13, 10 }
159 * sk_getxdmdata() does not exist under Windows (not that I
160 * couldn't write it if I wanted to, but I haven't bothered), so
161 * it's a macro which always returns NULL. With any luck this will
162 * cause the compiler to notice it can optimise away the
163 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
165 #define sk_getxdmdata(socket, lenp) (NULL)
168 * File-selector filter strings used in the config box. On Windows,
169 * these strings are of exactly the type needed to go in
170 * `lpstrFilter' in an OPENFILENAME structure.
172 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
173 "All Files (*.*)\0*\0\0\0")
174 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
175 "All Files (*.*)\0*\0\0\0")
178 * On some versions of Windows, it has been known for WM_TIMER to
179 * occasionally get its callback time simply wrong, and call us
180 * back several minutes early. Defining these symbols enables
181 * compensation code in timing.c.
184 #define TIMING_SYNC_TICKCOUNT
187 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
188 * what it can get, which means any WinSock routines used outside
189 * that module must be exported from it as function pointers. So
192 extern int (WINAPI *p_WSAAsyncSelect)
193 (SOCKET s, HWND hWnd, u_int wMsg, long lEvent);
194 extern int (WINAPI *p_WSAEventSelect)
195 (SOCKET s, WSAEVENT hEventObject, long lNetworkEvents);
196 extern int (WINAPI *p_select)
197 (int nfds, fd_set FAR * readfds, fd_set FAR * writefds,
198 fd_set FAR *exceptfds, const struct timeval FAR * timeout);
199 extern int (WINAPI *p_WSAGetLastError)(void);
200 extern int (WINAPI *p_WSAEnumNetworkEvents)
201 (SOCKET s, WSAEVENT hEventObject, LPWSANETWORKEVENTS lpNetworkEvents);
203 extern int socket_writable(SOCKET skt);
205 extern void socket_reselect_all(void);
208 * Exports from winctrls.c.
217 int boxystart, boxid;
222 * Exports from winutils.c.
224 typedef struct filereq_tag filereq; /* cwd for file requester */
225 BOOL request_file(filereq *state, OPENFILENAME *of, int preserve, int save);
226 filereq *filereq_new(void);
227 void filereq_free(filereq *state);
228 int message_box(LPCTSTR text, LPCTSTR caption, DWORD style, DWORD helpctxid);
229 void split_into_argv(char *, int *, char ***, char ***);
232 * Private structure for prefslist state. Only in the header file
233 * so that we can delegate allocation to callers.
236 int listid, upbid, dnbid;
243 * This structure is passed to event handler functions as the `dlg'
244 * parameter, and hence is passed back to winctrls access functions.
247 HWND hwnd; /* the hwnd of the dialog box */
248 struct winctrls *controltrees[8]; /* can have several of these */
250 char *wintitle; /* title of actual window */
251 char *errtitle; /* title of error sub-messageboxes */
252 void *data; /* data to pass in refresh events */
253 union control *focused, *lastfocused; /* which ctrl has focus now/before */
254 char shortcuts[128]; /* track which shortcuts in use */
255 int coloursel_wanted; /* has an event handler asked for
256 * a colour selector? */
257 struct { unsigned char r, g, b, ok; } coloursel_result; /* 0-255 */
258 tree234 *privdata; /* stores per-control private data */
259 int ended, endresult; /* has the dialog been ended? */
263 * Exports from winctrls.c.
265 void ctlposinit(struct ctlpos *cp, HWND hwnd,
266 int leftborder, int rightborder, int topborder);
267 HWND doctl(struct ctlpos *cp, RECT r,
268 char *wclass, int wstyle, int exstyle, char *wtext, int wid);
269 void bartitle(struct ctlpos *cp, char *name, int id);
270 void beginbox(struct ctlpos *cp, char *name, int idbox);
271 void endbox(struct ctlpos *cp);
272 void editboxfw(struct ctlpos *cp, int password, char *text,
273 int staticid, int editid);
274 void radioline(struct ctlpos *cp, char *text, int id, int nacross, ...);
275 void bareradioline(struct ctlpos *cp, int nacross, ...);
276 void radiobig(struct ctlpos *cp, char *text, int id, ...);
277 void checkbox(struct ctlpos *cp, char *text, int id);
278 void statictext(struct ctlpos *cp, char *text, int lines, int id);
279 void staticbtn(struct ctlpos *cp, char *stext, int sid,
280 char *btext, int bid);
281 void static2btn(struct ctlpos *cp, char *stext, int sid,
282 char *btext1, int bid1, char *btext2, int bid2);
283 void staticedit(struct ctlpos *cp, char *stext,
284 int sid, int eid, int percentedit);
285 void staticddl(struct ctlpos *cp, char *stext,
286 int sid, int lid, int percentlist);
287 void combobox(struct ctlpos *cp, char *text, int staticid, int listid);
288 void staticpassedit(struct ctlpos *cp, char *stext,
289 int sid, int eid, int percentedit);
290 void bigeditctrl(struct ctlpos *cp, char *stext,
291 int sid, int eid, int lines);
292 void ersatztab(struct ctlpos *cp, char *stext, int sid, int lid, int s2id);
293 void editbutton(struct ctlpos *cp, char *stext, int sid,
294 int eid, char *btext, int bid);
295 void sesssaver(struct ctlpos *cp, char *text,
296 int staticid, int editid, int listid, ...);
297 void envsetter(struct ctlpos *cp, char *stext, int sid,
298 char *e1stext, int e1sid, int e1id,
299 char *e2stext, int e2sid, int e2id,
300 int listid, char *b1text, int b1id, char *b2text, int b2id);
301 void charclass(struct ctlpos *cp, char *stext, int sid, int listid,
302 char *btext, int bid, int eid, char *s2text, int s2id);
303 void colouredit(struct ctlpos *cp, char *stext, int sid, int listid,
304 char *btext, int bid, ...);
305 void prefslist(struct prefslist *hdl, struct ctlpos *cp, int lines,
306 char *stext, int sid, int listid, int upbid, int dnbid);
307 int handle_prefslist(struct prefslist *hdl,
308 int *array, int maxmemb,
309 int is_dlmsg, HWND hwnd,
310 WPARAM wParam, LPARAM lParam);
311 void progressbar(struct ctlpos *cp, int id);
312 void fwdsetter(struct ctlpos *cp, int listid, char *stext, int sid,
313 char *e1stext, int e1sid, int e1id,
314 char *e2stext, int e2sid, int e2id,
315 char *btext, int bid,
316 char *r1text, int r1id, char *r2text, int r2id);
318 #define MAX_SHORTCUTS_PER_CTRL 16
321 * This structure is what's stored for each `union control' in the
322 * portable-dialog interface.
327 * The control may have several components at the Windows
328 * level, with different dialog IDs. To avoid needing N
329 * separate platformsidectrl structures (which could be stored
330 * separately in a tree234 so that lookup by ID worked), we
331 * impose the constraint that those IDs must be in a contiguous
337 * Remember what keyboard shortcuts were used by this control,
338 * so that when we remove it again we can take them out of the
339 * list in the dlgparam.
341 char shortcuts[MAX_SHORTCUTS_PER_CTRL];
343 * Some controls need a piece of allocated memory in which to
344 * store temporary data about the control.
349 * And this structure holds a set of the above, in two separate
350 * tree234s so that it can find an item by `union control' or by
354 tree234 *byctrl, *byid;
359 void winctrl_init(struct winctrls *);
360 void winctrl_cleanup(struct winctrls *);
361 void winctrl_add(struct winctrls *, struct winctrl *);
362 void winctrl_remove(struct winctrls *, struct winctrl *);
363 struct winctrl *winctrl_findbyctrl(struct winctrls *, union control *);
364 struct winctrl *winctrl_findbyid(struct winctrls *, int);
365 struct winctrl *winctrl_findbyindex(struct winctrls *, int);
366 void winctrl_layout(struct dlgparam *dp, struct winctrls *wc,
367 struct ctlpos *cp, struct controlset *s, int *id);
368 int winctrl_handle_command(struct dlgparam *dp, UINT msg,
369 WPARAM wParam, LPARAM lParam);
370 void winctrl_rem_shortcuts(struct dlgparam *dp, struct winctrl *c);
371 int winctrl_context_help(struct dlgparam *dp, HWND hwnd, int id);
373 void dp_init(struct dlgparam *dp);
374 void dp_add_tree(struct dlgparam *dp, struct winctrls *tree);
375 void dp_cleanup(struct dlgparam *dp);
378 * Exports from wincfg.c.
380 void win_setup_config_box(struct controlbox *b, HWND *hwndp, int has_help,
381 int midsession, int protocol);
384 * Exports from windlg.c.
386 void defuse_showwindow(void);
388 int do_reconfig(HWND, int);
389 void showeventlog(HWND);
390 void showabout(HWND);
391 void force_normal(HWND hwnd);
392 void modal_about_box(HWND hwnd);
393 void show_help(HWND hwnd);
396 * Exports from winmisc.c.
398 extern OSVERSIONINFO osVersion;
399 BOOL init_winver(void);
402 * Exports from sizetip.c.
404 void UpdateSizeTip(HWND src, int cx, int cy);
405 void EnableSizeTip(int bEnable);
408 * Exports from unicode.c.
411 void init_ucs(Config *, struct unicode_data *);
414 * Exports from winhandl.c.
416 #define HANDLE_FLAG_OVERLAPPED 1
417 #define HANDLE_FLAG_IGNOREEOF 2
418 #define HANDLE_FLAG_UNITBUFFER 4
420 typedef int (*handle_inputfn_t)(struct handle *h, void *data, int len);
421 typedef void (*handle_outputfn_t)(struct handle *h, int new_backlog);
422 struct handle *handle_input_new(HANDLE handle, handle_inputfn_t gotdata,
423 void *privdata, int flags);
424 struct handle *handle_output_new(HANDLE handle, handle_outputfn_t sentdata,
425 void *privdata, int flags);
426 int handle_write(struct handle *h, const void *data, int len);
427 HANDLE *handle_get_events(int *nevents);
428 void handle_free(struct handle *h);
429 void handle_got_event(HANDLE event);
430 void handle_unthrottle(struct handle *h, int backlog);
431 int handle_backlog(struct handle *h);
432 void *handle_get_privdata(struct handle *h);
435 * pageantc.c needs to schedule callbacks for asynchronous agent
436 * requests. This has to be done differently in GUI and console, so
437 * there's an exported function used for the purpose.
439 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
440 * synchronous in pscp and psftp.
442 void agent_schedule_callback(void (*callback)(void *, void *, int),
443 void *callback_ctx, void *data, int len);
444 #define FLAG_SYNCAGENT 0x1000
447 * Exports from winser.c.
449 extern Backend serial_backend;