New timing infrastructure. There's a new function schedule_timer()
[u/mdw/putty] / windows / winstuff.h
CommitLineData
8c3cd914 1/*
2 * winstuff.h: Windows-specific inter-module stuff.
3 */
4
f7f27309 5#ifndef PUTTY_WINSTUFF_H
6#define PUTTY_WINSTUFF_H
7
7440fd44 8#ifndef AUTO_WINSOCK
9#include <winsock2.h>
10#endif
11#include <windows.h>
9a30e26b 12#include <stdio.h> /* for FILENAME_MAX */
13
fe8abbf4 14#include "tree234.h"
15
16#include "winhelp.h"
17
9a30e26b 18struct Filename {
19 char path[FILENAME_MAX];
20};
21#define f_open(filename, mode) ( fopen((filename).path, (mode)) )
22
23struct FontSpec {
24 char name[64];
25 int isbold;
26 int height;
27 int charset;
28};
29
2979718a 30#define BOXFLAGS DLGWINDOWEXTRA
31#define BOXRESULT DLGWINDOWEXTRA + 4
8ee3ff16 32#define DF_END 0x0001
33
8c3cd914 34/*
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.
2979718a 38*/
f7f27309 39#ifndef GLOBAL
8c3cd914 40#ifdef PUTTY_DO_GLOBALS
41#define GLOBAL
42#else
43#define GLOBAL extern
44#endif
f7f27309 45#endif
46
a8327734 47#ifndef DONE_TYPEDEFS
48#define DONE_TYPEDEFS
49typedef struct config_tag Config;
50typedef struct backend_tag Backend;
51typedef struct terminal_tag Terminal;
52#endif
53
f7f27309 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"
59
60#define GETTICKCOUNT GetTickCount
61#define CURSORBLINK GetCaretBlinkTime()
62#define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
63
64#define DEFAULT_CODEPAGE CP_ACP
65
66typedef HDC Context;
8c3cd914 67
f7f27309 68/*
69 * Window handles for the dialog boxes that can be running during a
70 * PuTTY session.
71 */
72GLOBAL HWND logbox;
73
74/*
75 * The all-important instance handle.
76 */
8c3cd914 77GLOBAL HINSTANCE hinst;
78
79/*
6b78788a 80 * Details of the help file.
81 */
82GLOBAL char *help_path;
83GLOBAL int help_has_contents;
84
85/*
a8327734 86 * The terminal and logging context are notionally local to the
87 * Windows front end, but they must be shared between window.c and
0b4f0bc0 88 * windlg.c. Likewise the saved-sessions list.
a8327734 89 */
90GLOBAL Terminal *term;
91GLOBAL void *logctx;
92
93/*
f7f27309 94 * I've just looked in the windows standard headr files for WM_USER, there
95 * are hundreds of flags defined using the form WM_USER+123 so I've
96 * renumbered this NETEVENT value and the two in window.c
97 */
98#define WM_XUSER (WM_USER + 0x2000)
99#define WM_NETEVENT (WM_XUSER + 5)
100
101/*
e6346999 102 * On Windows, we send MA_2CLK as the only event marking the second
103 * press of a mouse button. Compare unix.h.
104 */
105#define MULTICLICK_ONLY_EVENT 1
106
107/*
108 * On Windows, data written to the clipboard must be NUL-terminated.
109 */
110#define SELECTION_NUL_TERMINATED 1
111
112/*
0f351587 113 * On Windows, copying to the clipboard terminates lines with CRLF.
114 */
115#define SEL_NL { 13, 10 }
116
117/*
2f92b717 118 * sk_getxdmdata() does not exist under Windows (not that I
119 * couldn't write it if I wanted to, but I haven't bothered), so
120 * it's a macro which always returns FALSE. With any luck this will
121 * cause the compiler to notice it can optimise away the
122 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
123 */
124#define sk_getxdmdata(socket, ip, port) (0)
125
126/*
fe8abbf4 127 * File-selector filter strings used in the config box. On Windows,
128 * these strings are of exactly the type needed to go in
129 * `lpstrFilter' in an OPENFILENAME structure.
130 */
131#define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
132 "All Files (*.*)\0*\0\0\0")
133#define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
134 "All Files (*.*)\0*\0\0\0")
135
136/*
7440fd44 137 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
138 * what it can get, which means any WinSock routines used outside
139 * that module must be exported from it as function pointers. So
140 * here they are.
141 */
142extern int (WINAPI *p_WSAAsyncSelect)
143 (SOCKET s, HWND hWnd, u_int wMsg, long lEvent);
144extern int (WINAPI *p_WSAEventSelect)
145 (SOCKET s, WSAEVENT hEventObject, long lNetworkEvents);
146extern int (WINAPI *p_select)
147 (int nfds, fd_set FAR * readfds, fd_set FAR * writefds,
148 fd_set FAR *exceptfds, const struct timeval FAR * timeout);
149extern int (WINAPI *p_WSAGetLastError)(void);
150extern int (WINAPI *p_WSAEnumNetworkEvents)
151 (SOCKET s, WSAEVENT hEventObject, LPWSANETWORKEVENTS lpNetworkEvents);
152
39934deb 153extern int socket_writable(SOCKET skt);
154
7440fd44 155/*
8c3cd914 156 * Exports from winctrls.c.
157 */
158
159struct ctlpos {
160 HWND hwnd;
161 WPARAM font;
162 int dlu4inpix;
163 int ypos, width;
164 int xoff;
3ac9cd9f 165 int boxystart, boxid;
8c3cd914 166 char *boxtext;
167};
168
ca20bfcf 169/*
c0a81592 170 * Exports from winutils.c.
171 */
d3a1a808 172void split_into_argv(char *, int *, char ***, char ***);
c0a81592 173
174/*
ca20bfcf 175 * Private structure for prefslist state. Only in the header file
176 * so that we can delegate allocation to callers.
177 */
178struct prefslist {
179 int listid, upbid, dnbid;
180 int srcitem;
181 int dummyitem;
182 int dragging;
183};
184
f7f27309 185/*
fe8abbf4 186 * This structure is passed to event handler functions as the `dlg'
187 * parameter, and hence is passed back to winctrls access functions.
188 */
189struct dlgparam {
190 HWND hwnd; /* the hwnd of the dialog box */
191 struct winctrls *controltrees[8]; /* can have several of these */
192 int nctrltrees;
f6f450e2 193 char *wintitle; /* title of actual window */
fe8abbf4 194 char *errtitle; /* title of error sub-messageboxes */
195 void *data; /* data to pass in refresh events */
196 union control *focused, *lastfocused; /* which ctrl has focus now/before */
4e6d4091 197 char shortcuts[128]; /* track which shortcuts in use */
fe8abbf4 198 int coloursel_wanted; /* has an event handler asked for
199 * a colour selector? */
fe8abbf4 200 struct { unsigned char r, g, b, ok; } coloursel_result; /* 0-255 */
4e6d4091 201 tree234 *privdata; /* stores per-control private data */
fe8abbf4 202 int ended, endresult; /* has the dialog been ended? */
203};
204
205/*
f7f27309 206 * Exports from winctrls.c.
207 */
8c3cd914 208void ctlposinit(struct ctlpos *cp, HWND hwnd,
32874aea 209 int leftborder, int rightborder, int topborder);
ca20bfcf 210HWND doctl(struct ctlpos *cp, RECT r,
32874aea 211 char *wclass, int wstyle, int exstyle, char *wtext, int wid);
8c3cd914 212void bartitle(struct ctlpos *cp, char *name, int id);
3ac9cd9f 213void beginbox(struct ctlpos *cp, char *name, int idbox);
8c3cd914 214void endbox(struct ctlpos *cp);
fe8abbf4 215void multiedit(struct ctlpos *cp, int password, ...);
32874aea 216void radioline(struct ctlpos *cp, char *text, int id, int nacross, ...);
d74d141c 217void bareradioline(struct ctlpos *cp, int nacross, ...);
8c3cd914 218void radiobig(struct ctlpos *cp, char *text, int id, ...);
219void checkbox(struct ctlpos *cp, char *text, int id);
66ee282a 220void statictext(struct ctlpos *cp, char *text, int lines, int id);
8c3cd914 221void staticbtn(struct ctlpos *cp, char *stext, int sid,
32874aea 222 char *btext, int bid);
af282e3b 223void static2btn(struct ctlpos *cp, char *stext, int sid,
224 char *btext1, int bid1, char *btext2, int bid2);
8c3cd914 225void staticedit(struct ctlpos *cp, char *stext,
32874aea 226 int sid, int eid, int percentedit);
2c9c6388 227void staticddl(struct ctlpos *cp, char *stext,
228 int sid, int lid, int percentlist);
b8ae1f0f 229void combobox(struct ctlpos *cp, char *text, int staticid, int listid);
6e522441 230void staticpassedit(struct ctlpos *cp, char *stext,
32874aea 231 int sid, int eid, int percentedit);
6e522441 232void bigeditctrl(struct ctlpos *cp, char *stext,
32874aea 233 int sid, int eid, int lines);
234void ersatztab(struct ctlpos *cp, char *stext, int sid, int lid, int s2id);
8c3cd914 235void editbutton(struct ctlpos *cp, char *stext, int sid,
32874aea 236 int eid, char *btext, int bid);
8c3cd914 237void sesssaver(struct ctlpos *cp, char *text,
32874aea 238 int staticid, int editid, int listid, ...);
8c3cd914 239void envsetter(struct ctlpos *cp, char *stext, int sid,
32874aea 240 char *e1stext, int e1sid, int e1id,
241 char *e2stext, int e2sid, int e2id,
242 int listid, char *b1text, int b1id, char *b2text, int b2id);
8c3cd914 243void charclass(struct ctlpos *cp, char *stext, int sid, int listid,
32874aea 244 char *btext, int bid, int eid, char *s2text, int s2id);
8c3cd914 245void colouredit(struct ctlpos *cp, char *stext, int sid, int listid,
32874aea 246 char *btext, int bid, ...);
fe8abbf4 247void prefslist(struct prefslist *hdl, struct ctlpos *cp, int lines,
248 char *stext, int sid, int listid, int upbid, int dnbid);
ca20bfcf 249int handle_prefslist(struct prefslist *hdl,
250 int *array, int maxmemb,
251 int is_dlmsg, HWND hwnd,
252 WPARAM wParam, LPARAM lParam);
6e522441 253void progressbar(struct ctlpos *cp, int id);
d74d141c 254void fwdsetter(struct ctlpos *cp, int listid, char *stext, int sid,
255 char *e1stext, int e1sid, int e1id,
256 char *e2stext, int e2sid, int e2id,
a4b92c62 257 char *btext, int bid,
258 char *r1text, int r1id, char *r2text, int r2id);
f7f27309 259
fe8abbf4 260#define MAX_SHORTCUTS_PER_CTRL 16
261
262/*
263 * This structure is what's stored for each `union control' in the
264 * portable-dialog interface.
265 */
266struct winctrl {
267 union control *ctrl;
268 /*
269 * The control may have several components at the Windows
270 * level, with different dialog IDs. To avoid needing N
271 * separate platformsidectrl structures (which could be stored
272 * separately in a tree234 so that lookup by ID worked), we
273 * impose the constraint that those IDs must be in a contiguous
274 * block.
275 */
276 int base_id;
277 int num_ids;
278 /*
279 * Remember what keyboard shortcuts were used by this control,
280 * so that when we remove it again we can take them out of the
281 * list in the dlgparam.
282 */
283 char shortcuts[MAX_SHORTCUTS_PER_CTRL];
284 /*
285 * Some controls need a piece of allocated memory in which to
286 * store temporary data about the control.
287 */
288 void *data;
289};
290/*
291 * And this structure holds a set of the above, in two separate
292 * tree234s so that it can find an item by `union control' or by
293 * dialog ID.
294 */
295struct winctrls {
296 tree234 *byctrl, *byid;
297};
d1582b2e 298struct controlset;
299struct controlbox;
300
fe8abbf4 301void winctrl_init(struct winctrls *);
302void winctrl_cleanup(struct winctrls *);
303void winctrl_add(struct winctrls *, struct winctrl *);
304void winctrl_remove(struct winctrls *, struct winctrl *);
305struct winctrl *winctrl_findbyctrl(struct winctrls *, union control *);
306struct winctrl *winctrl_findbyid(struct winctrls *, int);
307struct winctrl *winctrl_findbyindex(struct winctrls *, int);
308void winctrl_layout(struct dlgparam *dp, struct winctrls *wc,
309 struct ctlpos *cp, struct controlset *s, int *id);
310int winctrl_handle_command(struct dlgparam *dp, UINT msg,
311 WPARAM wParam, LPARAM lParam);
d1582b2e 312void winctrl_rem_shortcuts(struct dlgparam *dp, struct winctrl *c);
313int winctrl_context_help(struct dlgparam *dp, HWND hwnd, int id);
314
4e6d4091 315void dp_init(struct dlgparam *dp);
316void dp_add_tree(struct dlgparam *dp, struct winctrls *tree);
317void dp_cleanup(struct dlgparam *dp);
318
d1582b2e 319/*
320 * Exports from wincfg.c.
321 */
322void win_setup_config_box(struct controlbox *b, HWND *hwndp, int has_help,
323 int midsession);
fe8abbf4 324
f7f27309 325/*
326 * Exports from windlg.c.
327 */
328void defuse_showwindow(void);
329int do_config(void);
330int do_reconfig(HWND);
f7f27309 331void showeventlog(HWND);
332void showabout(HWND);
f7f27309 333void force_normal(HWND hwnd);
d1582b2e 334void modal_about_box(HWND hwnd);
335void show_help(HWND hwnd);
f7f27309 336
f7f27309 337/*
8ee3ff16 338 * Exports from winmisc.c.
339 */
340
341int SaneDialogBox(HINSTANCE hinst,
342 LPCTSTR tmpl,
343 HWND hwndparent,
344 DLGPROC lpDialogFunc);
345
346void SaneEndDialog(HWND hwnd, int ret);
347
4c48c989 348extern OSVERSIONINFO osVersion;
349BOOL init_winver(void);
350
8ee3ff16 351/*
f7f27309 352 * Exports from sizetip.c.
353 */
354void UpdateSizeTip(HWND src, int cx, int cy);
355void EnableSizeTip(int bEnable);
356
facd762c 357/*
358 * Exports from unicode.c.
359 */
07b2a9cd 360struct unicode_data;
21d2b241 361void init_ucs(Config *, struct unicode_data *);
facd762c 362
c44bf5bd 363/*
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.
367 *
368 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
369 * synchronous in pscp and psftp.
370 */
371void agent_schedule_callback(void (*callback)(void *, void *, int),
372 void *callback_ctx, void *data, int len);
373#define FLAG_SYNCAGENT 0x1000
374
f7f27309 375#endif