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) ( 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
);
206 * Exports from winctrls.c.
215 int boxystart
, boxid
;
220 * Exports from winutils.c.
222 typedef struct filereq_tag filereq
; /* cwd for file requester */
223 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
224 filereq
*filereq_new(void);
225 void filereq_free(filereq
*state
);
226 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
);
227 void split_into_argv(char *, int *, char ***, char ***);
230 * Private structure for prefslist state. Only in the header file
231 * so that we can delegate allocation to callers.
234 int listid
, upbid
, dnbid
;
241 * This structure is passed to event handler functions as the `dlg'
242 * parameter, and hence is passed back to winctrls access functions.
245 HWND hwnd
; /* the hwnd of the dialog box */
246 struct winctrls
*controltrees
[8]; /* can have several of these */
248 char *wintitle
; /* title of actual window */
249 char *errtitle
; /* title of error sub-messageboxes */
250 void *data
; /* data to pass in refresh events */
251 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
252 char shortcuts
[128]; /* track which shortcuts in use */
253 int coloursel_wanted
; /* has an event handler asked for
254 * a colour selector? */
255 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
256 tree234
*privdata
; /* stores per-control private data */
257 int ended
, endresult
; /* has the dialog been ended? */
261 * Exports from winctrls.c.
263 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
264 int leftborder
, int rightborder
, int topborder
);
265 HWND
doctl(struct ctlpos
*cp
, RECT r
,
266 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
267 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
268 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
269 void endbox(struct ctlpos
*cp
);
270 void editboxfw(struct ctlpos
*cp
, int password
, char *text
,
271 int staticid
, int editid
);
272 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
273 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
274 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
275 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
276 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
277 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
278 char *btext
, int bid
);
279 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
280 char *btext1
, int bid1
, char *btext2
, int bid2
);
281 void staticedit(struct ctlpos
*cp
, char *stext
,
282 int sid
, int eid
, int percentedit
);
283 void staticddl(struct ctlpos
*cp
, char *stext
,
284 int sid
, int lid
, int percentlist
);
285 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
286 void staticpassedit(struct ctlpos
*cp
, char *stext
,
287 int sid
, int eid
, int percentedit
);
288 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
289 int sid
, int eid
, int lines
);
290 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
291 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
292 int eid
, char *btext
, int bid
);
293 void sesssaver(struct ctlpos
*cp
, char *text
,
294 int staticid
, int editid
, int listid
, ...);
295 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
296 char *e1stext
, int e1sid
, int e1id
,
297 char *e2stext
, int e2sid
, int e2id
,
298 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
299 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
300 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
301 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
302 char *btext
, int bid
, ...);
303 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
304 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
305 int handle_prefslist(struct prefslist
*hdl
,
306 int *array
, int maxmemb
,
307 int is_dlmsg
, HWND hwnd
,
308 WPARAM wParam
, LPARAM lParam
);
309 void progressbar(struct ctlpos
*cp
, int id
);
310 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
311 char *e1stext
, int e1sid
, int e1id
,
312 char *e2stext
, int e2sid
, int e2id
,
313 char *btext
, int bid
,
314 char *r1text
, int r1id
, char *r2text
, int r2id
);
316 #define MAX_SHORTCUTS_PER_CTRL 16
319 * This structure is what's stored for each `union control' in the
320 * portable-dialog interface.
325 * The control may have several components at the Windows
326 * level, with different dialog IDs. To avoid needing N
327 * separate platformsidectrl structures (which could be stored
328 * separately in a tree234 so that lookup by ID worked), we
329 * impose the constraint that those IDs must be in a contiguous
335 * Remember what keyboard shortcuts were used by this control,
336 * so that when we remove it again we can take them out of the
337 * list in the dlgparam.
339 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
341 * Some controls need a piece of allocated memory in which to
342 * store temporary data about the control.
347 * And this structure holds a set of the above, in two separate
348 * tree234s so that it can find an item by `union control' or by
352 tree234
*byctrl
, *byid
;
357 void winctrl_init(struct winctrls
*);
358 void winctrl_cleanup(struct winctrls
*);
359 void winctrl_add(struct winctrls
*, struct winctrl
*);
360 void winctrl_remove(struct winctrls
*, struct winctrl
*);
361 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
362 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
363 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
364 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
365 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
366 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
367 WPARAM wParam
, LPARAM lParam
);
368 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
369 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
371 void dp_init(struct dlgparam
*dp
);
372 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
373 void dp_cleanup(struct dlgparam
*dp
);
376 * Exports from wincfg.c.
378 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
379 int midsession
, int protocol
);
382 * Exports from windlg.c.
384 void defuse_showwindow(void);
386 int do_reconfig(HWND
, int);
387 void showeventlog(HWND
);
388 void showabout(HWND
);
389 void force_normal(HWND hwnd
);
390 void modal_about_box(HWND hwnd
);
391 void show_help(HWND hwnd
);
394 * Exports from winmisc.c.
396 extern OSVERSIONINFO osVersion
;
397 BOOL
init_winver(void);
400 * Exports from sizetip.c.
402 void UpdateSizeTip(HWND src
, int cx
, int cy
);
403 void EnableSizeTip(int bEnable
);
406 * Exports from unicode.c.
409 void init_ucs(Config
*, struct unicode_data
*);
412 * Exports from winhandl.c.
414 #define HANDLE_FLAG_OVERLAPPED 1
415 #define HANDLE_FLAG_IGNOREEOF 2
416 #define HANDLE_FLAG_UNITBUFFER 4
418 typedef int (*handle_inputfn_t
)(struct handle
*h
, void *data
, int len
);
419 typedef void (*handle_outputfn_t
)(struct handle
*h
, int new_backlog
);
420 struct handle
*handle_input_new(HANDLE handle
, handle_inputfn_t gotdata
,
421 void *privdata
, int flags
);
422 struct handle
*handle_output_new(HANDLE handle
, handle_outputfn_t sentdata
,
423 void *privdata
, int flags
);
424 int handle_write(struct handle
*h
, const void *data
, int len
);
425 HANDLE
*handle_get_events(int *nevents
);
426 void handle_free(struct handle
*h
);
427 void handle_got_event(HANDLE event
);
428 void handle_unthrottle(struct handle
*h
, int backlog
);
429 int handle_backlog(struct handle
*h
);
430 void *handle_get_privdata(struct handle
*h
);
433 * pageantc.c needs to schedule callbacks for asynchronous agent
434 * requests. This has to be done differently in GUI and console, so
435 * there's an exported function used for the purpose.
437 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
438 * synchronous in pscp and psftp.
440 void agent_schedule_callback(void (*callback
)(void *, void *, int),
441 void *callback_ctx
, void *data
, int len
);
442 #define FLAG_SYNCAGENT 0x1000
445 * Exports from winser.c.
447 extern Backend serial_backend
;