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
;
90 * The terminal and logging context are notionally local to the
91 * Windows front end, but they must be shared between window.c and
92 * windlg.c. Likewise the saved-sessions list.
94 GLOBAL Terminal
*term
;
98 * I've just looked in the windows standard headr files for WM_USER, there
99 * are hundreds of flags defined using the form WM_USER+123 so I've
100 * renumbered this NETEVENT value and the two in window.c
102 #define WM_XUSER (WM_USER + 0x2000)
103 #define WM_NETEVENT (WM_XUSER + 5)
106 * On Windows, we send MA_2CLK as the only event marking the second
107 * press of a mouse button. Compare unix.h.
109 #define MULTICLICK_ONLY_EVENT 1
112 * On Windows, data written to the clipboard must be NUL-terminated.
114 #define SELECTION_NUL_TERMINATED 1
117 * On Windows, copying to the clipboard terminates lines with CRLF.
119 #define SEL_NL { 13, 10 }
122 * sk_getxdmdata() does not exist under Windows (not that I
123 * couldn't write it if I wanted to, but I haven't bothered), so
124 * it's a macro which always returns NULL. With any luck this will
125 * cause the compiler to notice it can optimise away the
126 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
128 #define sk_getxdmdata(socket, lenp) (NULL)
131 * File-selector filter strings used in the config box. On Windows,
132 * these strings are of exactly the type needed to go in
133 * `lpstrFilter' in an OPENFILENAME structure.
135 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
136 "All Files (*.*)\0*\0\0\0")
137 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
138 "All Files (*.*)\0*\0\0\0")
141 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
142 * what it can get, which means any WinSock routines used outside
143 * that module must be exported from it as function pointers. So
146 extern int (WINAPI
*p_WSAAsyncSelect
)
147 (SOCKET s
, HWND hWnd
, u_int wMsg
, long lEvent
);
148 extern int (WINAPI
*p_WSAEventSelect
)
149 (SOCKET s
, WSAEVENT hEventObject
, long lNetworkEvents
);
150 extern int (WINAPI
*p_select
)
151 (int nfds
, fd_set FAR
* readfds
, fd_set FAR
* writefds
,
152 fd_set FAR
*exceptfds
, const struct timeval FAR
* timeout
);
153 extern int (WINAPI
*p_WSAGetLastError
)(void);
154 extern int (WINAPI
*p_WSAEnumNetworkEvents
)
155 (SOCKET s
, WSAEVENT hEventObject
, LPWSANETWORKEVENTS lpNetworkEvents
);
157 extern int socket_writable(SOCKET skt
);
160 * Exports from winctrls.c.
169 int boxystart
, boxid
;
174 * Exports from winutils.c.
176 typedef struct filereq_tag filereq
; /* cwd for file requester */
177 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
178 filereq
*filereq_new(void);
179 void filereq_free(filereq
*state
);
180 void split_into_argv(char *, int *, char ***, char ***);
183 * Private structure for prefslist state. Only in the header file
184 * so that we can delegate allocation to callers.
187 int listid
, upbid
, dnbid
;
194 * This structure is passed to event handler functions as the `dlg'
195 * parameter, and hence is passed back to winctrls access functions.
198 HWND hwnd
; /* the hwnd of the dialog box */
199 struct winctrls
*controltrees
[8]; /* can have several of these */
201 char *wintitle
; /* title of actual window */
202 char *errtitle
; /* title of error sub-messageboxes */
203 void *data
; /* data to pass in refresh events */
204 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
205 char shortcuts
[128]; /* track which shortcuts in use */
206 int coloursel_wanted
; /* has an event handler asked for
207 * a colour selector? */
208 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
209 tree234
*privdata
; /* stores per-control private data */
210 int ended
, endresult
; /* has the dialog been ended? */
214 * Exports from winctrls.c.
216 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
217 int leftborder
, int rightborder
, int topborder
);
218 HWND
doctl(struct ctlpos
*cp
, RECT r
,
219 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
220 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
221 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
222 void endbox(struct ctlpos
*cp
);
223 void multiedit(struct ctlpos
*cp
, int password
, ...);
224 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
225 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
226 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
227 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
228 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
229 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
230 char *btext
, int bid
);
231 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
232 char *btext1
, int bid1
, char *btext2
, int bid2
);
233 void staticedit(struct ctlpos
*cp
, char *stext
,
234 int sid
, int eid
, int percentedit
);
235 void staticddl(struct ctlpos
*cp
, char *stext
,
236 int sid
, int lid
, int percentlist
);
237 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
238 void staticpassedit(struct ctlpos
*cp
, char *stext
,
239 int sid
, int eid
, int percentedit
);
240 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
241 int sid
, int eid
, int lines
);
242 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
243 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
244 int eid
, char *btext
, int bid
);
245 void sesssaver(struct ctlpos
*cp
, char *text
,
246 int staticid
, int editid
, int listid
, ...);
247 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
248 char *e1stext
, int e1sid
, int e1id
,
249 char *e2stext
, int e2sid
, int e2id
,
250 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
251 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
252 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
253 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
254 char *btext
, int bid
, ...);
255 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
256 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
257 int handle_prefslist(struct prefslist
*hdl
,
258 int *array
, int maxmemb
,
259 int is_dlmsg
, HWND hwnd
,
260 WPARAM wParam
, LPARAM lParam
);
261 void progressbar(struct ctlpos
*cp
, int id
);
262 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
263 char *e1stext
, int e1sid
, int e1id
,
264 char *e2stext
, int e2sid
, int e2id
,
265 char *btext
, int bid
,
266 char *r1text
, int r1id
, char *r2text
, int r2id
);
268 #define MAX_SHORTCUTS_PER_CTRL 16
271 * This structure is what's stored for each `union control' in the
272 * portable-dialog interface.
277 * The control may have several components at the Windows
278 * level, with different dialog IDs. To avoid needing N
279 * separate platformsidectrl structures (which could be stored
280 * separately in a tree234 so that lookup by ID worked), we
281 * impose the constraint that those IDs must be in a contiguous
287 * Remember what keyboard shortcuts were used by this control,
288 * so that when we remove it again we can take them out of the
289 * list in the dlgparam.
291 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
293 * Some controls need a piece of allocated memory in which to
294 * store temporary data about the control.
299 * And this structure holds a set of the above, in two separate
300 * tree234s so that it can find an item by `union control' or by
304 tree234
*byctrl
, *byid
;
309 void winctrl_init(struct winctrls
*);
310 void winctrl_cleanup(struct winctrls
*);
311 void winctrl_add(struct winctrls
*, struct winctrl
*);
312 void winctrl_remove(struct winctrls
*, struct winctrl
*);
313 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
314 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
315 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
316 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
317 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
318 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
319 WPARAM wParam
, LPARAM lParam
);
320 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
321 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
323 void dp_init(struct dlgparam
*dp
);
324 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
325 void dp_cleanup(struct dlgparam
*dp
);
328 * Exports from wincfg.c.
330 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
334 * Exports from windlg.c.
336 void defuse_showwindow(void);
338 int do_reconfig(HWND
, int);
339 void showeventlog(HWND
);
340 void showabout(HWND
);
341 void force_normal(HWND hwnd
);
342 void modal_about_box(HWND hwnd
);
343 void show_help(HWND hwnd
);
346 * Exports from winmisc.c.
348 extern OSVERSIONINFO osVersion
;
349 BOOL
init_winver(void);
352 * Exports from sizetip.c.
354 void UpdateSizeTip(HWND src
, int cx
, int cy
);
355 void EnableSizeTip(int bEnable
);
358 * Exports from unicode.c.
361 void init_ucs(Config
*, struct unicode_data
*);
364 * pageantc.c needs to schedule callbacks for asynchronous agent
365 * requests. This has to be done differently in GUI and console, so
366 * there's an exported function used for the purpose.
368 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
369 * synchronous in pscp and psftp.
371 void agent_schedule_callback(void (*callback
)(void *, void *, int),
372 void *callback_ctx
, void *data
, int len
);
373 #define FLAG_SYNCAGENT 0x1000