avoid multiple reallocations in wxString::PrintfV() if vsnprintf() returns the total...

[wxWidgets.git] / src / html / helpctrl.cpp

diff --git a/src/html/helpctrl.cpp b/src/html/helpctrl.cpp
index 72c82d2773e841d5444c153f29e70624a24f43c4..c52512ab365bed9d140679fd9438494146e9064b 100644 (file)
--- a/src/html/helpctrl.cpp
+++ b/src/html/helpctrl.cpp
@@ -9,10 +9,6 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -20,21 +16,35 @@
 #pragma hdrstop
 #endif
 
-#include "wx/defs.h"
+#if wxUSE_WXHTML_HELP
 
-#if wxUSE_HTML && wxUSE_STREAMS
+#ifndef WX_PRECOMP
+    #include "wx/app.h"
+    #include "wx/intl.h"
+#endif // WX_PRECOMP
 
 #include "wx/html/helpctrl.h"
-#include "wx/wx.h"
 #include "wx/busyinfo.h"
 
+#ifdef __WXGTK__
+    // for the hack in AddGrabIfNeeded()
+    #include "wx/dialog.h"
+#endif // __WXGTK__
+
 #if wxUSE_HELP
-#include "wx/tipwin.h"
+    #include "wx/tipwin.h"
+#endif
+
+
+#if wxUSE_LIBMSPACK
+#include "wx/html/forcelnk.h"
+FORCE_LINK(wxhtml_chm_support)
 #endif
 
 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase)
 
-wxHtmlHelpController::wxHtmlHelpController(int style)
+wxHtmlHelpController::wxHtmlHelpController(int style, wxWindow* parentWindow):
+    wxHelpControllerBase(parentWindow)
 {
     m_helpFrame = NULL;
     m_Config = NULL;
@@ -77,6 +87,11 @@ void wxHtmlHelpController::SetTitleFormat(const wxString& title)
 }
 
 
+bool wxHtmlHelpController::AddBook(const wxFileName& book_file, bool show_wait_msg)
+{
+    return AddBook(wxFileSystem::FileNameToURL(book_file), show_wait_msg);
+}
+
 bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
 {
     wxBusyCursor cur;
@@ -93,7 +108,11 @@ bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
 #if wxUSE_BUSYINFO
     if (show_wait_msg)
         delete busy;
+#else
+    wxUnusedVar(show_wait_msg);
 #endif
+    if (m_helpFrame)
+        m_helpFrame->RefreshLists();
     return retval;
 }
 
@@ -115,7 +134,7 @@ void wxHtmlHelpController::CreateHelpWindow()
 
     if (m_Config == NULL)
     {
-        m_Config = wxConfigBase::Get(FALSE);
+        m_Config = wxConfigBase::Get(false);
         if (m_Config != NULL)
             m_ConfigRoot = _T("wxWindows/wxHtmlHelpController");
     }
@@ -126,9 +145,10 @@ void wxHtmlHelpController::CreateHelpWindow()
     if (m_Config)
         m_helpFrame->UseConfig(m_Config, m_ConfigRoot);
 
-    m_helpFrame->Create(NULL, wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle);
+    m_helpFrame->Create(GetParentWindow(), wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle);
     m_helpFrame->SetTitleFormat(m_titleFormat);
-    m_helpFrame->Show(TRUE);
+
+    m_helpFrame->Show(true);
 }
 
 void wxHtmlHelpController::ReadCustomization(wxConfigBase* cfg, const wxString& path)
@@ -161,8 +181,8 @@ bool wxHtmlHelpController::Initialize(const wxString& file)
     wxString dir, filename, ext;
     wxSplitPath(file, & dir, & filename, & ext);
 
-    if (!dir.IsEmpty())
-        dir = dir + wxString(wxT("/"));
+    if (!dir.empty())
+        dir = dir + wxFILE_SEP_PATH;
 
     // Try to find a suitable file
     wxString actualFilename = dir + filename + wxString(wxT(".zip"));
