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 /*
   9  * Global variables. Most modules declare these `extern', but
  10  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  11  * module, and so will get them properly defined.
  12  */
  13 #ifndef GLOBAL
  14 #ifdef PUTTY_DO_GLOBALS
  15 #define GLOBAL
  16 #else
  17 #define GLOBAL extern
  18 #endif
  19 #endif
  20
  21 typedef struct config_tag Config;      /* duplicated from putty.h */
  22
  23 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
  24 #define PUTTY_REG_PARENT "Software\\SimonTatham"
  25 #define PUTTY_REG_PARENT_CHILD "PuTTY"
  26 #define PUTTY_REG_GPARENT "Software"
  27 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
  28
  29 #define GETTICKCOUNT GetTickCount
  30 #define CURSORBLINK GetCaretBlinkTime()
  31 #define TICKSPERSEC 1000               /* GetTickCount returns milliseconds */
  32
  33 #define DEFAULT_CODEPAGE CP_ACP
  34
  35 typedef HDC Context;
  36
  37 /*
  38  * Window handles for the dialog boxes that can be running during a
  39  * PuTTY session.
  40  */
  41 GLOBAL HWND logbox;
  42
  43 /*
  44  * The all-important instance handle.
  45  */
  46 GLOBAL HINSTANCE hinst;
  47
  48 /*
  49  * I've just looked in the windows standard headr files for WM_USER, there
  50  * are hundreds of flags defined using the form WM_USER+123 so I've
  51  * renumbered this NETEVENT value and the two in window.c
  52  */
  53 #define WM_XUSER     (WM_USER + 0x2000)
  54 #define WM_NETEVENT  (WM_XUSER + 5)
  55
  56 /*
  57  * On Windows, we send MA_2CLK as the only event marking the second
  58  * press of a mouse button. Compare unix.h.
  59  */
  60 #define MULTICLICK_ONLY_EVENT 1
  61
  62 /*
  63  * On Windows, data written to the clipboard must be NUL-terminated.
  64  */
  65 #define SELECTION_NUL_TERMINATED 1
  66
  67 /*
  68  * On Windows, copying to the clipboard terminates lines with CRLF.
  69  */
  70 #define SEL_NL { 13, 10 }
  71
  72 /*
  73  * Exports from winctrls.c.
  74  */
  75
  76 struct ctlpos {
  77     HWND hwnd;
  78     WPARAM font;
  79     int dlu4inpix;
  80     int ypos, width;
  81     int xoff;
  82     int boxystart, boxid;
  83     char *boxtext;
  84 };
  85
  86 /*
  87  * Exports from winutils.c.
  88  */
  89 void split_into_argv(char *, int *, char ***, char ***);
  90
  91 /*
  92  * Private structure for prefslist state. Only in the header file
  93  * so that we can delegate allocation to callers.
  94  */
  95 struct prefslist {
  96     int listid, upbid, dnbid;
  97     int srcitem;
  98     int dummyitem;
  99     int dragging;
 100 };
 101
 102 /*
 103  * Exports from winctrls.c.
 104  */
 105 void ctlposinit(struct ctlpos *cp, HWND hwnd,
 106                 int leftborder, int rightborder, int topborder);
 107 HWND doctl(struct ctlpos *cp, RECT r,
 108            char *wclass, int wstyle, int exstyle, char *wtext, int wid);
 109 void bartitle(struct ctlpos *cp, char *name, int id);
 110 void beginbox(struct ctlpos *cp, char *name, int idbox);
 111 void endbox(struct ctlpos *cp);
 112 void multiedit(struct ctlpos *cp, ...);
 113 void radioline(struct ctlpos *cp, char *text, int id, int nacross, ...);
 114 void bareradioline(struct ctlpos *cp, int nacross, ...);
 115 void radiobig(struct ctlpos *cp, char *text, int id, ...);
 116 void checkbox(struct ctlpos *cp, char *text, int id);
 117 void statictext(struct ctlpos *cp, char *text, int lines, int id);
 118 void staticbtn(struct ctlpos *cp, char *stext, int sid,
 119                char *btext, int bid);
 120 void static2btn(struct ctlpos *cp, char *stext, int sid,
 121                 char *btext1, int bid1, char *btext2, int bid2);
 122 void staticedit(struct ctlpos *cp, char *stext,
 123                 int sid, int eid, int percentedit);
 124 void staticddl(struct ctlpos *cp, char *stext,
 125                int sid, int lid, int percentlist);
 126 void combobox(struct ctlpos *cp, char *text, int staticid, int listid);
 127 void staticpassedit(struct ctlpos *cp, char *stext,
 128                     int sid, int eid, int percentedit);
 129 void bigeditctrl(struct ctlpos *cp, char *stext,
 130                  int sid, int eid, int lines);
 131 void ersatztab(struct ctlpos *cp, char *stext, int sid, int lid, int s2id);
 132 void editbutton(struct ctlpos *cp, char *stext, int sid,
 133                 int eid, char *btext, int bid);
 134 void sesssaver(struct ctlpos *cp, char *text,
 135                int staticid, int editid, int listid, ...);
 136 void envsetter(struct ctlpos *cp, char *stext, int sid,
 137                char *e1stext, int e1sid, int e1id,
 138                char *e2stext, int e2sid, int e2id,
 139                int listid, char *b1text, int b1id, char *b2text, int b2id);
 140 void charclass(struct ctlpos *cp, char *stext, int sid, int listid,
 141                char *btext, int bid, int eid, char *s2text, int s2id);
 142 void colouredit(struct ctlpos *cp, char *stext, int sid, int listid,
 143                 char *btext, int bid, ...);
 144 void prefslist(struct prefslist *hdl, struct ctlpos *cp, char *stext,
 145                int sid, int listid, int upbid, int dnbid);
 146 int handle_prefslist(struct prefslist *hdl,
 147                      int *array, int maxmemb,
 148                      int is_dlmsg, HWND hwnd,
 149                      WPARAM wParam, LPARAM lParam);
 150 void progressbar(struct ctlpos *cp, int id);
 151 void fwdsetter(struct ctlpos *cp, int listid, char *stext, int sid,
 152                char *e1stext, int e1sid, int e1id,
 153                char *e2stext, int e2sid, int e2id,
 154                char *btext, int bid);
 155
 156 /*
 157  * Exports from windlg.c.
 158  */
 159 void defuse_showwindow(void);
 160 int do_config(void);
 161 int do_reconfig(HWND);
 162 void showeventlog(HWND);
 163 void showabout(HWND);
 164 void force_normal(HWND hwnd);
 165
 166 /*
 167  * Exports from sizetip.c.
 168  */
 169 void UpdateSizeTip(HWND src, int cx, int cy);
 170 void EnableSizeTip(int bEnable);
 171
 172 /*
 173  * Unicode and multi-byte character handling stuff.
 174  */
 175 #define is_dbcs_leadbyte(cp, c) IsDBCSLeadByteEx(cp, c)
 176 #define mb_to_wc(cp, flags, mbstr, mblen, wcstr, wclen) \
 177         MultiByteToWideChar(cp, flags, mbstr, mblen, wcstr, wclen)
 178 #define wc_to_mb(cp, flags, wcstr, wclen, mbstr, mblen, def, defused) \
 179         WideCharToMultiByte(cp, flags, mbstr, mblen, wcstr, wclen, def,defused)
 180
 181 #endif