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