dlls/hhctrl.ocx/hhctrl.h

   1 /*
   2  * Copyright 2005 James Hawkins
   3  * Copyright 2007 Jacek Caban for CodeWeavers
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef HHCTRL_H
  21 #define HHCTRL_H
  22
  23 #include <stdarg.h>
  24
  25 #define COBJMACROS
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winuser.h"
  30 #include "winnls.h"
  31 #include "htmlhelp.h"
  32 #include "ole2.h"
  33 #include "exdisp.h"
  34 #include "mshtmhst.h"
  35 #include "commctrl.h"
  36
  37 #ifdef INIT_GUID
  38 #include "initguid.h"
  39 #endif
  40
  41 #include "wine/itss.h"
  42 #include "wine/unicode.h"
  43
  44 #define WB_GOBACK     0
  45 #define WB_GOFORWARD  1
  46 #define WB_GOHOME     2
  47 #define WB_SEARCH     3
  48 #define WB_REFRESH    4
  49 #define WB_STOP       5
  50 #define WB_PRINT      6
  51
  52 typedef struct {
  53     LPWSTR chm_file;
  54     LPWSTR chm_index;
  55 } ChmPath;
  56
  57 typedef struct ContentItem {
  58     struct ContentItem *parent;
  59     struct ContentItem *child;
  60     struct ContentItem *next;
  61
  62     HTREEITEM id;
  63
  64     LPWSTR name;
  65     LPWSTR local;
  66     ChmPath merge;
  67 } ContentItem;
  68
  69 typedef struct IndexSubItem {
  70     LPWSTR name;
  71     LPWSTR local;
  72 } IndexSubItem;
  73
  74 typedef struct IndexItem {
  75     struct IndexItem *next;
  76
  77     HTREEITEM id;
  78     LPWSTR keyword;
  79     ChmPath merge;
  80
  81     int nItems;
  82     int itemFlags;
  83     int indentLevel;
  84     IndexSubItem *items;
  85 } IndexItem;
  86
  87 typedef struct SearchItem {
  88     struct SearchItem *next;
  89
  90     HTREEITEM id;
  91     LPWSTR title;
  92     LPWSTR filename;
  93 } SearchItem;
  94
  95 typedef struct CHMInfo
  96 {
  97     IITStorage *pITStorage;
  98     IStorage *pStorage;
  99     WCHAR *szFile;
 100
 101     IStream *strings_stream;
 102     char **strings;
 103     DWORD strings_size;
 104
 105     WCHAR *defTopic;
 106     WCHAR *defTitle;
 107     WCHAR *defToc;
 108 } CHMInfo;
 109
 110 #define TAB_CONTENTS   0
 111 #define TAB_INDEX      1
 112 #define TAB_SEARCH     2
 113 #define TAB_FAVORITES  3
 114 #define TAB_NUMTABS    TAB_FAVORITES
 115
 116 typedef struct {
 117     HWND hwnd;
 118     DWORD id;
 119 } HHTab;
 120
 121 typedef struct {
 122     HWND hwndList;
 123     HWND hwndPopup;
 124     HWND hwndCallback;
 125 } IndexPopup;
 126
 127 typedef struct {
 128     SearchItem *root;
 129     HWND hwndEdit;
 130     HWND hwndList;
 131     HWND hwndContainer;
 132 } SearchTab;
 133
 134 typedef struct {
 135     IOleClientSite *client_site;
 136     IWebBrowser2 *web_browser;
 137     IOleObject *wb_object;
 138
 139     HH_WINTYPEW WinType;
 140
 141     LPWSTR pszType;
 142     LPWSTR pszCaption;
 143     LPWSTR pszToc;
 144     LPWSTR pszIndex;
 145     LPWSTR pszFile;
 146     LPWSTR pszHome;
 147     LPWSTR pszJump1;
 148     LPWSTR pszJump2;
 149     LPWSTR pszUrlJump1;
 150     LPWSTR pszUrlJump2;
 151     LPWSTR pszCustomTabs;
 152
 153     CHMInfo *pCHMInfo;
 154     ContentItem *content;
 155     IndexItem *index;
 156     IndexPopup popup;
 157     SearchTab search;
 158     HWND hwndTabCtrl;
 159     HWND hwndSizeBar;
 160     HFONT hFont;
 161
 162     HHTab tabs[TAB_FAVORITES+1];
 163     DWORD current_tab;
 164 } HHInfo;
 165
 166 BOOL InitWebBrowser(HHInfo*,HWND) DECLSPEC_HIDDEN;
 167 void ReleaseWebBrowser(HHInfo*) DECLSPEC_HIDDEN;
 168 void ResizeWebBrowser(HHInfo*,DWORD,DWORD) DECLSPEC_HIDDEN;
 169 void DoPageAction(HHInfo*,DWORD) DECLSPEC_HIDDEN;
 170
 171 void InitContent(HHInfo*) DECLSPEC_HIDDEN;
 172 void ReleaseContent(HHInfo*) DECLSPEC_HIDDEN;
 173 void ActivateContentTopic(HWND,LPCWSTR,ContentItem *) DECLSPEC_HIDDEN;
 174
 175 void InitIndex(HHInfo*) DECLSPEC_HIDDEN;
 176 void ReleaseIndex(HHInfo*) DECLSPEC_HIDDEN;
 177
 178 CHMInfo *OpenCHM(LPCWSTR szFile) DECLSPEC_HIDDEN;
 179 BOOL LoadWinTypeFromCHM(HHInfo *info) DECLSPEC_HIDDEN;
 180 CHMInfo *CloseCHM(CHMInfo *pCHMInfo) DECLSPEC_HIDDEN;
 181 void SetChmPath(ChmPath*,LPCWSTR,LPCWSTR) DECLSPEC_HIDDEN;
 182 IStream *GetChmStream(CHMInfo*,LPCWSTR,ChmPath*) DECLSPEC_HIDDEN;
 183 LPWSTR FindContextAlias(CHMInfo*,DWORD) DECLSPEC_HIDDEN;
 184
 185 HHInfo *CreateHelpViewer(LPCWSTR) DECLSPEC_HIDDEN;
 186 void ReleaseHelpViewer(HHInfo*) DECLSPEC_HIDDEN;
 187 BOOL NavigateToUrl(HHInfo*,LPCWSTR) DECLSPEC_HIDDEN;
 188 BOOL NavigateToChm(HHInfo*,LPCWSTR,LPCWSTR) DECLSPEC_HIDDEN;
 189
 190 void InitSearch(HHInfo *info, const char *needle) DECLSPEC_HIDDEN;
 191 void ReleaseSearch(HHInfo *info) DECLSPEC_HIDDEN;
 192
 193 LPCWSTR skip_schema(LPCWSTR url) DECLSPEC_HIDDEN;
 194
 195 /* memory allocation functions */
 196
 197 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc(size_t len)
 198 {
 199     return HeapAlloc(GetProcessHeap(), 0, len);
 200 }
 201
 202 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t len)
 203 {
 204     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 205 }
 206
 207 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc(void *mem, size_t len)
 208 {
 209     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 210 }
 211
 212 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t len)
 213 {
 214     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
 215 }
 216
 217 static inline BOOL heap_free(void *mem)
 218 {
 219     return HeapFree(GetProcessHeap(), 0, mem);
 220 }
 221
 222 static inline LPWSTR strdupW(LPCWSTR str)
 223 {
 224     LPWSTR ret;
 225     int size;
 226
 227     if(!str)
 228         return NULL;
 229
 230     size = (strlenW(str)+1)*sizeof(WCHAR);
 231     ret = heap_alloc(size);
 232     memcpy(ret, str, size);
 233
 234     return ret;
 235 }
 236
 237 static inline LPWSTR strdupnAtoW(LPCSTR str, LONG lenA)
 238 {
 239     LPWSTR ret;
 240     DWORD len;
 241
 242     if(!str)
 243         return NULL;
 244
 245     if (lenA > 0)
 246     {
 247         /* find length of string */
 248         LPCSTR eos = memchr(str, 0, lenA);
 249         if (eos) lenA = eos - str;
 250     }
 251
 252     len = MultiByteToWideChar(CP_ACP, 0, str, lenA, NULL, 0)+1; /* +1 for null pad */
 253     ret = heap_alloc(len*sizeof(WCHAR));
 254     MultiByteToWideChar(CP_ACP, 0, str, lenA, ret, len);
 255     ret[len-1] = 0;
 256
 257     return ret;
 258 }
 259
 260 static inline LPWSTR strdupAtoW(LPCSTR str)
 261 {
 262     return strdupnAtoW(str, -1);
 263 }
 264
 265
 266
 267 extern HINSTANCE hhctrl_hinstance DECLSPEC_HIDDEN;
 268 extern BOOL hh_process DECLSPEC_HIDDEN;
 269
 270 #endif