X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0b9ab0bd824b6b9c93849928d67de1ec71e7c167..50679f941ec64c417c39582b276068fef8ca59cb:/src/msw/helpchm.cpp

diff --git a/src/msw/helpchm.cpp b/src/msw/helpchm.cpp
index 37035ff455..411d495980 100644
--- a/src/msw/helpchm.cpp
+++ b/src/msw/helpchm.cpp
@@ -1,181 +1,158 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        helpchm.cpp
+// Name:        src/msw/helpchm.cpp
 // Purpose:     Help system: MS HTML Help implementation
 // Author:      Julian Smart
 // Modified by:
 // Created:     16/04/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:   	wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "helpchm.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
-#ifndef WX_PRECOMP
-#include "wx/defs.h"
-#endif
+#if wxUSE_HELP && wxUSE_MS_HTML_HELP
 
 #include "wx/filefn.h"
-
-#if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__)
 #include "wx/msw/helpchm.h"
 
-#if wxUSE_DYNAMIC_LOADER || wxUSE_DYNLIB_CLASS
-#include "wx/dynlib.h"
-#endif
+#include "wx/dynload.h"
 
 #ifndef WX_PRECOMP
-#include <windows.h>
+    #include "wx/intl.h"
+    #include "wx/app.h"
 #endif
 
-// This is found in the HTML Help Workshop installation,
-// along with htmlhelp.lib.
-#include <htmlhelp.h>
-
-#include <time.h>
-
-#ifdef __WXMSW__
 #include "wx/msw/private.h"
-#endif
-
-#include <string.h>
+#include "wx/msw/htmlhelp.h"
 
+// ----------------------------------------------------------------------------
 // utility functions to manage the loading/unloading
 // of hhctrl.ocx
+// ----------------------------------------------------------------------------
+
 #ifndef UNICODE
-typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD );
-#define HTMLHELP_NAME "HtmlHelpA"
-#else
-typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCWSTR, UINT, DWORD );
-#define HTMLHELP_NAME "HtmlHelpW"
+    typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD );
+    #define HTMLHELP_NAME wxT("HtmlHelpA")
+#else // ANSI
+    typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCWSTR, UINT, DWORD );
+    #define HTMLHELP_NAME wxT("HtmlHelpW")
 #endif
-// dll handle/reference count
-static HTMLHELP gs_htmlHelp = 0;
-static wxDllType gs_dllHandle = 0;
-static int gs_dllCount = 0;
 
-static bool LoadHtmlHelpLibrary()
+HTMLHELP GetHtmlHelpFunction()
 {
-    if( !gs_dllCount )
+    static HTMLHELP s_htmlHelp = NULL;
+
+    if ( !s_htmlHelp )
     {
-        gs_dllHandle = wxDllLoader::LoadLibrary( "hhctrl.ocx" );
-        if( !gs_dllHandle )
+        static wxDynamicLibrary s_dllHtmlHelp(_T("HHCTRL.OCX"), wxDL_VERBATIM);
+
+        if ( !s_dllHtmlHelp.IsLoaded() )
         {
             wxLogError(_("MS HTML Help functions are unavailable because the MS HTML Help library is not installed on this machine. Please install it."));
-            return FALSE;
         }
         else
         {
-            gs_dllCount = 1;
-            gs_htmlHelp = (HTMLHELP)wxDllLoader::GetSymbol( gs_dllHandle, HTMLHELP_NAME );
-
-            if( !gs_htmlHelp )
+            s_htmlHelp = (HTMLHELP)s_dllHtmlHelp.GetSymbol(HTMLHELP_NAME);
+            if ( !s_htmlHelp )
             {
                 wxLogError(_("Failed to initialize MS HTML Help."));
-
-                wxDllLoader::UnloadLibrary(gs_dllHandle);
-                gs_dllHandle = 0;
-                gs_dllCount = 0;
-
-                return FALSE ;
             }
         }
     }
-    else
-    {
-        ++gs_dllCount;
-    }
 
-    return TRUE;
+    return s_htmlHelp;
 }
 
-static void UnloadHtmlHelpLibrary()
+// find the window to use in HtmlHelp() call: use the given one by default but
+// fall back to the top level app window and then the desktop if it's NULL
+static HWND GetSuitableHWND(wxWindow *win)
 {
-    if( gs_dllCount != 0 && !--gs_dllCount )
-    {
-        wxDllLoader::UnloadLibrary( gs_dllHandle );
-        gs_dllHandle = 0;
-        gs_htmlHelp = 0;
-    }
+    if ( !win && wxTheApp )
+        win = wxTheApp->GetTopWindow();
+
+    return win ? GetHwndOf(win) : ::GetDesktopWindow();
 }
 
