2 * hhctrl implementation
4 * Copyright 2004 Krzysztof Foltman
5 * Copyright 2007 Jacek Caban for CodeWeavers
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp);
41 HINSTANCE hhctrl_hinstance;
42 BOOL hh_process = FALSE;
44 BOOL WINAPI DllMain(HINSTANCE hInstance, DWORD fdwReason, LPVOID lpvReserved)
46 TRACE("(%p,%d,%p)\n", hInstance, fdwReason, lpvReserved);
50 case DLL_PROCESS_ATTACH:
51 hhctrl_hinstance = hInstance;
52 DisableThreadLibraryCalls(hInstance);
54 case DLL_PROCESS_DETACH:
60 static const char *command_to_string(UINT command)
62 #define X(x) case x: return #x
65 X( HH_DISPLAY_TOPIC );
67 X( HH_DISPLAY_INDEX );
68 X( HH_DISPLAY_SEARCH );
71 X( HH_GET_WIN_HANDLE );
72 X( HH_ENUM_INFO_TYPE );
73 X( HH_SET_INFO_TYPE );
78 X( HH_KEYWORD_LOOKUP );
79 X( HH_DISPLAY_TEXT_POPUP );
81 X( HH_TP_HELP_CONTEXTMENU );
82 X( HH_TP_HELP_WM_HELP );
85 X( HH_GET_LAST_ERROR );
86 X( HH_ENUM_CATEGORY );
87 X( HH_ENUM_CATEGORY_IT );
88 X( HH_RESET_IT_FILTER );
89 X( HH_SET_INCLUSIVE_FILTER );
90 X( HH_SET_EXCLUSIVE_FILTER );
93 X( HH_SAFE_DISPLAY_TOPIC );
94 X( HH_PRETRANSLATEMESSAGE );
95 X( HH_SET_GLOBAL_PROPERTY );
96 default: return "???";
101 static BOOL resolve_filename(const WCHAR *filename, WCHAR *fullname, DWORD buflen, const WCHAR **index, const WCHAR **window)
104 WCHAR chm_file[MAX_PATH];
106 static const WCHAR helpW[] = {'\\','h','e','l','p','\\',0};
107 static const WCHAR delimW[] = {':',':',0};
108 static const WCHAR delim2W[] = {'>',0};
110 filename = skip_schema(filename);
112 /* the format is "helpFile[::/index][>window]" */
113 if (index) *index = NULL;
114 if (window) *window = NULL;
116 extra = strstrW(filename, delim2W);
119 memcpy(chm_file, filename, (extra-filename)*sizeof(WCHAR));
120 chm_file[extra-filename] = 0;
123 *window = strdupW(extra+1);
126 extra = strstrW(filename, delimW);
129 if (filename != chm_file)
130 memcpy(chm_file, filename, (extra-filename)*sizeof(WCHAR));
131 chm_file[extra-filename] = 0;
134 *index = strdupW(extra+2);
137 GetFullPathNameW(filename, buflen, fullname, NULL);
138 if (GetFileAttributesW(fullname) == INVALID_FILE_ATTRIBUTES)
140 GetWindowsDirectoryW(fullname, buflen);
141 strcatW(fullname, helpW);
142 strcatW(fullname, filename);
144 return (GetFileAttributesW(fullname) != INVALID_FILE_ATTRIBUTES);
147 /******************************************************************
148 * HtmlHelpW (HHCTRL.OCX.15)
150 HWND WINAPI HtmlHelpW(HWND caller, LPCWSTR filename, UINT command, DWORD_PTR data)
152 WCHAR fullname[MAX_PATH];
154 TRACE("(%p, %s, command=%s, data=%lx)\n",
155 caller, debugstr_w( filename ),
156 command_to_string( command ), data);
160 case HH_DISPLAY_TOPIC:
162 case HH_DISPLAY_INDEX:
163 case HH_DISPLAY_SEARCH:{
167 const WCHAR *index = NULL;
168 int tab_index = TAB_CONTENTS;
169 const WCHAR *default_index = NULL;
174 if (!resolve_filename(filename, fullname, MAX_PATH, &default_index, NULL))
176 WARN("can't find %s\n", debugstr_w(filename));
179 index = default_index;
181 info = CreateHelpViewer(fullname);
186 index = info->WinType.pszFile;
188 /* called to load a specified topic */
191 case HH_DISPLAY_TOPIC:
194 index = (const WCHAR *)data;
198 res = NavigateToChm(info, info->pCHMInfo->szFile, index);
201 heap_free((WCHAR*)default_index);
205 ReleaseHelpViewer(info);
211 case HH_DISPLAY_TOPIC:
213 tab_index = TAB_CONTENTS;
215 case HH_DISPLAY_INDEX:
216 tab_index = TAB_INDEX;
218 FIXME("Should select keyword '%s'.\n", debugstr_w((WCHAR *)data));
220 case HH_DISPLAY_SEARCH:
221 tab_index = TAB_SEARCH;
223 FIXME("Should display search specified by HH_FTS_QUERY structure.\n");
226 /* open the requested tab */
227 memset(&nmhdr, 0, sizeof(nmhdr));
228 nmhdr.code = TCN_SELCHANGE;
229 SendMessageW(info->hwndTabCtrl, TCM_SETCURSEL, (WPARAM)info->tabs[tab_index].id, 0);
230 SendMessageW(info->WinType.hwndNavigation, WM_NOTIFY, 0, (LPARAM)&nmhdr);
232 return info->WinType.hwndHelp;
234 case HH_HELP_CONTEXT: {
241 if (!resolve_filename(filename, fullname, MAX_PATH, NULL, NULL))
243 WARN("can't find %s\n", debugstr_w(filename));
247 info = CreateHelpViewer(fullname);
251 url = FindContextAlias(info->pCHMInfo, data);
254 ReleaseHelpViewer(info);
258 NavigateToUrl(info, url);
260 return info->WinType.hwndHelp;
262 case HH_PRETRANSLATEMESSAGE: {
263 static BOOL warned = FALSE;
267 FIXME("HH_PRETRANSLATEMESSAGE unimplemented\n");
273 FIXME("HH case %s not handled.\n", command_to_string( command ));
279 /******************************************************************
280 * HtmlHelpA (HHCTRL.OCX.14)
282 HWND WINAPI HtmlHelpA(HWND caller, LPCSTR filename, UINT command, DWORD_PTR data)
284 WCHAR *wfile = NULL, *wdata = NULL;
290 len = MultiByteToWideChar( CP_ACP, 0, filename, -1, NULL, 0 );
291 wfile = heap_alloc(len*sizeof(WCHAR));
292 MultiByteToWideChar( CP_ACP, 0, filename, -1, wfile, len );
299 case HH_ALINK_LOOKUP:
300 case HH_DISPLAY_SEARCH:
301 case HH_DISPLAY_TEXT_POPUP:
302 case HH_GET_LAST_ERROR:
303 case HH_GET_WIN_TYPE:
304 case HH_KEYWORD_LOOKUP:
305 case HH_SET_WIN_TYPE:
307 FIXME("structures not handled yet\n");
310 case HH_DISPLAY_INDEX:
311 case HH_DISPLAY_TOPIC:
313 case HH_GET_WIN_HANDLE:
314 case HH_SAFE_DISPLAY_TOPIC:
315 len = MultiByteToWideChar( CP_ACP, 0, (const char*)data, -1, NULL, 0 );
316 wdata = heap_alloc(len*sizeof(WCHAR));
317 MultiByteToWideChar( CP_ACP, 0, (const char*)data, -1, wdata, len );
321 case HH_HELP_CONTEXT:
323 case HH_PRETRANSLATEMESSAGE:
324 case HH_TP_HELP_CONTEXTMENU:
325 case HH_TP_HELP_WM_HELP:
326 case HH_UNINITIALIZE:
327 /* either scalar or pointer to scalar - do nothing */
331 FIXME("Unknown command: %s (%d)\n", command_to_string(command), command);
336 result = HtmlHelpW( caller, wfile, command, wdata ? (DWORD_PTR)wdata : data );
343 /******************************************************************
344 * doWinMain (HHCTRL.OCX.13)
346 int WINAPI doWinMain(HINSTANCE hInstance, LPSTR szCmdLine)
349 int len, buflen, mapid = -1;
356 /* Parse command line option of the HTML Help command.
358 * Note: The only currently handled action is "mapid",
359 * which corresponds to opening a specific page.
361 while(*szCmdLine == '-')
366 space = strchr(ptr, ' ');
367 if(!strncmp(ptr, "mapid", space-ptr))
371 ptr += strlen("mapid")+1;
372 space = strchr(ptr, ' ');
373 /* command line ends without number */
376 memcpy(idtxt, ptr, space-ptr);
377 idtxt[space-ptr] = '\0';
383 FIXME("Unhandled HTML Help command line parameter! (%.*s)\n", (int)(space-szCmdLine), szCmdLine);
388 /* FIXME: Check szCmdLine for bad arguments */
389 if (*szCmdLine == '\"')
390 endq = strchr(++szCmdLine, '\"');
393 len = endq - szCmdLine;
395 len = strlen(szCmdLine);
397 /* no filename given */
401 buflen = MultiByteToWideChar(CP_ACP, 0, szCmdLine, len, NULL, 0) + 1;
402 filename = heap_alloc(buflen * sizeof(WCHAR));
403 MultiByteToWideChar(CP_ACP, 0, szCmdLine, len, filename, buflen);
404 filename[buflen-1] = 0;
406 /* Open a specific help topic */
408 hwnd = HtmlHelpW(GetDesktopWindow(), filename, HH_HELP_CONTEXT, mapid);
410 hwnd = HtmlHelpW(GetDesktopWindow(), filename, HH_DISPLAY_TOPIC, 0);
416 ERR("Failed to open HTML Help file '%s'.\n", szCmdLine);
420 while (GetMessageW(&msg, 0, 0, 0))
422 TranslateMessage(&msg);
423 DispatchMessageW(&msg);
429 /******************************************************************
430 * DllGetClassObject (HHCTRL.OCX.@)
432 HRESULT WINAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv)
434 FIXME("(%s %s %p)\n", debugstr_guid(rclsid), debugstr_guid(riid), ppv);
435 return CLASS_E_CLASSNOTAVAILABLE;
438 /***********************************************************************
439 * DllRegisterServer (HHCTRL.OCX.@)
441 HRESULT WINAPI DllRegisterServer(void)
443 return __wine_register_resources( hhctrl_hinstance );
446 /***********************************************************************
447 * DllUnregisterServer (HHCTRL.OCX.@)
449 HRESULT WINAPI DllUnregisterServer(void)
451 return __wine_unregister_resources( hhctrl_hinstance );