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 + sizeof(LONG_PTR))
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
;
98 #define WM_NETEVENT (WM_APP + 5)
101 * On Windows, we send MA_2CLK as the only event marking the second
102 * press of a mouse button. Compare unix.h.
104 #define MULTICLICK_ONLY_EVENT 1
107 * On Windows, data written to the clipboard must be NUL-terminated.
109 #define SELECTION_NUL_TERMINATED 1
112 * On Windows, copying to the clipboard terminates lines with CRLF.
114 #define SEL_NL { 13, 10 }
117 * sk_getxdmdata() does not exist under Windows (not that I
118 * couldn't write it if I wanted to, but I haven't bothered), so
119 * it's a macro which always returns NULL. With any luck this will
120 * cause the compiler to notice it can optimise away the
121 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
123 #define sk_getxdmdata(socket, lenp) (NULL)
126 * File-selector filter strings used in the config box. On Windows,
127 * these strings are of exactly the type needed to go in
128 * `lpstrFilter' in an OPENFILENAME structure.
130 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
131 "All Files (*.*)\0*\0\0\0")
132 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
133 "All Files (*.*)\0*\0\0\0")
136 * On some versions of Windows, it has been known for WM_TIMER to
137 * occasionally get its callback time simply wrong, and call us
138 * back several minutes early. Defining these symbols enables
139 * compensation code in timing.c.
142 #define TIMING_SYNC_TICKCOUNT
145 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
146 * what it can get, which means any WinSock routines used outside
147 * that module must be exported from it as function pointers. So
150 extern int (WINAPI
*p_WSAAsyncSelect
)
151 (SOCKET s
, HWND hWnd
, u_int wMsg
, long lEvent
);
152 extern int (WINAPI
*p_WSAEventSelect
)
153 (SOCKET s
, WSAEVENT hEventObject
, long lNetworkEvents
);
154 extern int (WINAPI
*p_select
)
155 (int nfds
, fd_set FAR
* readfds
, fd_set FAR
* writefds
,
156 fd_set FAR
*exceptfds
, const struct timeval FAR
* timeout
);
157 extern int (WINAPI
*p_WSAGetLastError
)(void);
158 extern int (WINAPI
*p_WSAEnumNetworkEvents
)
159 (SOCKET s
, WSAEVENT hEventObject
, LPWSANETWORKEVENTS lpNetworkEvents
);
161 extern int socket_writable(SOCKET skt
);
164 * Exports from winctrls.c.
173 int boxystart
, boxid
;
178 * Exports from winutils.c.
180 typedef struct filereq_tag filereq
; /* cwd for file requester */
181 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
182 filereq
*filereq_new(void);
183 void filereq_free(filereq
*state
);
184 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
);
185 void split_into_argv(char *, int *, char ***, char ***);
188 * Private structure for prefslist state. Only in the header file
189 * so that we can delegate allocation to callers.
192 int listid
, upbid
, dnbid
;
199 * This structure is passed to event handler functions as the `dlg'
200 * parameter, and hence is passed back to winctrls access functions.
203 HWND hwnd
; /* the hwnd of the dialog box */
204 struct winctrls
*controltrees
[8]; /* can have several of these */
206 char *wintitle
; /* title of actual window */
207 char *errtitle
; /* title of error sub-messageboxes */
208 void *data
; /* data to pass in refresh events */
209 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
210 char shortcuts
[128]; /* track which shortcuts in use */
211 int coloursel_wanted
; /* has an event handler asked for
212 * a colour selector? */
213 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
214 tree234
*privdata
; /* stores per-control private data */
215 int ended
, endresult
; /* has the dialog been ended? */
219 * Exports from winctrls.c.
221 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
222 int leftborder
, int rightborder
, int topborder
);
223 HWND
doctl(struct ctlpos
*cp
, RECT r
,
224 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
225 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
226 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
227 void endbox(struct ctlpos
*cp
);
228 void editboxfw(struct ctlpos
*cp
, int password
, char *text
,
229 int staticid
, int editid
);
230 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
231 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
232 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
233 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
234 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
235 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
236 char *btext
, int bid
);
237 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
238 char *btext1
, int bid1
, char *btext2
, int bid2
);
239 void staticedit(struct ctlpos
*cp
, char *stext
,
240 int sid
, int eid
, int percentedit
);
241 void staticddl(struct ctlpos
*cp
, char *stext
,
242 int sid
, int lid
, int percentlist
);
243 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
244 void staticpassedit(struct ctlpos
*cp
, char *stext
,
245 int sid
, int eid
, int percentedit
);
246 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
247 int sid
, int eid
, int lines
);
248 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
249 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
250 int eid
, char *btext
, int bid
);
251 void sesssaver(struct ctlpos
*cp
, char *text
,
252 int staticid
, int editid
, int listid
, ...);
253 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
254 char *e1stext
, int e1sid
, int e1id
,
255 char *e2stext
, int e2sid
, int e2id
,
256 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
257 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
258 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
259 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
260 char *btext
, int bid
, ...);
261 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
262 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
263 int handle_prefslist(struct prefslist
*hdl
,
264 int *array
, int maxmemb
,
265 int is_dlmsg
, HWND hwnd
,
266 WPARAM wParam
, LPARAM lParam
);
267 void progressbar(struct ctlpos
*cp
, int id
);
268 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
269 char *e1stext
, int e1sid
, int e1id
,
270 char *e2stext
, int e2sid
, int e2id
,
271 char *btext
, int bid
,
272 char *r1text
, int r1id
, char *r2text
, int r2id
);
274 #define MAX_SHORTCUTS_PER_CTRL 16
277 * This structure is what's stored for each `union control' in the
278 * portable-dialog interface.
283 * The control may have several components at the Windows
284 * level, with different dialog IDs. To avoid needing N
285 * separate platformsidectrl structures (which could be stored
286 * separately in a tree234 so that lookup by ID worked), we
287 * impose the constraint that those IDs must be in a contiguous
293 * Remember what keyboard shortcuts were used by this control,
294 * so that when we remove it again we can take them out of the
295 * list in the dlgparam.
297 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
299 * Some controls need a piece of allocated memory in which to
300 * store temporary data about the control.
305 * And this structure holds a set of the above, in two separate
306 * tree234s so that it can find an item by `union control' or by
310 tree234
*byctrl
, *byid
;
315 void winctrl_init(struct winctrls
*);
316 void winctrl_cleanup(struct winctrls
*);
317 void winctrl_add(struct winctrls
*, struct winctrl
*);
318 void winctrl_remove(struct winctrls
*, struct winctrl
*);
319 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
320 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
321 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
322 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
323 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
324 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
325 WPARAM wParam
, LPARAM lParam
);
326 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
327 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
329 void dp_init(struct dlgparam
*dp
);
330 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
331 void dp_cleanup(struct dlgparam
*dp
);
334 * Exports from wincfg.c.
336 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
340 * Exports from windlg.c.
342 void defuse_showwindow(void);
344 int do_reconfig(HWND
, int);
345 void showeventlog(HWND
);
346 void showabout(HWND
);
347 void force_normal(HWND hwnd
);
348 void modal_about_box(HWND hwnd
);
349 void show_help(HWND hwnd
);
352 * Exports from winmisc.c.
354 extern OSVERSIONINFO osVersion
;
355 BOOL
init_winver(void);
358 * Exports from sizetip.c.
360 void UpdateSizeTip(HWND src
, int cx
, int cy
);
361 void EnableSizeTip(int bEnable
);
364 * Exports from unicode.c.
367 void init_ucs(Config
*, struct unicode_data
*);
370 * pageantc.c needs to schedule callbacks for asynchronous agent
371 * requests. This has to be done differently in GUI and console, so
372 * there's an exported function used for the purpose.
374 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
375 * synchronous in pscp and psftp.
377 void agent_schedule_callback(void (*callback
)(void *, void *, int),
378 void *callback_ctx
, void *data
, int len
);
379 #define FLAG_SYNCAGENT 0x1000