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 */
21 #define f_open(filename, mode, isprivate) ( fopen((filename)->path, (mode)) )
29 struct FontSpec
*fontspec_new(const char *name
,
30 int bold
, int height
, int charset
);
32 #ifndef CLEARTYPE_QUALITY
33 #define CLEARTYPE_QUALITY 5
35 #define FONT_QUALITY(fq) ( \
36 (fq) == FQ_DEFAULT ? DEFAULT_QUALITY : \
37 (fq) == FQ_ANTIALIASED ? ANTIALIASED_QUALITY : \
38 (fq) == FQ_NONANTIALIASED ? NONANTIALIASED_QUALITY : \
41 #define PLATFORM_IS_UTF16 /* enable UTF-16 processing when exchanging
42 * wchar_t strings with environment */
45 * Where we can, we use GetWindowLongPtr and friends because they're
46 * more useful on 64-bit platforms, but they're a relatively recent
47 * innovation, missing from VC++ 6 and older MinGW. Degrade nicely.
48 * (NB that on some systems, some of these things are available but
53 /* GetClassLongPtr and friends */
54 #undef GetClassLongPtr
55 #define GetClassLongPtr GetClassLong
56 #undef SetClassLongPtr
57 #define SetClassLongPtr SetClassLong
58 #define GCLP_HCURSOR GCL_HCURSOR
59 /* GetWindowLongPtr and friends */
60 #undef GetWindowLongPtr
61 #define GetWindowLongPtr GetWindowLong
62 #undef SetWindowLongPtr
63 #define SetWindowLongPtr SetWindowLong
65 #define GWLP_USERDATA GWL_USERDATA
67 #define DWLP_MSGRESULT DWL_MSGRESULT
68 /* Since we've clobbered the above functions, we should clobber the
69 * associated type regardless of whether it's defined. */
74 #define BOXFLAGS DLGWINDOWEXTRA
75 #define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
79 * Dynamically linked functions. These come in two flavours:
81 * - GET_WINDOWS_FUNCTION does not expose "name" to the preprocessor,
82 * so will always dynamically link against exactly what is specified
83 * in "name". If you're not sure, use this one.
85 * - GET_WINDOWS_FUNCTION_PP allows "name" to be redirected via
86 * preprocessor definitions like "#define foo bar"; this is principally
87 * intended for the ANSI/Unicode DoSomething/DoSomethingA/DoSomethingW.
88 * If your function has an argument of type "LPTSTR" or similar, this
89 * is the variant to use.
90 * (However, it can't always be used, as it trips over more complicated
91 * macro trickery such as the WspiapiGetAddrInfo wrapper for getaddrinfo.)
93 * (DECL_WINDOWS_FUNCTION works with both these variants.)
95 #define DECL_WINDOWS_FUNCTION(linkage, rettype, name, params) \
96 typedef rettype (WINAPI *t_##name) params; \
97 linkage t_##name p_##name
99 #define STR(x) STR1(x)
100 #define GET_WINDOWS_FUNCTION_PP(module, name) \
101 (p_##name = module ? (t_##name) GetProcAddress(module, STR(name)) : NULL)
102 #define GET_WINDOWS_FUNCTION(module, name) \
103 (p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL)
106 * Global variables. Most modules declare these `extern', but
107 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
108 * module, and so will get them properly defined.
111 #ifdef PUTTY_DO_GLOBALS
114 #define GLOBAL extern
118 #ifndef DONE_TYPEDEFS
119 #define DONE_TYPEDEFS
120 typedef struct conf_tag Conf
;
121 typedef struct backend_tag Backend
;
122 typedef struct terminal_tag Terminal
;
125 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
126 #define PUTTY_REG_PARENT "Software\\SimonTatham"
127 #define PUTTY_REG_PARENT_CHILD "PuTTY"
128 #define PUTTY_REG_GPARENT "Software"
129 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
131 /* Result values for the jumplist registry functions. */
132 #define JUMPLISTREG_OK 0
133 #define JUMPLISTREG_ERROR_INVALID_PARAMETER 1
134 #define JUMPLISTREG_ERROR_KEYOPENCREATE_FAILURE 2
135 #define JUMPLISTREG_ERROR_VALUEREAD_FAILURE 3
136 #define JUMPLISTREG_ERROR_VALUEWRITE_FAILURE 4
137 #define JUMPLISTREG_ERROR_INVALID_VALUE 5
139 #define PUTTY_HELP_FILE "putty.hlp"
140 #define PUTTY_CHM_FILE "putty.chm"
141 #define PUTTY_HELP_CONTENTS "putty.cnt"
143 #define GETTICKCOUNT GetTickCount
144 #define CURSORBLINK GetCaretBlinkTime()
145 #define TICKSPERSEC 1000 /* GetTickCount returns milliseconds */
147 #define DEFAULT_CODEPAGE CP_ACP
148 #define USES_VTLINE_HACK
152 typedef unsigned int uint32
; /* int is 32-bits on Win32 and Win64. */
153 #define PUTTY_UINT32_DEFINED
159 #define GSS_CC CALLBACK
161 typedef struct Ssh_gss_buf {
166 #define SSH_GSS_EMPTY_BUF (Ssh_gss_buf) {0,NULL}
167 typedef void *Ssh_gss_name;
172 * Window handles for the windows that can be running during a
175 GLOBAL HWND hwnd
; /* the main terminal window */
179 * The all-important instance handle.
181 GLOBAL HINSTANCE hinst
;
184 * Help file stuff in winhelp.c.
186 void init_help(void);
187 void shutdown_help(void);
189 void launch_help(HWND hwnd
, const char *topic
);
190 void quit_help(HWND hwnd
);
193 * The terminal and logging context are notionally local to the
194 * Windows front end, but they must be shared between window.c and
195 * windlg.c. Likewise the saved-sessions list.
197 GLOBAL Terminal
*term
;
200 #define WM_NETEVENT (WM_APP + 5)
203 * On Windows, we send MA_2CLK as the only event marking the second
204 * press of a mouse button. Compare unix.h.
206 #define MULTICLICK_ONLY_EVENT 1
209 * On Windows, data written to the clipboard must be NUL-terminated.
211 #define SELECTION_NUL_TERMINATED 1
214 * On Windows, copying to the clipboard terminates lines with CRLF.
216 #define SEL_NL { 13, 10 }
219 * sk_getxdmdata() does not exist under Windows (not that I
220 * couldn't write it if I wanted to, but I haven't bothered), so
221 * it's a macro which always returns NULL. With any luck this will
222 * cause the compiler to notice it can optimise away the
223 * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
225 #define sk_getxdmdata(socket, lenp) (NULL)
228 * File-selector filter strings used in the config box. On Windows,
229 * these strings are of exactly the type needed to go in
230 * `lpstrFilter' in an OPENFILENAME structure.
232 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
233 "All Files (*.*)\0*\0\0\0")
234 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
235 "All Files (*.*)\0*\0\0\0")
236 #define FILTER_DYNLIB_FILES ("Dynamic Library Files (*.dll)\0*.dll\0" \
237 "All Files (*.*)\0*\0\0\0")
240 * On some versions of Windows, it has been known for WM_TIMER to
241 * occasionally get its callback time simply wrong, and call us
242 * back several minutes early. Defining these symbols enables
243 * compensation code in timing.c.
246 #define TIMING_SYNC_TICKCOUNT
249 * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
250 * what it can get, which means any WinSock routines used outside
251 * that module must be exported from it as function pointers. So
254 DECL_WINDOWS_FUNCTION(GLOBAL
, int, WSAAsyncSelect
,
255 (SOCKET
, HWND
, u_int
, long));
256 DECL_WINDOWS_FUNCTION(GLOBAL
, int, WSAEventSelect
,
257 (SOCKET
, WSAEVENT
, long));
258 DECL_WINDOWS_FUNCTION(GLOBAL
, int, select
,
259 (int, fd_set FAR
*, fd_set FAR
*,
260 fd_set FAR
*, const struct timeval FAR
*));
261 DECL_WINDOWS_FUNCTION(GLOBAL
, int, WSAGetLastError
, (void));
262 DECL_WINDOWS_FUNCTION(GLOBAL
, int, WSAEnumNetworkEvents
,
263 (SOCKET
, WSAEVENT
, LPWSANETWORKEVENTS
));
265 extern int socket_writable(SOCKET skt
);
267 extern void socket_reselect_all(void);
270 * Exports from winctrls.c.
279 int boxystart
, boxid
;
284 * Exports from winutils.c.
286 typedef struct filereq_tag filereq
; /* cwd for file requester */
287 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
);
288 filereq
*filereq_new(void);
289 void filereq_free(filereq
*state
);
290 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
);
291 char *GetDlgItemText_alloc(HWND hwnd
, int id
);
292 void split_into_argv(char *, int *, char ***, char ***);
295 * Private structure for prefslist state. Only in the header file
296 * so that we can delegate allocation to callers.
299 int listid
, upbid
, dnbid
;
306 * This structure is passed to event handler functions as the `dlg'
307 * parameter, and hence is passed back to winctrls access functions.
310 HWND hwnd
; /* the hwnd of the dialog box */
311 struct winctrls
*controltrees
[8]; /* can have several of these */
313 char *wintitle
; /* title of actual window */
314 char *errtitle
; /* title of error sub-messageboxes */
315 void *data
; /* data to pass in refresh events */
316 union control
*focused
, *lastfocused
; /* which ctrl has focus now/before */
317 char shortcuts
[128]; /* track which shortcuts in use */
318 int coloursel_wanted
; /* has an event handler asked for
319 * a colour selector? */
320 struct { unsigned char r
, g
, b
, ok
; } coloursel_result
; /* 0-255 */
321 tree234
*privdata
; /* stores per-control private data */
322 int ended
, endresult
; /* has the dialog been ended? */
323 int fixed_pitch_fonts
; /* are we constrained to fixed fonts? */
327 * Exports from winctrls.c.
329 void ctlposinit(struct ctlpos
*cp
, HWND hwnd
,
330 int leftborder
, int rightborder
, int topborder
);
331 HWND
doctl(struct ctlpos
*cp
, RECT r
,
332 char *wclass
, int wstyle
, int exstyle
, char *wtext
, int wid
);
333 void bartitle(struct ctlpos
*cp
, char *name
, int id
);
334 void beginbox(struct ctlpos
*cp
, char *name
, int idbox
);
335 void endbox(struct ctlpos
*cp
);
336 void editboxfw(struct ctlpos
*cp
, int password
, char *text
,
337 int staticid
, int editid
);
338 void radioline(struct ctlpos
*cp
, char *text
, int id
, int nacross
, ...);
339 void bareradioline(struct ctlpos
*cp
, int nacross
, ...);
340 void radiobig(struct ctlpos
*cp
, char *text
, int id
, ...);
341 void checkbox(struct ctlpos
*cp
, char *text
, int id
);
342 void statictext(struct ctlpos
*cp
, char *text
, int lines
, int id
);
343 void staticbtn(struct ctlpos
*cp
, char *stext
, int sid
,
344 char *btext
, int bid
);
345 void static2btn(struct ctlpos
*cp
, char *stext
, int sid
,
346 char *btext1
, int bid1
, char *btext2
, int bid2
);
347 void staticedit(struct ctlpos
*cp
, char *stext
,
348 int sid
, int eid
, int percentedit
);
349 void staticddl(struct ctlpos
*cp
, char *stext
,
350 int sid
, int lid
, int percentlist
);
351 void combobox(struct ctlpos
*cp
, char *text
, int staticid
, int listid
);
352 void staticpassedit(struct ctlpos
*cp
, char *stext
,
353 int sid
, int eid
, int percentedit
);
354 void bigeditctrl(struct ctlpos
*cp
, char *stext
,
355 int sid
, int eid
, int lines
);
356 void ersatztab(struct ctlpos
*cp
, char *stext
, int sid
, int lid
, int s2id
);
357 void editbutton(struct ctlpos
*cp
, char *stext
, int sid
,
358 int eid
, char *btext
, int bid
);
359 void sesssaver(struct ctlpos
*cp
, char *text
,
360 int staticid
, int editid
, int listid
, ...);
361 void envsetter(struct ctlpos
*cp
, char *stext
, int sid
,
362 char *e1stext
, int e1sid
, int e1id
,
363 char *e2stext
, int e2sid
, int e2id
,
364 int listid
, char *b1text
, int b1id
, char *b2text
, int b2id
);
365 void charclass(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
366 char *btext
, int bid
, int eid
, char *s2text
, int s2id
);
367 void colouredit(struct ctlpos
*cp
, char *stext
, int sid
, int listid
,
368 char *btext
, int bid
, ...);
369 void prefslist(struct prefslist
*hdl
, struct ctlpos
*cp
, int lines
,
370 char *stext
, int sid
, int listid
, int upbid
, int dnbid
);
371 int handle_prefslist(struct prefslist
*hdl
,
372 int *array
, int maxmemb
,
373 int is_dlmsg
, HWND hwnd
,
374 WPARAM wParam
, LPARAM lParam
);
375 void progressbar(struct ctlpos
*cp
, int id
);
376 void fwdsetter(struct ctlpos
*cp
, int listid
, char *stext
, int sid
,
377 char *e1stext
, int e1sid
, int e1id
,
378 char *e2stext
, int e2sid
, int e2id
,
379 char *btext
, int bid
,
380 char *r1text
, int r1id
, char *r2text
, int r2id
);
382 void dlg_auto_set_fixed_pitch_flag(void *dlg
);
383 int dlg_get_fixed_pitch_flag(void *dlg
);
384 void dlg_set_fixed_pitch_flag(void *dlg
, int flag
);
386 #define MAX_SHORTCUTS_PER_CTRL 16
389 * This structure is what's stored for each `union control' in the
390 * portable-dialog interface.
395 * The control may have several components at the Windows
396 * level, with different dialog IDs. To avoid needing N
397 * separate platformsidectrl structures (which could be stored
398 * separately in a tree234 so that lookup by ID worked), we
399 * impose the constraint that those IDs must be in a contiguous
405 * Remember what keyboard shortcuts were used by this control,
406 * so that when we remove it again we can take them out of the
407 * list in the dlgparam.
409 char shortcuts
[MAX_SHORTCUTS_PER_CTRL
];
411 * Some controls need a piece of allocated memory in which to
412 * store temporary data about the control.
417 * And this structure holds a set of the above, in two separate
418 * tree234s so that it can find an item by `union control' or by
422 tree234
*byctrl
, *byid
;
427 void winctrl_init(struct winctrls
*);
428 void winctrl_cleanup(struct winctrls
*);
429 void winctrl_add(struct winctrls
*, struct winctrl
*);
430 void winctrl_remove(struct winctrls
*, struct winctrl
*);
431 struct winctrl
*winctrl_findbyctrl(struct winctrls
*, union control
*);
432 struct winctrl
*winctrl_findbyid(struct winctrls
*, int);
433 struct winctrl
*winctrl_findbyindex(struct winctrls
*, int);
434 void winctrl_layout(struct dlgparam
*dp
, struct winctrls
*wc
,
435 struct ctlpos
*cp
, struct controlset
*s
, int *id
);
436 int winctrl_handle_command(struct dlgparam
*dp
, UINT msg
,
437 WPARAM wParam
, LPARAM lParam
);
438 void winctrl_rem_shortcuts(struct dlgparam
*dp
, struct winctrl
*c
);
439 int winctrl_context_help(struct dlgparam
*dp
, HWND hwnd
, int id
);
441 void dp_init(struct dlgparam
*dp
);
442 void dp_add_tree(struct dlgparam
*dp
, struct winctrls
*tree
);
443 void dp_cleanup(struct dlgparam
*dp
);
446 * Exports from wincfg.c.
448 void win_setup_config_box(struct controlbox
*b
, HWND
*hwndp
, int has_help
,
449 int midsession
, int protocol
);
452 * Exports from windlg.c.
454 void defuse_showwindow(void);
456 int do_reconfig(HWND
, int);
457 void showeventlog(HWND
);
458 void showabout(HWND
);
459 void force_normal(HWND hwnd
);
460 void modal_about_box(HWND hwnd
);
461 void show_help(HWND hwnd
);
464 * Exports from winmisc.c.
466 extern OSVERSIONINFO osVersion
;
467 BOOL
init_winver(void);
468 HMODULE
load_system32_dll(const char *libname
);
471 * Exports from sizetip.c.
473 void UpdateSizeTip(HWND src
, int cx
, int cy
);
474 void EnableSizeTip(int bEnable
);
477 * Exports from unicode.c.
480 void init_ucs(Conf
*, struct unicode_data
*);
483 * Exports from winhandl.c.
485 #define HANDLE_FLAG_OVERLAPPED 1
486 #define HANDLE_FLAG_IGNOREEOF 2
487 #define HANDLE_FLAG_UNITBUFFER 4
489 typedef int (*handle_inputfn_t
)(struct handle
*h
, void *data
, int len
);
490 typedef void (*handle_outputfn_t
)(struct handle
*h
, int new_backlog
);
491 struct handle
*handle_input_new(HANDLE handle
, handle_inputfn_t gotdata
,
492 void *privdata
, int flags
);
493 struct handle
*handle_output_new(HANDLE handle
, handle_outputfn_t sentdata
,
494 void *privdata
, int flags
);
495 int handle_write(struct handle
*h
, const void *data
, int len
);
496 void handle_write_eof(struct handle
*h
);
497 HANDLE
*handle_get_events(int *nevents
);
498 void handle_free(struct handle
*h
);
499 void handle_got_event(HANDLE event
);
500 void handle_unthrottle(struct handle
*h
, int backlog
);
501 int handle_backlog(struct handle
*h
);
502 void *handle_get_privdata(struct handle
*h
);
505 * winpgntc.c needs to schedule callbacks for asynchronous agent
506 * requests. This has to be done differently in GUI and console, so
507 * there's an exported function used for the purpose.
509 * Also, we supply FLAG_SYNCAGENT to force agent requests to be
510 * synchronous in pscp and psftp.
512 void agent_schedule_callback(void (*callback
)(void *, void *, int),
513 void *callback_ctx
, void *data
, int len
);
514 #define FLAG_SYNCAGENT 0x1000
517 * winpgntc.c also exports these two functions which are used by the
518 * server side of Pageant as well, to get the user SID for comparing
521 int init_advapi(void); /* initialises everything needed by get_user_sid */
522 PSID
get_user_sid(void);
525 * Exports from winser.c.
527 extern Backend serial_backend
;
530 * Exports from winjump.c.
532 #define JUMPLIST_SUPPORTED /* suppress #defines in putty.h */
533 void add_session_to_jumplist(const char * const sessionname
);
534 void remove_session_from_jumplist(const char * const sessionname
);
535 void clear_jumplist(void);
538 * Extra functions in winstore.c over and above the interface in
541 * These functions manipulate the Registry section which mirrors the
542 * current Windows 7 jump list. (Because the real jump list storage is
543 * write-only, we need to keep another copy of whatever we put in it,
544 * so that we can put in a slightly modified version the next time.)
547 /* Adds a saved session to the registry jump list mirror. 'item' is a
548 * string naming a saved session. */
549 int add_to_jumplist_registry(const char *item
);
551 /* Removes an item from the registry jump list mirror. */
552 int remove_from_jumplist_registry(const char *item
);
554 /* Returns the current jump list entries from the registry. Caller
555 * must free the returned pointer, which points to a contiguous
556 * sequence of NUL-terminated strings in memory, terminated with an
558 char *get_jumplist_registry_entries(void);