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