@@ -173,17 +193,22 @@ bool wxHtmlHelpController::Initialize(const wxString& file)
         {
             actualFilename = dir + filename + wxString(wxT(".hhp"));
             if (!wxFileExists(actualFilename))
-                return FALSE;
+            {
+#if wxUSE_LIBMSPACK
+                actualFilename = dir + filename + wxString(wxT(".chm"));
+                if (!wxFileExists(actualFilename))
+#endif
+                    return false;
+            }
         }
     }
-
-    return AddBook(actualFilename);
+    return AddBook(wxFileName(actualFilename));
 }
 
 bool wxHtmlHelpController::LoadFile(const wxString& WXUNUSED(file))
 {
     // Don't reload the file or we'll have it appear again, presumably.
-    return TRUE;
+    return true;
 }
 
 bool wxHtmlHelpController::DisplaySection(int sectionNo)
@@ -193,7 +218,7 @@ bool wxHtmlHelpController::DisplaySection(int sectionNo)
 
 bool wxHtmlHelpController::DisplayTextPopup(const wxString& text, const wxPoint& WXUNUSED(pos))
 {
-#if wxUSE_HELP
+#if wxUSE_TIPWINDOW
     static wxTipWindow* s_tipWindow = NULL;
 
     if (s_tipWindow)
@@ -209,10 +234,13 @@ bool wxHtmlHelpController::DisplayTextPopup(const wxString& text, const wxPoint&
     {
         s_tipWindow = new wxTipWindow(wxTheApp->GetTopWindow(), text, 100, & s_tipWindow);
 
-        return TRUE;
+        return true;
     }
-#endif
-    return FALSE;
+#else
+    wxUnusedVar(text);
+#endif // wxUSE_TIPWINDOW
+
+    return false;
 }
 
 void wxHtmlHelpController::SetFrameParameters(const wxString& title,
@@ -232,7 +260,7 @@ wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size,
                                    bool *newFrameEachTime)
 {
     if (newFrameEachTime)
-        (* newFrameEachTime) = FALSE;
+        (* newFrameEachTime) = false;
     if (size && m_helpFrame)
         (* size) = m_helpFrame->GetSize();
     if (pos && m_helpFrame)
@@ -243,23 +271,75 @@ wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size,
 bool wxHtmlHelpController::Quit()
 {
     DestroyHelpWindow();
-    return TRUE;
+    return true;
 }
 
-// Sets the specified book or all books to have the given base path
-void wxHtmlHelpController::SetBookBasePath(const wxString& basePath, int which)
+// Make the help controller's frame 'modal' if
+// needed
+void wxHtmlHelpController::AddGrabIfNeeded()
 {
-    size_t i;
-    for (i = 0; i < m_helpData.GetBookRecArray().Count(); i++ )
+    // So far, wxGTK only
+#ifdef __WXGTK__
+    bool needGrab = false;
+
+    // Check if there are any modal windows present,
+    // in which case we need to add a grab.
+    for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
+          node;
+          node = node->GetNext() )
     {
-        if (i == (size_t) which || which == -1)
-        {
-            wxHtmlBookRecord& book = m_helpData.GetBookRecArray()[i];
-            book.SetBasePath(basePath);
-        }
-        if (i == (size_t) which)
-            return;
+        wxWindow *win = node->GetData();
+        wxDialog *dialog = wxDynamicCast(win, wxDialog);
+
+        if (dialog && dialog->IsModal())
+            needGrab = true;
     }
+
+    if (needGrab && m_helpFrame)
+        m_helpFrame->AddGrab();
+#endif // __WXGTK__
 }
 
-#endif
+bool wxHtmlHelpController::Display(const wxString& x)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->Display(x);
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::Display(int id)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->Display(id);
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::DisplayContents()
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->DisplayContents();
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::DisplayIndex()
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->DisplayIndex();
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::KeywordSearch(const wxString& keyword,
+                                         wxHelpSearchMode mode)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->KeywordSearch(keyword, mode);
+    AddGrabIfNeeded();
+    return success;
+}
+
+#endif // wxUSE_WXHTML_HELP
+