-static HWND GetSuitableHWND()
+// wrap the real HtmlHelp() but just return false (and not crash) if it
+// couldn't be loaded
+//
+// it also takes a wxWindow instead of HWND
+static bool
+CallHtmlHelpFunction(wxWindow *win, const wxChar *str, UINT uint, DWORD dword)
 {
-    if (wxTheApp->GetTopWindow())
-        return (HWND) wxTheApp->GetTopWindow()->GetHWND();
-    else
-        return GetDesktopWindow();
+    HTMLHELP htmlHelp = GetHtmlHelpFunction();
+
+    return htmlHelp && htmlHelp(GetSuitableHWND(win), str, uint, dword);
 }
 
 IMPLEMENT_DYNAMIC_CLASS(wxCHMHelpController, wxHelpControllerBase)
 
 bool wxCHMHelpController::Initialize(const wxString& filename)
 {
-    // warn on failure
-    if( !LoadHtmlHelpLibrary() )
-        return FALSE;
+    if ( !GetHtmlHelpFunction() )
+        return false;
 
     m_helpFile = filename;
-    return TRUE;
+    return true;
 }
 
 bool wxCHMHelpController::LoadFile(const wxString& file)
 {
     if (!file.IsEmpty())
         m_helpFile = file;
-    return TRUE;
+    return true;
 }
 
 bool wxCHMHelpController::DisplayContents()
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty())
+        return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_FINDER, 0L);
-    return TRUE;
+    return CallHtmlHelpFunction(GetParentWindow(), str, HH_DISPLAY_TOPIC, 0L);
 }
 
 // Use topic or HTML filename
 bool wxCHMHelpController::DisplaySection(const wxString& section)
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty())
+        return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
     // Is this an HTML file or a keyword?
-    bool isFilename = (section.Find(wxT(".htm")) != -1);
+    if ( section.Find(wxT(".htm")) != wxNOT_FOUND )
+    {
+        // interpret as a file name
+        return CallHtmlHelpFunction(GetParentWindow(), str, HH_DISPLAY_TOPIC,
+                                    wxPtrToUInt(section.c_str()));
+    }
 
-    if (isFilename)
-        gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section);
-    else
-        KeywordSearch(section);
-    return TRUE;
+    return KeywordSearch(section);
 }
 
 // Use context number
 bool wxCHMHelpController::DisplaySection(int section)
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty())
+        return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);
-    return TRUE;
+    return CallHtmlHelpFunction(GetParentWindow(), str, HH_HELP_CONTEXT,
+                                (DWORD)section);
 }
 
 bool wxCHMHelpController::DisplayContextPopup(int contextId)
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
@@ -194,11 +171,20 @@ bool wxCHMHelpController::DisplayContextPopup(int contextId)
     popup.pszFont = NULL;
     popup.pszText = NULL;
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
-    return TRUE;
+    return CallHtmlHelpFunction(GetParentWindow(), str, HH_DISPLAY_TEXT_POPUP,
+                                wxPtrToUInt(&popup));
 }
 
-bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos)
+bool
+wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos)
+{
+    return ShowContextHelpPopup(text, pos, GetParentWindow());
+}
+
+/* static */
+bool wxCHMHelpController::ShowContextHelpPopup(const wxString& text,
+                                               const wxPoint& pos,
+                                               wxWindow *window)
 {
     HH_POPUP popup;
     popup.cbStruct = sizeof(popup);
@@ -211,8 +197,8 @@ bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint&
     popup.pszFont = NULL;
     popup.pszText = (const wxChar*) text;
 
-    gs_htmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
-    return TRUE;
+    return CallHtmlHelpFunction(window, NULL, HH_DISPLAY_TEXT_POPUP,
+                                wxPtrToUInt(&popup));
 }
 
 bool wxCHMHelpController::DisplayBlock(long block)
@@ -220,9 +206,11 @@ bool wxCHMHelpController::DisplayBlock(long block)
     return DisplaySection(block);
 }
 
-bool wxCHMHelpController::KeywordSearch(const wxString& k)
+bool wxCHMHelpController::KeywordSearch(const wxString& k,
+                                        wxHelpSearchMode WXUNUSED(mode))
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty())
+        return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
@@ -236,16 +224,13 @@ bool wxCHMHelpController::KeywordSearch(const wxString& k)
     link.pszWindow =    NULL ;
     link.fIndexOnFail = TRUE ;
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
-    return TRUE;
+    return CallHtmlHelpFunction(GetParentWindow(), str, HH_KEYWORD_LOOKUP,
+                                wxPtrToUInt(&link));
 }
 
 bool wxCHMHelpController::Quit()
 {
-    gs_htmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
-    UnloadHtmlHelpLibrary();
-
-    return TRUE;
+    return CallHtmlHelpFunction(GetParentWindow(), NULL, HH_CLOSE_ALL, 0L);
 }
 
 // Append extension if necessary.