windows/winstuff.h

   1 /*
   2  * winstuff.h: Windows-specific inter-module stuff.
   3  */
   4
   5 #ifndef PUTTY_WINSTUFF_H
   6 #define PUTTY_WINSTUFF_H
   7
   8 #ifndef AUTO_WINSOCK
   9 #include <winsock2.h>
  10 #endif
  11 #include <windows.h>
  12 #include <stdio.h>                     /* for FILENAME_MAX */
  13
  14 #include "tree234.h"
  15
  16 #include "winhelp.h"
  17
  18 struct Filename {
  19     char path[FILENAME_MAX];
  20 };
  21 #define f_open(filename, mode) ( fopen((filename).path, (mode)) )
  22
  23 struct FontSpec {
  24     char name[64];
  25     int isbold;
  26     int height;
  27     int charset;
  28 };
  29
  30 #ifndef CLEARTYPE_QUALITY
  31 #define CLEARTYPE_QUALITY 5
  32 #endif
  33 #define FONT_QUALITY(fq) ( \
  34     (fq) == FQ_DEFAULT ? DEFAULT_QUALITY : \
  35     (fq) == FQ_ANTIALIASED ? ANTIALIASED_QUALITY : \
  36     (fq) == FQ_NONANTIALIASED ? NONANTIALIASED_QUALITY : \
  37     CLEARTYPE_QUALITY)
  38
  39 /*
  40  * Where we can, we use GetWindowLongPtr and friends because they're
  41  * more useful on 64-bit platforms, but they're a relatively recent
  42  * innovation, missing from VC++ 6 and older MinGW.  Degrade nicely.
  43  * (NB that on some systems, some of these things are available but
  44  * not others...)
  45  */
  46
  47 #ifndef GCLP_HCURSOR
  48 /* GetClassLongPtr and friends */
  49 #undef  GetClassLongPtr
  50 #define GetClassLongPtr GetClassLong
  51 #undef  SetClassLongPtr
  52 #define SetClassLongPtr SetClassLong
  53 #define GCLP_HCURSOR GCL_HCURSOR
  54 /* GetWindowLongPtr and friends */
  55 #undef  GetWindowLongPtr
  56 #define GetWindowLongPtr GetWindowLong
  57 #undef  SetWindowLongPtr
  58 #define SetWindowLongPtr SetWindowLong
  59 #undef  GWLP_USERDATA
  60 #define GWLP_USERDATA GWL_USERDATA
  61 #undef  DWLP_MSGRESULT
  62 #define DWLP_MSGRESULT DWL_MSGRESULT
  63 /* Since we've clobbered the above functions, we should clobber the
  64  * associated type regardless of whether it's defined. */
  65 #undef LONG_PTR
  66 #define LONG_PTR LONG
  67 #endif
  68
  69 #define BOXFLAGS DLGWINDOWEXTRA
  70 #define BOXRESULT (DLGWINDOWEXTRA + sizeof(LONG_PTR))
  71 #define DF_END 0x0001
  72
  73 /*
  74  * Global variables. Most modules declare these `extern', but
  75  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  76  * module, and so will get them properly defined.
  77 */
  78 #ifndef GLOBAL
  79 #ifdef PUTTY_DO_GLOBALS
  80 #define GLOBAL
  81 #else
  82 #define GLOBAL extern
  83 #endif
  84 #endif
  85
  86 #ifndef DONE_TYPEDEFS
  87 #define DONE_TYPEDEFS
  88 typedef struct config_tag Config;
  89 typedef struct backend_tag Backend;
  90 typedef struct terminal_tag Terminal;
  91 #endif
  92
  93 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
  94 #define PUTTY_REG_PARENT "Software\\SimonTatham"
  95 #define PUTTY_REG_PARENT_CHILD "PuTTY"
  96 #define PUTTY_REG_GPARENT "Software"
  97 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
  98
  99 #define PUTTY_HELP_FILE "putty.hlp"
 100 #define PUTTY_HELP_CONTENTS "putty.cnt"
 101
 102 #define GETTICKCOUNT GetTickCount
 103 #define CURSORBLINK GetCaretBlinkTime()
 104 #define TICKSPERSEC 1000               /* GetTickCount returns milliseconds */
 105
 106 #define DEFAULT_CODEPAGE CP_ACP
 107
 108 typedef HDC Context;
 109
 110 /*
 111  * Window handles for the windows that can be running during a
 112  * PuTTY session.
 113  */
 114 GLOBAL HWND hwnd;       /* the main terminal window */
 115 GLOBAL HWND logbox;
 116
 117 /*
 118  * The all-important instance handle.
 119  */
 120 GLOBAL HINSTANCE hinst;
 121
 122 /*
 123  * Details of the help file.
 124  */
 125 GLOBAL char *help_path;
 126 GLOBAL int help_has_contents;
 127 GLOBAL int requested_help;
 128
 129 /*
 130  * The terminal and logging context are notionally local to the
 131  * Windows front end, but they must be shared between window.c and
 132  * windlg.c. Likewise the saved-sessions list.
 133  */
 134 GLOBAL Terminal *term;
 135 GLOBAL void *logctx;
 136
 137 #define WM_NETEVENT  (WM_APP + 5)
 138
 139 /*
 140  * On Windows, we send MA_2CLK as the only event marking the second
 141  * press of a mouse button. Compare unix.h.
 142  */
 143 #define MULTICLICK_ONLY_EVENT 1
 144
 145 /*
 146  * On Windows, data written to the clipboard must be NUL-terminated.
 147  */
 148 #define SELECTION_NUL_TERMINATED 1
 149
 150 /*
 151  * On Windows, copying to the clipboard terminates lines with CRLF.
 152  */
 153 #define SEL_NL { 13, 10 }
 154
 155 /*
 156  * sk_getxdmdata() does not exist under Windows (not that I
 157  * couldn't write it if I wanted to, but I haven't bothered), so
 158  * it's a macro which always returns NULL. With any luck this will
 159  * cause the compiler to notice it can optimise away the
 160  * implementation of XDM-AUTHORIZATION-1 in x11fwd.c :-)
 161  */
 162 #define sk_getxdmdata(socket, lenp) (NULL)
 163
 164 /*
 165  * File-selector filter strings used in the config box. On Windows,
 166  * these strings are of exactly the type needed to go in
 167  * `lpstrFilter' in an OPENFILENAME structure.
 168  */
 169 #define FILTER_KEY_FILES ("PuTTY Private Key Files (*.ppk)\0*.ppk\0" \
 170                               "All Files (*.*)\0*\0\0\0")
 171 #define FILTER_WAVE_FILES ("Wave Files (*.wav)\0*.WAV\0" \
 172                                "All Files (*.*)\0*\0\0\0")
 173
 174 /*
 175  * On some versions of Windows, it has been known for WM_TIMER to
 176  * occasionally get its callback time simply wrong, and call us
 177  * back several minutes early. Defining these symbols enables
 178  * compensation code in timing.c.
 179  */
 180 #define TIMING_SYNC
 181 #define TIMING_SYNC_TICKCOUNT
 182
 183 /*
 184  * winnet.c dynamically loads WinSock 2 or WinSock 1 depending on
 185  * what it can get, which means any WinSock routines used outside
 186  * that module must be exported from it as function pointers. So
 187  * here they are.
 188  */
 189 extern int (WINAPI *p_WSAAsyncSelect)
 190     (SOCKET s, HWND hWnd, u_int wMsg, long lEvent);
 191 extern int (WINAPI *p_WSAEventSelect)
 192     (SOCKET s, WSAEVENT hEventObject, long lNetworkEvents);
 193 extern int (WINAPI *p_select)
 194     (int nfds, fd_set FAR * readfds, fd_set FAR * writefds,
 195      fd_set FAR *exceptfds, const struct timeval FAR * timeout);
 196 extern int (WINAPI *p_WSAGetLastError)(void);
 197 extern int (WINAPI *p_WSAEnumNetworkEvents)
 198     (SOCKET s, WSAEVENT hEventObject, LPWSANETWORKEVENTS lpNetworkEvents);
 199
 200 extern int socket_writable(SOCKET skt);
 201
 202 /*
 203  * Exports from winctrls.c.
 204  */
 205
 206 struct ctlpos {
 207     HWND hwnd;
 208     WPARAM font;
 209     int dlu4inpix;
 210     int ypos, width;
 211     int xoff;
 212     int boxystart, boxid;
 213     char *boxtext;
 214 };
 215
 216 /*
 217  * Exports from winutils.c.
 218  */
 219 typedef struct filereq_tag filereq; /* cwd for file requester */
 220 BOOL request_file(filereq *state, OPENFILENAME *of, int preserve, int save);
 221 filereq *filereq_new(void);
 222 void filereq_free(filereq *state);
 223 int message_box(LPCTSTR text, LPCTSTR caption, DWORD style, DWORD helpctxid);
 224 void split_into_argv(char *, int *, char ***, char ***);
 225
 226 /*
 227  * Private structure for prefslist state. Only in the header file
 228  * so that we can delegate allocation to callers.
 229  */
 230 struct prefslist {
 231     int listid, upbid, dnbid;
 232     int srcitem;
 233     int dummyitem;
 234     int dragging;
 235 };
 236
 237 /*
 238  * This structure is passed to event handler functions as the `dlg'
 239  * parameter, and hence is passed back to winctrls access functions.
 240  */
 241 struct dlgparam {
 242     HWND hwnd;                         /* the hwnd of the dialog box */
 243     struct winctrls *controltrees[8];  /* can have several of these */
 244     int nctrltrees;
 245     char *wintitle;                    /* title of actual window */
 246     char *errtitle;                    /* title of error sub-messageboxes */
 247     void *data;                        /* data to pass in refresh events */
 248     union control *focused, *lastfocused; /* which ctrl has focus now/before */
 249     char shortcuts[128];               /* track which shortcuts in use */
 250     int coloursel_wanted;              /* has an event handler asked for
 251                                         * a colour selector? */
 252     struct { unsigned char r, g, b, ok; } coloursel_result;   /* 0-255 */
 253     tree234 *privdata;                 /* stores per-control private data */
 254     int ended, endresult;              /* has the dialog been ended? */
 255 };
 256
 257 /*
 258  * Exports from winctrls.c.
 259  */
 260 void ctlposinit(struct ctlpos *cp, HWND hwnd,
 261                 int leftborder, int rightborder, int topborder);
 262 HWND doctl(struct ctlpos *cp, RECT r,
 263            char *wclass, int wstyle, int exstyle, char *wtext, int wid);
 264 void bartitle(struct ctlpos *cp, char *name, int id);
 265 void beginbox(struct ctlpos *cp, char *name, int idbox);
 266 void endbox(struct ctlpos *cp);
 267 void editboxfw(struct ctlpos *cp, int password, char *text,
 268                int staticid, int editid);
 269 void radioline(struct ctlpos *cp, char *text, int id, int nacross, ...);
 270 void bareradioline(struct ctlpos *cp, int nacross, ...);
 271 void radiobig(struct ctlpos *cp, char *text, int id, ...);
 272 void checkbox(struct ctlpos *cp, char *text, int id);
 273 void statictext(struct ctlpos *cp, char *text, int lines, int id);
 274 void staticbtn(struct ctlpos *cp, char *stext, int sid,
 275                char *btext, int bid);
 276 void static2btn(struct ctlpos *cp, char *stext, int sid,
 277                 char *btext1, int bid1, char *btext2, int bid2);
 278 void staticedit(struct ctlpos *cp, char *stext,
 279                 int sid, int eid, int percentedit);
 280 void staticddl(struct ctlpos *cp, char *stext,
 281                int sid, int lid, int percentlist);
 282 void combobox(struct ctlpos *cp, char *text, int staticid, int listid);
 283 void staticpassedit(struct ctlpos *cp, char *stext,
 284                     int sid, int eid, int percentedit);
 285 void bigeditctrl(struct ctlpos *cp, char *stext,
 286                  int sid, int eid, int lines);
 287 void ersatztab(struct ctlpos *cp, char *stext, int sid, int lid, int s2id);
 288 void editbutton(struct ctlpos *cp, char *stext, int sid,
 289                 int eid, char *btext, int bid);
 290 void sesssaver(struct ctlpos *cp, char *text,
 291                int staticid, int editid, int listid, ...);
 292 void envsetter(struct ctlpos *cp, char *stext, int sid,
 293                char *e1stext, int e1sid, int e1id,
 294                char *e2stext, int e2sid, int e2id,
 295                int listid, char *b1text, int b1id, char *b2text, int b2id);
 296 void charclass(struct ctlpos *cp, char *stext, int sid, int listid,
 297                char *btext, int bid, int eid, char *s2text, int s2id);
 298 void colouredit(struct ctlpos *cp, char *stext, int sid, int listid,
 299                 char *btext, int bid, ...);
 300 void prefslist(struct prefslist *hdl, struct ctlpos *cp, int lines,
 301                char *stext, int sid, int listid, int upbid, int dnbid);
 302 int handle_prefslist(struct prefslist *hdl,
 303                      int *array, int maxmemb,
 304                      int is_dlmsg, HWND hwnd,
 305                      WPARAM wParam, LPARAM lParam);
 306 void progressbar(struct ctlpos *cp, int id);
 307 void fwdsetter(struct ctlpos *cp, int listid, char *stext, int sid,
 308                char *e1stext, int e1sid, int e1id,
 309                char *e2stext, int e2sid, int e2id,
 310                char *btext, int bid,
 311                char *r1text, int r1id, char *r2text, int r2id);
 312
 313 #define MAX_SHORTCUTS_PER_CTRL 16
 314
 315 /*
 316  * This structure is what's stored for each `union control' in the
 317  * portable-dialog interface.
 318  */
 319 struct winctrl {
 320     union control *ctrl;
 321     /*
 322      * The control may have several components at the Windows
 323      * level, with different dialog IDs. To avoid needing N
 324      * separate platformsidectrl structures (which could be stored
 325      * separately in a tree234 so that lookup by ID worked), we
 326      * impose the constraint that those IDs must be in a contiguous
 327      * block.
 328      */
 329     int base_id;
 330     int num_ids;
 331     /*
 332      * Remember what keyboard shortcuts were used by this control,
 333      * so that when we remove it again we can take them out of the
 334      * list in the dlgparam.
 335      */
 336     char shortcuts[MAX_SHORTCUTS_PER_CTRL];
 337     /*
 338      * Some controls need a piece of allocated memory in which to
 339      * store temporary data about the control.
 340      */
 341     void *data;
 342 };
 343 /*
 344  * And this structure holds a set of the above, in two separate
 345  * tree234s so that it can find an item by `union control' or by
 346  * dialog ID.
 347  */
 348 struct winctrls {
 349     tree234 *byctrl, *byid;
 350 };
 351 struct controlset;
 352 struct controlbox;
 353
 354 void winctrl_init(struct winctrls *);
 355 void winctrl_cleanup(struct winctrls *);
 356 void winctrl_add(struct winctrls *, struct winctrl *);
 357 void winctrl_remove(struct winctrls *, struct winctrl *);
 358 struct winctrl *winctrl_findbyctrl(struct winctrls *, union control *);
 359 struct winctrl *winctrl_findbyid(struct winctrls *, int);
 360 struct winctrl *winctrl_findbyindex(struct winctrls *, int);
 361 void winctrl_layout(struct dlgparam *dp, struct winctrls *wc,
 362                     struct ctlpos *cp, struct controlset *s, int *id);
 363 int winctrl_handle_command(struct dlgparam *dp, UINT msg,
 364                            WPARAM wParam, LPARAM lParam);
 365 void winctrl_rem_shortcuts(struct dlgparam *dp, struct winctrl *c);
 366 int winctrl_context_help(struct dlgparam *dp, HWND hwnd, int id);
 367
 368 void dp_init(struct dlgparam *dp);
 369 void dp_add_tree(struct dlgparam *dp, struct winctrls *tree);
 370 void dp_cleanup(struct dlgparam *dp);
 371
 372 /*
 373  * Exports from wincfg.c.
 374  */
 375 void win_setup_config_box(struct controlbox *b, HWND *hwndp, int has_help,
 376                           int midsession);
 377
 378 /*
 379  * Exports from windlg.c.
 380  */
 381 void defuse_showwindow(void);
 382 int do_config(void);
 383 int do_reconfig(HWND, int);
 384 void showeventlog(HWND);
 385 void showabout(HWND);
 386 void force_normal(HWND hwnd);
 387 void modal_about_box(HWND hwnd);
 388 void show_help(HWND hwnd);
 389
 390 /*
 391  * Exports from winmisc.c.
 392  */
 393 extern OSVERSIONINFO osVersion;
 394 BOOL init_winver(void);
 395
 396 /*
 397  * Exports from sizetip.c.
 398  */
 399 void UpdateSizeTip(HWND src, int cx, int cy);
 400 void EnableSizeTip(int bEnable);
 401
 402 /*
 403  * Exports from unicode.c.
 404  */
 405 struct unicode_data;
 406 void init_ucs(Config *, struct unicode_data *);
 407
 408 /*
 409  * Exports from winhandl.c.
 410  */
 411 #define HANDLE_FLAG_OVERLAPPED 1
 412 #define HANDLE_FLAG_IGNOREEOF 2
 413 struct handle;
 414 typedef int (*handle_inputfn_t)(struct handle *h, void *data, int len);
 415 typedef void (*handle_outputfn_t)(struct handle *h, int new_backlog);
 416 struct handle *handle_input_new(HANDLE handle, handle_inputfn_t gotdata,
 417                                 void *privdata, int flags);
 418 struct handle *handle_output_new(HANDLE handle, handle_outputfn_t sentdata,
 419                                  void *privdata, int flags);
 420 int handle_write(struct handle *h, const void *data, int len);
 421 HANDLE *handle_get_events(int *nevents);
 422 void handle_free(struct handle *h);
 423 void handle_got_event(HANDLE event);
 424 void handle_unthrottle(struct handle *h, int backlog);
 425 int handle_backlog(struct handle *h);
 426 void *handle_get_privdata(struct handle *h);
 427
 428 /*
 429  * pageantc.c needs to schedule callbacks for asynchronous agent
 430  * requests. This has to be done differently in GUI and console, so
 431  * there's an exported function used for the purpose.
 432  *
 433  * Also, we supply FLAG_SYNCAGENT to force agent requests to be
 434  * synchronous in pscp and psftp.
 435  */
 436 void agent_schedule_callback(void (*callback)(void *, void *, int),
 437                              void *callback_ctx, void *data, int len);
 438 #define FLAG_SYNCAGENT 0x1000
 439
 440 #endif