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 #define BOXFLAGS DLGWINDOWEXTRA
31 #define BOXRESULT DLGWINDOWEXTRA + 4
35 * Global variables. Most modules declare these `extern', but
36 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
37 * module, and so will get them properly defined.
40 #ifdef PUTTY_DO_GLOBALS
49 typedef struct config_tag Config
;
50 typedef struct backend_tag Backend
;
51 typedef struct terminal_tag Terminal
;
54 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
55 #define PUTTY_REG_PARENT "Software\\SimonTatham"
56 #define PUTTY_REG_PARENT_CHILD "PuTTY"
57 #define PUTTY_REG_GPARENT "Software"
58 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
60 #define PUTTY_HELP_FILE "putty.hlp"
61 #define PUTTY_HELP_CONTENTS "putty.cnt"
63 #define GETTICKCOUNT GetTickCount
64 #define CURSORBLINK GetCaretBlinkTime()
65 #define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
67 #define DEFAULT_CODEPAGE CP_ACP
72 * Window handles for the windows that can be running during a
75 GLOBAL HWND hwnd
; /* the main terminal window */
79 * The all-important instance handle.
81 GLOBAL HINSTANCE hinst
;
84 * Details of the help file.
86 GLOBAL
char *help_path
;
87 GLOBAL
int help_has_contents
;
88 GLOBAL
int requested_help
;
91 * The terminal and logging context are notionally local to the
92 * Windows front end, but they must be shared between window.c and
93 * windlg.c. Likewise the saved-sessions list.
95 GLOBAL Terminal
*term
;
99 * I've just looked in the windows standard headr files for WM_USER, there
100 * are hundreds of flags defined using the form WM_USER+123 so I've
101 * renumbered this NETEVENT value and the two in window.c
103 #define WM_XUSER (WM_USER + 0x2000)
104 #define WM_NETEVENT (WM_XUSER + 5)
107 * On Windows, we send MA_2CLK as the only event marking the second
108 * press of a mouse button. Compare unix.h.
110 #define MULTICLICK_ONLY_EVENT 1
113 * On Windows, data written to the clipboard must be NUL-terminated.
115 #define SELECTION_NUL_TERMINATED 1
118 * On Windows, copying to the clipboard terminates lines with CRLF.
120 #define SEL_NL { 13, 10 }
123 * sk_getxdmdata() does not exist under Windows (not that I
124 * couldn't write it if I wanted to, but I haven't bothered), so
125 * it's a macro which always returns NULL. With any luck this will
126 * cause the compiler to notice it can optimise away the
127 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
129 #define sk_getxdmdata(socket, lenp) (NULL)
132 * File-selector filter strings used in the config box. On Windows,
133 * these strings are of exactly the type needed to go in
134 * `lpstrFilter' in an OPENFILENAME structure.
136 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
137 "All Files (*.*)\0*\0\0\0")
138 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
139 "All Files (*.*)\0*\0\0\0")
142 * On some versions of Windows, it has been known for WM_TIMER to
143 * occasionally get its callback time simply wrong, and call us
144 * back several minutes early. Defining these symbols enables
145 * compensation code in timing.c.
148 #define TIMING_SYNC_TICKCOUNT
151 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
152 * what it can get, which means any WinSock routines used outside
153 * that module must be exported from it as function pointers. So
156 extern int (WINAPI
*p_WSAAsyncSelect
)
157 (SOCKET s
, HWND hWnd
, u_int wMsg
, long lEvent
);
158 extern int (WINAPI
*p_WSAEventSelect
)
159 (SOCKET s
, WSAEVENT hEventObject
, long lNetworkEvents
);
160 extern int (WINAPI
*p_select
)
161 (int nfds
, fd_set FAR
* readfds
, fd_set FAR
* writefds
,
162 fd_set FAR
*exceptfds
, const struct timeval FAR
* timeout
);
163 extern int (WINAPI
*p_WSAGetLastError
)(void);
164 extern int (WINAPI
*p_WSAEnumNetworkEvents
)
165 (SOCKET s
, WSAEVENT hEventObject
, LPWSANETWORKEVENTS lpNetworkEvents
);
167 extern int socket_writable(SOCKET skt
);
170 * Exports from winctrls.c.
179 int boxystart
, boxid
;
184 * Exports from winutils.c.
186 typedef struct filereq_tag filereq
; /* cwd for file requester */
187 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
188 filereq
*filereq_new(void);
189 void filereq_free(filereq
*state
);
190 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
);
191 void split_into_argv(char *, int *, char ***, char ***);
194 * Private structure for prefslist state. Only in the header file
195 * so that we can delegate allocation to callers.
198 int listid
, upbid
, dnbid
;
205 * This structure is passed to event handler functions as the `dlg'
206 * parameter, and hence is passed back to winctrls access functions.
209 HWND hwnd
; /* the hwnd of the dialog box */
210 struct winctrls
*controltrees
[8]; /* can have several of these */
212 char *wintitle
; /* title of actual window */
213 char *errtitle
; /* title of error sub-messageboxes */
214 void *data
; /* data to pass in refresh events */
215 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
216 char shortcuts
[128]; /* track which shortcuts in use */
217 int coloursel_wanted
; /* has an event handler asked for
218 * a colour selector? */
219 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
220 tree234
*privdata
; /* stores per-control private data */
221 int ended
, endresult
; /* has the dialog been ended? */
225 * Exports from winctrls.c.
227 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
228 int leftborder
, int rightborder
, int topborder
);
229 HWND
doctl(struct ctlpos
*cp
, RECT r
,
230 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
231 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
232 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
233 void endbox(struct ctlpos
*cp
);
234 void multiedit(struct ctlpos
*cp
, int password
, ...);
235 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
236 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
237 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
238 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
239 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
240 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
241 char *btext
, int bid
);
242 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
243 char *btext1
, int bid1
, char *btext2
, int bid2
);
244 void staticedit(struct ctlpos
*cp
, char *stext
,
245 int sid
, int eid
, int percentedit
);
246 void staticddl(struct ctlpos
*cp
, char *stext
,
247 int sid
, int lid
, int percentlist
);
248 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
249 void staticpassedit(struct ctlpos
*cp
, char *stext
,
250 int sid
, int eid
, int percentedit
);
251 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
252 int sid
, int eid
, int lines
);
253 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
254 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
255 int eid
, char *btext
, int bid
);
256 void sesssaver(struct ctlpos
*cp
, char *text
,
257 int staticid
, int editid
, int listid
, ...);
258 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
259 char *e1stext
, int e1sid
, int e1id
,
260 char *e2stext
, int e2sid
, int e2id
,
261 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
262 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
263 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
264 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
265 char *btext
, int bid
, ...);
266 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
267 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
268 int handle_prefslist(struct prefslist
*hdl
,
269 int *array
, int maxmemb
,
270 int is_dlmsg
, HWND hwnd
,
271 WPARAM wParam
, LPARAM lParam
);
272 void progressbar(struct ctlpos
*cp
, int id
);
273 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
274 char *e1stext
, int e1sid
, int e1id
,
275 char *e2stext
, int e2sid
, int e2id
,
276 char *btext
, int bid
,
277 char *r1text
, int r1id
, char *r2text
, int r2id
);
279 #define MAX_SHORTCUTS_PER_CTRL 16
282 * This structure is what's stored for each `union control' in the
283 * portable-dialog interface.
288 * The control may have several components at the Windows
289 * level, with different dialog IDs. To avoid needing N
290 * separate platformsidectrl structures (which could be stored
291 * separately in a tree234 so that lookup by ID worked), we
292 * impose the constraint that those IDs must be in a contiguous
298 * Remember what keyboard shortcuts were used by this control,
299 * so that when we remove it again we can take them out of the
300 * list in the dlgparam.
302 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
304 * Some controls need a piece of allocated memory in which to
305 * store temporary data about the control.
310 * And this structure holds a set of the above, in two separate
311 * tree234s so that it can find an item by `union control' or by
315 tree234
*byctrl
, *byid
;
320 void winctrl_init(struct winctrls
*);
321 void winctrl_cleanup(struct winctrls
*);
322 void winctrl_add(struct winctrls
*, struct winctrl
*);
323 void winctrl_remove(struct winctrls
*, struct winctrl
*);
324 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
325 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
326 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
327 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
328 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
329 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
330 WPARAM wParam
, LPARAM lParam
);
331 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
332 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
334 void dp_init(struct dlgparam
*dp
);
335 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
336 void dp_cleanup(struct dlgparam
*dp
);
339 * Exports from wincfg.c.
341 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
345 * Exports from windlg.c.
347 void defuse_showwindow(void);
349 int do_reconfig(HWND
, int);
350 void showeventlog(HWND
);
351 void showabout(HWND
);
352 void force_normal(HWND hwnd
);
353 void modal_about_box(HWND hwnd
);
354 void show_help(HWND hwnd
);
357 * Exports from winmisc.c.
359 extern OSVERSIONINFO osVersion
;
360 BOOL
init_winver(void);
363 * Exports from sizetip.c.
365 void UpdateSizeTip(HWND src
, int cx
, int cy
);
366 void EnableSizeTip(int bEnable
);
369 * Exports from unicode.c.
372 void init_ucs(Config
*, struct unicode_data
*);
375 * pageantc.c needs to schedule callbacks for asynchronous agent
376 * requests. This has to be done differently in GUI and console, so
377 * there's an exported function used for the purpose.
379 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
380 * synchronous in pscp and psftp.
382 void agent_schedule_callback(void (*callback
)(void *, void *, int),
383 void *callback_ctx
, void *data
, int len
);
384 #define FLAG_SYNCAGENT 0x1000