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 : \
39 /* VC++ 6 doesn't have GetWindowLongPtr and friends. Degrade nicely. */
42 #define GetWindowLongPtr GetWindowLong
43 #define SetWindowLongPtr SetWindowLong
44 #define GWLP_USERDATA GWL_USERDATA
45 #define DWLP_MSGRESULT DWL_MSGRESULT
48 #define BOXFLAGS DLGWINDOWEXTRA
50 #define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
52 #define BOXRESULT (DLGWINDOWEXTRA + 4)
57 * Global variables. Most modules declare these `extern', but
58 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
59 * module, and so will get them properly defined.
62 #ifdef PUTTY_DO_GLOBALS
71 typedef struct config_tag Config
;
72 typedef struct backend_tag Backend
;
73 typedef struct terminal_tag Terminal
;
76 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
77 #define PUTTY_REG_PARENT "Software\\SimonTatham"
78 #define PUTTY_REG_PARENT_CHILD "PuTTY"
79 #define PUTTY_REG_GPARENT "Software"
80 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
82 #define PUTTY_HELP_FILE "putty.hlp"
83 #define PUTTY_HELP_CONTENTS "putty.cnt"
85 #define GETTICKCOUNT GetTickCount
86 #define CURSORBLINK GetCaretBlinkTime()
87 #define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
89 #define DEFAULT_CODEPAGE CP_ACP
94 * Window handles for the windows that can be running during a
97 GLOBAL HWND hwnd
; /* the main terminal window */
101 * The all-important instance handle.
103 GLOBAL HINSTANCE hinst
;
106 * Details of the help file.
108 GLOBAL
char *help_path
;
109 GLOBAL
int help_has_contents
;
110 GLOBAL
int requested_help
;
113 * The terminal and logging context are notionally local to the
114 * Windows front end, but they must be shared between window.c and
115 * windlg.c. Likewise the saved-sessions list.
117 GLOBAL Terminal
*term
;
120 #define WM_NETEVENT (WM_APP + 5)
123 * On Windows, we send MA_2CLK as the only event marking the second
124 * press of a mouse button. Compare unix.h.
126 #define MULTICLICK_ONLY_EVENT 1
129 * On Windows, data written to the clipboard must be NUL-terminated.
131 #define SELECTION_NUL_TERMINATED 1
134 * On Windows, copying to the clipboard terminates lines with CRLF.
136 #define SEL_NL { 13, 10 }
139 * sk_getxdmdata() does not exist under Windows (not that I
140 * couldn't write it if I wanted to, but I haven't bothered), so
141 * it's a macro which always returns NULL. With any luck this will
142 * cause the compiler to notice it can optimise away the
143 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
145 #define sk_getxdmdata(socket, lenp) (NULL)
148 * File-selector filter strings used in the config box. On Windows,
149 * these strings are of exactly the type needed to go in
150 * `lpstrFilter' in an OPENFILENAME structure.
152 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
153 "All Files (*.*)\0*\0\0\0")
154 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
155 "All Files (*.*)\0*\0\0\0")
158 * On some versions of Windows, it has been known for WM_TIMER to
159 * occasionally get its callback time simply wrong, and call us
160 * back several minutes early. Defining these symbols enables
161 * compensation code in timing.c.
164 #define TIMING_SYNC_TICKCOUNT
167 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
168 * what it can get, which means any WinSock routines used outside
169 * that module must be exported from it as function pointers. So
172 extern int (WINAPI
*p_WSAAsyncSelect
)
173 (SOCKET s
, HWND hWnd
, u_int wMsg
, long lEvent
);
174 extern int (WINAPI
*p_WSAEventSelect
)
175 (SOCKET s
, WSAEVENT hEventObject
, long lNetworkEvents
);
176 extern int (WINAPI
*p_select
)
177 (int nfds
, fd_set FAR
* readfds
, fd_set FAR
* writefds
,
178 fd_set FAR
*exceptfds
, const struct timeval FAR
* timeout
);
179 extern int (WINAPI
*p_WSAGetLastError
)(void);
180 extern int (WINAPI
*p_WSAEnumNetworkEvents
)
181 (SOCKET s
, WSAEVENT hEventObject
, LPWSANETWORKEVENTS lpNetworkEvents
);
183 extern int socket_writable(SOCKET skt
);
186 * Exports from winctrls.c.
195 int boxystart
, boxid
;
200 * Exports from winutils.c.
202 typedef struct filereq_tag filereq
; /* cwd for file requester */
203 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
204 filereq
*filereq_new(void);
205 void filereq_free(filereq
*state
);
206 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
);
207 void split_into_argv(char *, int *, char ***, char ***);
210 * Private structure for prefslist state. Only in the header file
211 * so that we can delegate allocation to callers.
214 int listid
, upbid
, dnbid
;
221 * This structure is passed to event handler functions as the `dlg'
222 * parameter, and hence is passed back to winctrls access functions.
225 HWND hwnd
; /* the hwnd of the dialog box */
226 struct winctrls
*controltrees
[8]; /* can have several of these */
228 char *wintitle
; /* title of actual window */
229 char *errtitle
; /* title of error sub-messageboxes */
230 void *data
; /* data to pass in refresh events */
231 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
232 char shortcuts
[128]; /* track which shortcuts in use */
233 int coloursel_wanted
; /* has an event handler asked for
234 * a colour selector? */
235 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
236 tree234
*privdata
; /* stores per-control private data */
237 int ended
, endresult
; /* has the dialog been ended? */
241 * Exports from winctrls.c.
243 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
244 int leftborder
, int rightborder
, int topborder
);
245 HWND
doctl(struct ctlpos
*cp
, RECT r
,
246 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
247 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
248 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
249 void endbox(struct ctlpos
*cp
);
250 void editboxfw(struct ctlpos
*cp
, int password
, char *text
,
251 int staticid
, int editid
);
252 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
253 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
254 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
255 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
256 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
257 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
258 char *btext
, int bid
);
259 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
260 char *btext1
, int bid1
, char *btext2
, int bid2
);
261 void staticedit(struct ctlpos
*cp
, char *stext
,
262 int sid
, int eid
, int percentedit
);
263 void staticddl(struct ctlpos
*cp
, char *stext
,
264 int sid
, int lid
, int percentlist
);
265 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
266 void staticpassedit(struct ctlpos
*cp
, char *stext
,
267 int sid
, int eid
, int percentedit
);
268 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
269 int sid
, int eid
, int lines
);
270 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
271 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
272 int eid
, char *btext
, int bid
);
273 void sesssaver(struct ctlpos
*cp
, char *text
,
274 int staticid
, int editid
, int listid
, ...);
275 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
276 char *e1stext
, int e1sid
, int e1id
,
277 char *e2stext
, int e2sid
, int e2id
,
278 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
279 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
280 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
281 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
282 char *btext
, int bid
, ...);
283 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
284 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
285 int handle_prefslist(struct prefslist
*hdl
,
286 int *array
, int maxmemb
,
287 int is_dlmsg
, HWND hwnd
,
288 WPARAM wParam
, LPARAM lParam
);
289 void progressbar(struct ctlpos
*cp
, int id
);
290 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
291 char *e1stext
, int e1sid
, int e1id
,
292 char *e2stext
, int e2sid
, int e2id
,
293 char *btext
, int bid
,
294 char *r1text
, int r1id
, char *r2text
, int r2id
);
296 #define MAX_SHORTCUTS_PER_CTRL 16
299 * This structure is what's stored for each `union control' in the
300 * portable-dialog interface.
305 * The control may have several components at the Windows
306 * level, with different dialog IDs. To avoid needing N
307 * separate platformsidectrl structures (which could be stored
308 * separately in a tree234 so that lookup by ID worked), we
309 * impose the constraint that those IDs must be in a contiguous
315 * Remember what keyboard shortcuts were used by this control,
316 * so that when we remove it again we can take them out of the
317 * list in the dlgparam.
319 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
321 * Some controls need a piece of allocated memory in which to
322 * store temporary data about the control.
327 * And this structure holds a set of the above, in two separate
328 * tree234s so that it can find an item by `union control' or by
332 tree234
*byctrl
, *byid
;
337 void winctrl_init(struct winctrls
*);
338 void winctrl_cleanup(struct winctrls
*);
339 void winctrl_add(struct winctrls
*, struct winctrl
*);
340 void winctrl_remove(struct winctrls
*, struct winctrl
*);
341 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
342 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
343 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
344 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
345 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
346 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
347 WPARAM wParam
, LPARAM lParam
);
348 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
349 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
351 void dp_init(struct dlgparam
*dp
);
352 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
353 void dp_cleanup(struct dlgparam
*dp
);
356 * Exports from wincfg.c.
358 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
362 * Exports from windlg.c.
364 void defuse_showwindow(void);
366 int do_reconfig(HWND
, int);
367 void showeventlog(HWND
);
368 void showabout(HWND
);
369 void force_normal(HWND hwnd
);
370 void modal_about_box(HWND hwnd
);
371 void show_help(HWND hwnd
);
374 * Exports from winmisc.c.
376 extern OSVERSIONINFO osVersion
;
377 BOOL
init_winver(void);
380 * Exports from sizetip.c.
382 void UpdateSizeTip(HWND src
, int cx
, int cy
);
383 void EnableSizeTip(int bEnable
);
386 * Exports from unicode.c.
389 void init_ucs(Config
*, struct unicode_data
*);
392 * pageantc.c needs to schedule callbacks for asynchronous agent
393 * requests. This has to be done differently in GUI and console, so
394 * there's an exported function used for the purpose.
396 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
397 * synchronous in pscp and psftp.
399 void agent_schedule_callback(void (*callback
)(void *, void *, int),
400 void *callback_ctx
, void *data
, int len
);
401 #define FLAG_SYNCAGENT 0x1000