]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/helpdata.cpp
Clean up indentation / tabs from previous patch
[wxWidgets.git] / src / html / helpdata.cpp
index 312857dedfde84d9b0d492abb350909e01102df5..b942ed09be50cbf3954b280345b69a1792cf2c80 100644 (file)
@@ -9,8 +9,8 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma implementation "helpdata.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
@@ -29,6 +29,8 @@
     #include "wx/log.h"
 #endif
 
+#include <ctype.h>
+
 #include "wx/html/helpdata.h"
 #include "wx/tokenzr.h"
 #include "wx/wfstream.h"
 #include "wx/log.h"
 #include "wx/html/htmlpars.h"
 #include "wx/html/htmldefs.h"
+#include "wx/html/htmlfilt.h"
 #include "wx/filename.h"
 
 #include "wx/arrimpl.cpp"
 WX_DEFINE_OBJARRAY(wxHtmlBookRecArray)
+WX_DEFINE_OBJARRAY(wxHtmlHelpDataItems)
 
 //-----------------------------------------------------------------------------
 // static helper functions
 //-----------------------------------------------------------------------------
 
 // Reads one line, stores it into buf and returns pointer to new line or NULL.
-static char* ReadLine(char *line, char *buf, size_t bufsize)
+static const wxChar* ReadLine(const wxChar *line, wxChar *buf, size_t bufsize)
 {
-    char *writeptr = buf;
-    char *endptr = buf + bufsize - 1;
-    char *readptr = line;
+    wxChar *writeptr = buf;
+    wxChar *endptr = buf + bufsize - 1;
+    const wxChar *readptr = line;
 
-    while (*readptr != 0 && *readptr != '\r' && *readptr != '\n' &&
-           writeptr != endptr) 
+    while (*readptr != 0 && *readptr != _T('\r') && *readptr != _T('\n') &&
+           writeptr != endptr)
         *(writeptr++) = *(readptr++);
     *writeptr = 0;
-    while (*readptr == '\r' || *readptr == '\n')
+    while (*readptr == _T('\r') || *readptr == _T('\n'))
         readptr++;
     if (*readptr == 0)
         return NULL;
-    else 
+    else
         return readptr;
 }
 
 
 
-extern "C" int LINKAGEMODE
-wxHtmlHelpIndexCompareFunc(const void *a, const void *b)
+static int
+wxHtmlHelpIndexCompareFunc(wxHtmlHelpDataItem **a, wxHtmlHelpDataItem **b)
 {
-    return wxStricmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name);
-}
+    wxHtmlHelpDataItem *ia = *a;
+    wxHtmlHelpDataItem *ib = *b;
+
+    if (ia == NULL)
+        return -1;
+    if (ib == NULL)
+        return 1;
+
+    if (ia->parent == ib->parent)
+    {
+        return ia->name.CmpNoCase(ib->name);
+    }
+    else if (ia->level == ib->level)
+    {
+        return wxHtmlHelpIndexCompareFunc(&ia->parent, &ib->parent);
+    }
+    else
+    {
+        wxHtmlHelpDataItem *ia2 = ia;
+        wxHtmlHelpDataItem *ib2 = ib;
+
+        while (ia2->level > ib2->level)
+        {
+            ia2 = ia2->parent;
+        }
+        while (ib2->level > ia2->level)
+        {
+            ib2 = ib2->parent;
+        }
 
+        wxASSERT(ia2);
+        wxASSERT(ib2);
+        int res = wxHtmlHelpIndexCompareFunc(&ia2, &ib2);
+        if (res != 0)
+            return res;
+        else if (ia->level > ib->level)
+            return 1;
+        else
+            return -1;
+    }
+}
 
 //-----------------------------------------------------------------------------
 // HP_Parser
@@ -82,9 +124,17 @@ wxHtmlHelpIndexCompareFunc(const void *a, const void *b)
 class HP_Parser : public wxHtmlParser
 {
 public:
+    HP_Parser()
+    {
+        GetEntitiesParser()->SetEncoding(wxFONTENCODING_ISO8859_1);
+    }
+
     wxObject* GetProduct() { return NULL; }
+
 protected:
     virtual void AddText(const wxChar* WXUNUSED(txt)) {}
+
+    DECLARE_NO_COPY_CLASS(HP_Parser)
 };
 
 
@@ -95,22 +145,39 @@ protected:
 class HP_TagHandler : public wxHtmlTagHandler
 {
     private:
-        wxString m_Name, m_Page;
-        int m_Level;
-        int m_ID;
-        int m_Index;
-        wxHtmlContentsItem *m_Items;
-        int m_ItemsCnt;
-        wxHtmlBookRecord *m_Book;
+        wxString m_name, m_page;
+        int m_level;
+        int m_id;
+        int m_index;
+        int m_count;
+        wxHtmlHelpDataItem *m_parentItem;
+        wxHtmlBookRecord *m_book;
+
+        wxHtmlHelpDataItems *m_data;
 
     public:
         HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler()
-            { m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString;
-              m_Level = 0; m_ID = -1; }
+        {
+            m_data = NULL;
+            m_book = b;
+            m_name = m_page = wxEmptyString;
+            m_level = 0;
+            m_id = wxID_ANY;
+            m_count = 0;
+            m_parentItem = NULL;
+        }
         wxString GetSupportedTags() { return wxT("UL,OBJECT,PARAM"); }
         bool HandleTag(const wxHtmlTag& tag);
-        void WriteOut(wxHtmlContentsItem*& array, int& size);
-        void ReadIn(wxHtmlContentsItem* array, int size);
+
+        void Reset(wxHtmlHelpDataItems& data)
+        {
+            m_data = &data;
+            m_count = 0;
+            m_level = 0;
+            m_parentItem = NULL;
+        }
+
+    DECLARE_NO_COPY_CLASS(HP_TagHandler)
 };
 
 
@@ -118,18 +185,21 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
 {
     if (tag.GetName() == wxT("UL"))
     {
-        m_Level++;
+        wxHtmlHelpDataItem *oldparent = m_parentItem;
+        m_level++;
+        m_parentItem = (m_count > 0) ? &(*m_data)[m_data->size()-1] : NULL;
         ParseInner(tag);
-        m_Level--;
-        return TRUE;
+        m_level--;
+        m_parentItem = oldparent;
+        return true;
     }
     else if (tag.GetName() == wxT("OBJECT"))
     {
-        m_Name = m_Page = wxEmptyString;
+        m_name = m_page = wxEmptyString;
         ParseInner(tag);
 
 #if 0
-         if (!m_Page.IsEmpty())
+         if (!page.IsEmpty())
         /* Valid HHW's file may contain only two object tags:
 
            <OBJECT type="text/site properties">
@@ -143,60 +213,39 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
                <param name="Local" value="another.htm">
            </OBJECT>
 
-           We're interested in the latter. !m_Page.IsEmpty() is valid
+           We're interested in the latter. !page.IsEmpty() is valid
            condition because text/site properties does not contain Local param
         */
 #endif
         if (tag.GetParam(wxT("TYPE")) == wxT("text/sitemap"))
         {
-            if (m_ItemsCnt % wxHTML_REALLOC_STEP == 0)
-                m_Items = (wxHtmlContentsItem*) realloc(m_Items,
-                                       (m_ItemsCnt + wxHTML_REALLOC_STEP) *
-                                       sizeof(wxHtmlContentsItem));
-
-            m_Items[m_ItemsCnt].m_Level = m_Level;
-            m_Items[m_ItemsCnt].m_ID = m_ID;
-            m_Items[m_ItemsCnt].m_Page = new wxChar[m_Page.Length() + 1];
-            wxStrcpy(m_Items[m_ItemsCnt].m_Page, m_Page.c_str());
-            m_Items[m_ItemsCnt].m_Name = new wxChar [m_Name.Length() + 1];
-            wxStrcpy(m_Items[m_ItemsCnt].m_Name, m_Name.c_str());
-            m_Items[m_ItemsCnt].m_Book = m_Book;
-            m_ItemsCnt++;
+            wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem();
+            item->parent = m_parentItem;
+            item->level = m_level;
+            item->id = m_id;
+            item->page = m_page;
+            item->name = m_name;
+
+            item->book = m_book;
+            m_data->Add(item);
+            m_count++;
         }
 
-        return TRUE;
+        return true;
     }
     else
     { // "PARAM"
-        if (m_Name == wxEmptyString && tag.GetParam(wxT("NAME")) == wxT("Name"))
-            m_Name = tag.GetParam(wxT("VALUE"));
+        if (m_name.empty() && tag.GetParam(wxT("NAME")) == wxT("Name"))
+            m_name = tag.GetParam(wxT("VALUE"));
         if (tag.GetParam(wxT("NAME")) == wxT("Local"))
-            m_Page = tag.GetParam(wxT("VALUE"));
+            m_page = tag.GetParam(wxT("VALUE"));
         if (tag.GetParam(wxT("NAME")) == wxT("ID"))
-            tag.GetParamAsInt(wxT("VALUE"), &m_ID);
-        return FALSE;
+            tag.GetParamAsInt(wxT("VALUE"), &m_id);
+        return false;
     }
 }
 
 
-
-void HP_TagHandler::WriteOut(wxHtmlContentsItem*& array, int& size)
-{
-    array = m_Items;
-    size = m_ItemsCnt;
-    m_Items = NULL;
-    m_ItemsCnt = 0;
-}
-
-void HP_TagHandler::ReadIn(wxHtmlContentsItem* array, int size)
-{
-    m_Items = array;
-    m_ItemsCnt = size;
-}
-
-
-
-
 //-----------------------------------------------------------------------------
 // wxHtmlHelpData
 //-----------------------------------------------------------------------------
@@ -209,50 +258,40 @@ wxString wxHtmlBookRecord::GetFullPath(const wxString &page) const
         return m_BasePath + page;
 }
 
+wxString wxHtmlHelpDataItem::GetIndentedName() const
+{
+    wxString s;
+    for (int i = 1; i < level; i++)
+        s << _T("   ");
+    s << name;
+    return s;
+}
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpData, wxObject)
 
 wxHtmlHelpData::wxHtmlHelpData()
 {
-    m_TempPath = wxEmptyString;
-
-    m_Contents = NULL;
-    m_ContentsCnt = 0;
-    m_Index = NULL;
-    m_IndexCnt = 0;
+#if WXWIN_COMPATIBILITY_2_4
+    m_cacheContents = NULL;
+    m_cacheIndex = NULL;
+#endif
 }
 
 wxHtmlHelpData::~wxHtmlHelpData()
 {
-    int i;
-
-    m_BookRecords.Empty();
-    if (m_Contents)
-    {
-        for (i = 0; i < m_ContentsCnt; i++)
-        {
-            delete[] m_Contents[i].m_Page;
-            delete[] m_Contents[i].m_Name;
-        }
-        free(m_Contents);
-    }
-    if (m_Index)
-    {
-        for (i = 0; i < m_IndexCnt; i++)
-        {
-            delete[] m_Index[i].m_Page;
-            delete[] m_Index[i].m_Name;
-        }
-        free(m_Index);
-    }
+#if WXWIN_COMPATIBILITY_2_4
+    CleanCompatibilityData();
+#endif
 }
 
-bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, const wxString& indexfile, const wxString& contentsfile)
+bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
+                                   const wxString& indexfile,
+                                   const wxString& contentsfile)
 {
     wxFSFile *f;
-    char *buf;
-    int sz;
+    wxHtmlFilterHTML filter;
+    wxString buf;
     wxString string;
 
     HP_Parser parser;
@@ -262,39 +301,33 @@ bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, c
     f = ( contentsfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(contentsfile) );
     if (f)
     {
-        sz = f->GetStream()->GetSize();
-        buf = new char[sz + 1];
-        buf[sz] = 0;
-        f->GetStream()->Read(buf, sz);
+        buf.clear();
+        buf = filter.ReadFile(*f);
         delete f;
-        handler->ReadIn(m_Contents, m_ContentsCnt);
+        handler->Reset(m_contents);
         parser.Parse(buf);
-        handler->WriteOut(m_Contents, m_ContentsCnt);
-        delete[] buf;
     }
     else
+    {
         wxLogError(_("Cannot open contents file: %s"), contentsfile.c_str());
+    }
 
     f = ( indexfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(indexfile) );
     if (f)
     {
-        sz = f->GetStream()->GetSize();
-        buf = new char[sz + 1];
-        buf[sz] = 0;
-        f->GetStream()->Read(buf, sz);
+        buf.clear();
+        buf = filter.ReadFile(*f);
         delete f;
-        handler->ReadIn(m_Index, m_IndexCnt);
+        handler->Reset(m_index);
         parser.Parse(buf);
-        handler->WriteOut(m_Index, m_IndexCnt);
-        delete[] buf;
     }
     else if (!indexfile.IsEmpty())
+    {
         wxLogError(_("Cannot open index file: %s"), indexfile.c_str());
-    return TRUE;
+    }
+    return true;
 }
 
-
-
 inline static void CacheWriteInt32(wxOutputStream *f, wxInt32 value)
 {
     wxInt32 x = wxINT32_SWAP_ON_BE(value);
@@ -308,27 +341,32 @@ inline static wxInt32 CacheReadInt32(wxInputStream *f)
     return wxINT32_SWAP_ON_BE(x);
 }
 
-inline static void CacheWriteString(wxOutputStream *f, const wxChar *str)
+inline static void CacheWriteString(wxOutputStream *f, const wxString& str)
 {
-    size_t len = wxStrlen(str)+1;
+    const wxWX2MBbuf mbstr = str.mb_str(wxConvUTF8);
+    size_t len = strlen((const char*)mbstr)+1;
     CacheWriteInt32(f, len);
-    f->Write(str, len * sizeof(wxChar));
+    f->Write((const char*)mbstr, len);
 }
 
-inline static wxChar *CacheReadString(wxInputStream *f)
+inline static wxString CacheReadString(wxInputStream *f)
 {
-    wxChar *str;
     size_t len = (size_t)CacheReadInt32(f);
-    str = new wxChar[len];
-    f->Read(str, len * sizeof(wxChar));
-    return str;
+    wxCharBuffer str(len-1);
+    f->Read(str.data(), len);
+    return wxString(str, wxConvUTF8);
 }
 
-#define CURRENT_CACHED_BOOK_VERSION     2
+#define CURRENT_CACHED_BOOK_VERSION     5
+
+// Additional flags to detect incompatibilities of the runtime environment:
+#define CACHED_BOOK_FORMAT_FLAGS \
+                     (wxUSE_UNICODE << 0)
+
 
 bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f)
 {
-    int i, st;
+    int i, st, newsize;
     wxInt32 version;
 
     /* load header - version info : */
@@ -336,40 +374,48 @@ bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f)
 
     if (version != CURRENT_CACHED_BOOK_VERSION)
     {
-        // NB: We can just silently return FALSE here and don't worry about
+        // NB: We can just silently return false here and don't worry about
         //     it anymore, because AddBookParam will load the MS project in
-        //     absence of (properly versioned) .cached file and automatically 
+        //     absence of (properly versioned) .cached file and automatically
         //     create new .cached file immediately afterward.
-        return FALSE;
+        return false;
     }
 
+    if (CacheReadInt32(f) != CACHED_BOOK_FORMAT_FLAGS)
+        return false;
+
     /* load contents : */
-    st = m_ContentsCnt;
-    m_ContentsCnt += CacheReadInt32(f);
-    m_Contents = (wxHtmlContentsItem*) realloc(m_Contents,
-                                               (m_ContentsCnt / wxHTML_REALLOC_STEP + 1) *
-                                               wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
-    for (i = st; i < m_ContentsCnt; i++)
+    st = m_contents.size();
+    newsize = st + CacheReadInt32(f);
+    m_contents.Alloc(newsize);
+    for (i = st; i < newsize; i++)
     {
-        m_Contents[i].m_Level = CacheReadInt32(f);
-        m_Contents[i].m_ID = CacheReadInt32(f);
-        m_Contents[i].m_Name = CacheReadString(f);
-        m_Contents[i].m_Page = CacheReadString(f);
-        m_Contents[i].m_Book = book;
+        wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem;
+        item->level = CacheReadInt32(f);
+        item->id = CacheReadInt32(f);
+        item->name = CacheReadString(f);
+        item->page = CacheReadString(f);
+        item->book = book;
+        m_contents.Add(item);
     }
 
     /* load index : */
-    st = m_IndexCnt;
-    m_IndexCnt += CacheReadInt32(f);
-    m_Index = (wxHtmlContentsItem*) realloc(m_Index, (m_IndexCnt / wxHTML_REALLOC_STEP + 1) *
-                                                     wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
-    for (i = st; i < m_IndexCnt; i++)
+    st = m_index.size();
+    newsize = st + CacheReadInt32(f);
+    m_index.Alloc(newsize);
+    for (i = st; i < newsize; i++)
     {
-        m_Index[i].m_Name = CacheReadString(f);
-        m_Index[i].m_Page = CacheReadString(f);
-        m_Index[i].m_Book = book;
+        wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem;
+        item->name = CacheReadString(f);
+        item->page = CacheReadString(f);
+        item->level = CacheReadInt32(f);
+        item->book = book;
+        int parentShift = CacheReadInt32(f);
+        if (parentShift != 0)
+            item->parent = &m_index[m_index.size() - parentShift];
+        m_index.Add(item);
     }
-    return TRUE;
+    return true;
 }
 
 
@@ -380,50 +426,74 @@ bool wxHtmlHelpData::SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f)
 
     /* save header - version info : */
     CacheWriteInt32(f, CURRENT_CACHED_BOOK_VERSION);
+    CacheWriteInt32(f, CACHED_BOOK_FORMAT_FLAGS);
 
     /* save contents : */
-    for (cnt = 0, i = 0; i < m_ContentsCnt; i++) 
-        if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0)
+    int len = m_contents.size();
+    for (cnt = 0, i = 0; i < len; i++)
+        if (m_contents[i].book == book && m_contents[i].level > 0)
             cnt++;
     CacheWriteInt32(f, cnt);
 
-    for (i = 0; i < m_ContentsCnt; i++)
+    for (i = 0; i < len; i++)
     {
-        if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0) 
+        if (m_contents[i].book != book || m_contents[i].level == 0)
             continue;
-        CacheWriteInt32(f, m_Contents[i].m_Level);
-        CacheWriteInt32(f, m_Contents[i].m_ID);
-        CacheWriteString(f, m_Contents[i].m_Name);
-        CacheWriteString(f, m_Contents[i].m_Page);
+        CacheWriteInt32(f, m_contents[i].level);
+        CacheWriteInt32(f, m_contents[i].id);
+        CacheWriteString(f, m_contents[i].name);
+        CacheWriteString(f, m_contents[i].page);
     }
 
     /* save index : */
-    for (cnt = 0, i = 0; i < m_IndexCnt; i++) 
-        if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0) 
+    len = m_index.size();
+    for (cnt = 0, i = 0; i < len; i++)
+        if (m_index[i].book == book && m_index[i].level > 0)
             cnt++;
     CacheWriteInt32(f, cnt);
 
-    for (i = 0; i < m_IndexCnt; i++)
+    for (i = 0; i < len; i++)
     {
-        if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0) 
+        if (m_index[i].book != book || m_index[i].level == 0)
             continue;
-        CacheWriteString(f, m_Index[i].m_Name);
-        CacheWriteString(f, m_Index[i].m_Page);
+        CacheWriteString(f, m_index[i].name);
+        CacheWriteString(f, m_index[i].page);
+        CacheWriteInt32(f, m_index[i].level);
+        // save distance to parent item, if any:
+        if (m_index[i].parent == NULL)
+        {
+            CacheWriteInt32(f, 0);
+        }
+        else
+        {
+            int cnt = 0;
+            wxHtmlHelpDataItem *parent = m_index[i].parent;
+            for (int j = i-1; j >= 0; j--)
+            {
+                if (m_index[j].book == book && m_index[j].level > 0)
+                    cnt++;
+                if (&m_index[j] == parent)
+                    break;
+            }
+            wxASSERT(cnt > 0);
+            CacheWriteInt32(f, cnt);
+        }
     }
-    return TRUE;
+    return true;
 }
 
 
 void wxHtmlHelpData::SetTempDir(const wxString& path)
 {
-    if (path == wxEmptyString) m_TempPath = path;
+    if (path.empty())
+        m_tempPath = path;
     else
     {
-        if (wxIsAbsolutePath(path)) m_TempPath = path;
-        else m_TempPath = wxGetCwd() + _T("/") + path;
+        if (wxIsAbsolutePath(path)) m_tempPath = path;
+        else m_tempPath = wxGetCwd() + _T("/") + path;
 
-        if (m_TempPath[m_TempPath.Length() - 1] != _T('/'))
-            m_TempPath << _T('/');
+        if (m_tempPath[m_tempPath.Length() - 1] != _T('/'))
+            m_tempPath << _T('/');
     }
 }
 
@@ -449,33 +519,32 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile,
     wxFSFile *fi;
     wxHtmlBookRecord *bookr;
 
-    int IndexOld = m_IndexCnt,
-        ContentsOld = m_ContentsCnt;
+    int IndexOld = m_index.size(),
+        ContentsOld = m_contents.size();
 
     if (!path.IsEmpty())
-        fsys.ChangePathTo(path, TRUE);
+        fsys.ChangePathTo(path, true);
 
-    size_t booksCnt = m_BookRecords.GetCount();
+    size_t booksCnt = m_bookRecords.GetCount();
     for (size_t i = 0; i < booksCnt; i++)
     {
-        if ( m_BookRecords[i].GetBookFile() == bookfile.GetLocation() )
-            return TRUE; // book is (was) loaded
+        if ( m_bookRecords[i].GetBookFile() == bookfile.GetLocation() )
+            return true; // book is (was) loaded
     }
 
     bookr = new wxHtmlBookRecord(bookfile.GetLocation(), fsys.GetPath(), title, deftopic);
-    
-    if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0)
-        m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem));
-    m_Contents[m_ContentsCnt].m_Level = 0;
-    m_Contents[m_ContentsCnt].m_ID = 0;
-    m_Contents[m_ContentsCnt].m_Page = new wxChar[deftopic.Length() + 1];
-    wxStrcpy(m_Contents[m_ContentsCnt].m_Page, deftopic.c_str());
-    m_Contents[m_ContentsCnt].m_Name = new wxChar [title.Length() + 1];
-    wxStrcpy(m_Contents[m_ContentsCnt].m_Name, title.c_str());
-    m_Contents[m_ContentsCnt].m_Book = bookr;
+
+    wxHtmlHelpDataItem *bookitem = new wxHtmlHelpDataItem;
+    bookitem->level = 0;
+    bookitem->id = 0;
+    bookitem->page = deftopic;
+    bookitem->name = title;
+    bookitem->book = bookr;
 
     // store the contents index for later
-    int cont_start = m_ContentsCnt++;
+    int cont_start = m_contents.size();
+
+    m_contents.Add(bookitem);
 
     // Try to find cached binary versions:
     // 1. save file as book, but with .hhp.cached extension
@@ -485,19 +554,23 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile,
     fi = fsys.OpenFile(bookfile.GetLocation() + wxT(".cached"));
 
     if (fi == NULL ||
+#if wxUSE_DATETIME
           fi->GetModificationTime() < bookfile.GetModificationTime() ||
+#endif // wxUSE_DATETIME
           !LoadCachedBook(bookr, fi->GetStream()))
     {
         if (fi != NULL) delete fi;
-        fi = fsys.OpenFile(m_TempPath + wxFileNameFromPath(bookfile.GetLocation()) + wxT(".cached"));
-        if (m_TempPath == wxEmptyString || fi == NULL ||
+        fi = fsys.OpenFile(m_tempPath + wxFileNameFromPath(bookfile.GetLocation()) + wxT(".cached"));
+        if (m_tempPath.empty() || fi == NULL ||
+#if wxUSE_DATETIME
             fi->GetModificationTime() < bookfile.GetModificationTime() ||
+#endif // wxUSE_DATETIME
             !LoadCachedBook(bookr, fi->GetStream()))
         {
             LoadMSProject(bookr, fsys, indexfile, contfile);
-            if (m_TempPath != wxEmptyString)
+            if (!m_tempPath.empty())
             {
-                wxFileOutputStream *outs = new wxFileOutputStream(m_TempPath +
+                wxFileOutputStream *outs = new wxFileOutputStream(m_tempPath +
                                                   SafeFileName(wxFileNameFromPath(bookfile.GetLocation())) + wxT(".cached"));
                 SaveCachedBook(bookr, outs);
                 delete outs;
@@ -508,122 +581,140 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile,
     if (fi != NULL) delete fi;
 
     // Now store the contents range
-    bookr->SetContentsRange(cont_start, m_ContentsCnt);
+    bookr->SetContentsRange(cont_start, m_contents.size());
 
-    // Convert encoding, if neccessary:
+#if wxUSE_WCHAR_T
+    // MS HTML Help files [written by MS HTML Help Workshop] are broken
+    // in that the data are iso-8859-1 (including HTML entities), but must
+    // be interpreted as being in language's windows charset. Correct the
+    // differences here and also convert to wxConvLocal in ANSI build
     if (encoding != wxFONTENCODING_SYSTEM)
     {
-        wxFontEncodingArray a = wxEncodingConverter::GetPlatformEquivalents(encoding);
-        if (a.GetCount() != 0 && a[0] != encoding)
+        #if wxUSE_UNICODE
+            #define CORRECT_STR(str, conv) \
+                str = wxString((str).mb_str(wxConvISO8859_1), conv)
+        #else
+            #define CORRECT_STR(str, conv) \
+                str = wxString((str).wc_str(conv), wxConvLocal)
+        #endif
+        wxCSConv conv(encoding);
+        size_t IndexCnt = m_index.size();
+        size_t ContentsCnt = m_contents.size();
+        size_t i;
+        for (i = IndexOld; i < IndexCnt; i++)
         {
-            int i;
-            wxEncodingConverter conv;
-            conv.Init(encoding, a[0]);
-
-            for (i = IndexOld; i < m_IndexCnt; i++)
-                conv.Convert(m_Index[i].m_Name);
-            for (i = ContentsOld; i < m_ContentsCnt; i++)
-                conv.Convert(m_Contents[i].m_Name);
+            CORRECT_STR(m_index[i].name, conv);
         }
+        for (i = ContentsOld; i < ContentsCnt; i++)
+        {
+            CORRECT_STR(m_contents[i].name, conv);
+        }
+        #undef CORRECT_STR
     }
+#else
+    wxUnusedVar(IndexOld);
+    wxUnusedVar(ContentsOld);
+    wxASSERT_MSG(encoding == wxFONTENCODING_SYSTEM, wxT("Help files need charset conversion, but wxUSE_WCHAR_T is 0"));
+#endif // wxUSE_WCHAR_T/!wxUSE_WCHAR_T
 
-    m_BookRecords.Add(bookr);
-    if (m_IndexCnt > 0)
-        qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), wxHtmlHelpIndexCompareFunc);
+    m_bookRecords.Add(bookr);
+    if (!m_index.empty())
+    {
+        m_index.Sort(wxHtmlHelpIndexCompareFunc);
+    }
 
-    return TRUE;
+    return true;
 }
 
 
 bool wxHtmlHelpData::AddBook(const wxString& book)
 {
-    if (book.Right(4).Lower() == wxT(".zip") ||
-        book.Right(4).Lower() == wxT(".htb") /*html book*/)
+    wxString extension(book.Right(4).Lower());
+    if (extension == wxT(".zip") ||
+#if wxUSE_LIBMSPACK
+        extension == wxT(".chm") /*compressed html help book*/ ||
+#endif
+        extension == wxT(".htb") /*html book*/)
     {
         wxFileSystem fsys;
         wxString s;
-        bool rt = FALSE;
+        bool rt = false;
+
+#if wxUSE_LIBMSPACK
+        if (extension == wxT(".chm"))
+            s = fsys.FindFirst(book + wxT("#chm:*.hhp"), wxFILE);
+        else
+#endif
+            s = fsys.FindFirst(book + wxT("#zip:*.hhp"), wxFILE);
 
-        s = fsys.FindFirst(book + wxT("#zip:") + wxT("*.hhp"), wxFILE);
         while (!s.IsEmpty())
         {
-            if (AddBook(s)) rt = TRUE;
+            if (AddBook(s)) rt = true;
             s = fsys.FindNext();
         }
 
         return rt;
     }
-    else
+
+    wxFSFile *fi;
+    wxFileSystem fsys;
+
+    wxString title = _("noname"),
+             safetitle,
+             start = wxEmptyString,
+             contents = wxEmptyString,
+             index = wxEmptyString,
+             charset = wxEmptyString;
+
+    fi = fsys.OpenFile(book);
+    if (fi == NULL)
     {
-        wxFSFile *fi;
-        wxFileSystem fsys;
-        wxInputStream *s;
-        wxString bookFull;
-
-        wxString title = _("noname"),
-                 safetitle,
-                 start = wxEmptyString,
-                 contents = wxEmptyString,
-                 index = wxEmptyString,
-                 charset = wxEmptyString;
-
-#if defined(__WXMAC__) && !defined(__DARWIN__)
-        if (wxIsAbsolutePath(book)) bookFull = book;
-        else bookFull = wxGetCwd() + book; // no slash or dot
-        wxFileName fn( bookFull );
-        bookFull = fn.GetFullPath( wxPATH_UNIX );
-#else
-        if (wxIsAbsolutePath(book)) bookFull = book;
-        else bookFull = wxGetCwd() + "/" + book;
-#endif
+        wxLogError(_("Cannot open HTML help book: %s"), book.c_str());
+        return false;
+    }
+    fsys.ChangePathTo(book);
 
-        fi = fsys.OpenFile(bookFull);
-        if (fi == NULL)
-        {
-            wxLogError(_("Cannot open HTML help book: %s"), bookFull.c_str());
-            return FALSE;
-        }
-        fsys.ChangePathTo(bookFull);
-        s = fi->GetStream();
+    const wxChar *lineptr;
+    wxChar linebuf[300];
+    wxString tmp;
+    wxHtmlFilterPlainText filter;
+    tmp = filter.ReadFile(*fi);
+    lineptr = tmp.c_str();
+
+    do
+    {
+        lineptr = ReadLine(lineptr, linebuf, 300);
+
+        for (wxChar *ch = linebuf; *ch != wxT('\0') && *ch != wxT('='); ch++)
+           *ch = (wxChar)wxTolower(*ch);
+
+        if (wxStrstr(linebuf, _T("title=")) == linebuf)
+            title = linebuf + wxStrlen(_T("title="));
+        if (wxStrstr(linebuf, _T("default topic=")) == linebuf)
+            start = linebuf + wxStrlen(_T("default topic="));
+        if (wxStrstr(linebuf, _T("index file=")) == linebuf)
+            index = linebuf + wxStrlen(_T("index file="));
+        if (wxStrstr(linebuf, _T("contents file=")) == linebuf)
+            contents = linebuf + wxStrlen(_T("contents file="));
+        if (wxStrstr(linebuf, _T("charset=")) == linebuf)
+            charset = linebuf + wxStrlen(_T("charset="));
+    } while (lineptr != NULL);
+
+    wxFontEncoding enc = wxFONTENCODING_SYSTEM;
+#if wxUSE_FONTMAP
+    if (charset != wxEmptyString)
+        enc = wxFontMapper::Get()->CharsetToEncoding(charset);
+#endif
 
-        int sz;
-        char *buff, *lineptr;
-        char linebuf[300];
+    bool rtval = AddBookParam(*fi, enc,
+                              title, contents, index, start, fsys.GetPath());
+    delete fi;
 
-        sz = s->GetSize();
-        buff = new char[sz + 1];
-        buff[sz] = 0;
-        s->Read(buff, sz);
-        lineptr = buff;
+#if WXWIN_COMPATIBILITY_2_4
+    CleanCompatibilityData();
+#endif
 
-        do 
-        {
-            lineptr = ReadLine(lineptr, linebuf, 300);
-            
-            for (char *ch = linebuf; *ch != '\0' && *ch != '='; ch++)
-               *ch = tolower(*ch);
-
-            if (strstr(linebuf, "title=") == linebuf)
-                title = linebuf + strlen("title=");
-            if (strstr(linebuf, "default topic=") == linebuf)
-                start = linebuf + strlen("default topic=");
-            if (strstr(linebuf, "index file=") == linebuf)
-                index = linebuf + strlen("index file=");
-            if (strstr(linebuf, "contents file=") == linebuf)
-                contents = linebuf + strlen("contents file=");
-            if (strstr(linebuf, "charset=") == linebuf)
-                charset = linebuf + strlen("charset=");
-        } while (lineptr != NULL);
-        delete[] buff;
-
-        wxFontEncoding enc;
-        if (charset == wxEmptyString) enc = wxFONTENCODING_SYSTEM;
-        else enc = wxTheFontMapper->CharsetToEncoding(charset);
-        bool rtval = AddBookParam(*fi, enc,
-                                  title, contents, index, start, fsys.GetPath());
-        delete fi;
-        return rtval;
-    }
+    return rtval;
 }
 
 wxString wxHtmlHelpData::FindPageByName(const wxString& x)
@@ -632,17 +723,16 @@ wxString wxHtmlHelpData::FindPageByName(const wxString& x)
     int i;
     wxFileSystem fsys;
     wxFSFile *f;
-    wxString url(wxEmptyString);
 
     /* 1. try to open given file: */
 
-    cnt = m_BookRecords.GetCount();
+    cnt = m_bookRecords.GetCount();
     for (i = 0; i < cnt; i++)
     {
-        f = fsys.OpenFile(m_BookRecords[i].GetFullPath(x));
+        f = fsys.OpenFile(m_bookRecords[i].GetFullPath(x));
         if (f)
         {
-            url = m_BookRecords[i].GetFullPath(x);
+            wxString url = m_bookRecords[i].GetFullPath(x);
             delete f;
             return url;
         }
@@ -653,58 +743,131 @@ wxString wxHtmlHelpData::FindPageByName(const wxString& x)
 
     for (i = 0; i < cnt; i++)
     {
-        if (m_BookRecords[i].GetTitle() == x)
-        {
-            url = m_BookRecords[i].GetFullPath(m_BookRecords[i].GetStart());
-            return url;
-        }
+        if (m_bookRecords[i].GetTitle() == x)
+            return m_bookRecords[i].GetFullPath(m_bookRecords[i].GetStart());
     }
 
     /* 3. try to find in contents: */
 
-    cnt = m_ContentsCnt;
+    cnt = m_contents.size();
     for (i = 0; i < cnt; i++)
     {
-        if (wxStrcmp(m_Contents[i].m_Name, x) == 0)
-        {
-            url = m_Contents[i].GetFullPath();
-            return url;
-        }
+        if (m_contents[i].name == x)
+            return m_contents[i].GetFullPath();
     }
 
 
     /* 4. try to find in index: */
 
-    cnt = m_IndexCnt;
+    cnt = m_index.size();
     for (i = 0; i < cnt; i++)
     {
-        if (wxStrcmp(m_Index[i].m_Name, x) == 0)
-        {
-            url = m_Index[i].GetFullPath();
-            return url;
-        }
+        if (m_index[i].name == x)
+            return m_index[i].GetFullPath();
     }
 
-    return url;
+    return wxEmptyString;
 }
 
 wxString wxHtmlHelpData::FindPageById(int id)
 {
-    int i;
-    wxString url(wxEmptyString);
-
-    for (i = 0; i < m_ContentsCnt; i++)
+    size_t cnt = m_contents.size();
+    for (size_t i = 0; i < cnt; i++)
     {
-        if (m_Contents[i].m_ID == id)
+        if (m_contents[i].id == id)
         {
-            url = m_Contents[i].GetFullPath();
-            return url;
+            return m_contents[i].GetFullPath();
         }
     }
 
-    return url;
+    return wxEmptyString;
+}
+
+#if WXWIN_COMPATIBILITY_2_4
+wxHtmlContentsItem::wxHtmlContentsItem()
+    : m_Level(0), m_ID(wxID_ANY), m_Name(NULL), m_Page(NULL), m_Book(NULL),
+      m_autofree(false)
+{
+}
+
+wxHtmlContentsItem::wxHtmlContentsItem(const wxHtmlHelpDataItem& d)
+{
+    m_autofree = true;
+    m_Level = d.level;
+    m_ID = d.id;
+    m_Name = wxStrdup(d.name.c_str());
+    m_Page = wxStrdup(d.page.c_str());
+    m_Book = d.book;
 }
 
+wxHtmlContentsItem& wxHtmlContentsItem::operator=(const wxHtmlContentsItem& d)
+{
+    if (m_autofree)
+    {
+        free(m_Name);
+        free(m_Page);
+    }
+    m_autofree = true;
+    m_Level = d.m_Level;
+    m_ID = d.m_ID;
+    m_Name = d.m_Name ? wxStrdup(d.m_Name) : NULL;
+    m_Page = d.m_Page ? wxStrdup(d.m_Page) : NULL;
+    m_Book = d.m_Book;
+    return *this;
+}
+
+wxHtmlContentsItem::~wxHtmlContentsItem()
+{
+    if (m_autofree)
+    {
+        free(m_Name);
+        free(m_Page);
+    }
+}
+
+wxHtmlContentsItem* wxHtmlHelpData::GetContents()
+{
+    if (!m_cacheContents && !m_contents.empty())
+    {
+        size_t len = m_contents.size();
+        m_cacheContents = new wxHtmlContentsItem[len];
+        for (size_t i = 0; i < len; i++)
+            m_cacheContents[i] = m_contents[i];
+    }
+    return m_cacheContents;
+}
+
+int wxHtmlHelpData::GetContentsCnt()
+{
+    return m_contents.size();
+}
+
+wxHtmlContentsItem* wxHtmlHelpData::GetIndex()
+{
+    if (!m_cacheContents && !m_index.empty())
+    {
+        size_t len = m_index.size();
+        m_cacheContents = new wxHtmlContentsItem[len];
+        for (size_t i = 0; i < len; i++)
+            m_cacheContents[i] = m_index[i];
+    }
+    return m_cacheContents;
+}
+
+int wxHtmlHelpData::GetIndexCnt()
+{
+    return m_index.size();
+}
+
+void wxHtmlHelpData::CleanCompatibilityData()
+{
+    delete[] m_cacheContents;
+    m_cacheContents = NULL;
+    delete[] m_cacheIndex;
+    m_cacheIndex = NULL;
+}
+#endif // WXWIN_COMPATIBILITY_2_4
+
 //----------------------------------------------------------------------------------
 // wxHtmlSearchStatus functions
 //----------------------------------------------------------------------------------
@@ -719,11 +882,11 @@ wxHtmlSearchStatus::wxHtmlSearchStatus(wxHtmlHelpData* data, const wxString& key
     if (book != wxEmptyString)
     {
         // we have to search in a specific book. Find it first
-        int i, cnt = data->m_BookRecords.GetCount();
+        int i, cnt = data->m_bookRecords.GetCount();
         for (i = 0; i < cnt; i++)
-            if (data->m_BookRecords[i].GetTitle() == book)
+            if (data->m_bookRecords[i].GetTitle() == book)
             {
-                bookr = &(data->m_BookRecords[i]);
+                bookr = &(data->m_bookRecords[i]);
                 m_CurIndex = bookr->GetContentsStart();
                 m_MaxIndex = bookr->GetContentsEnd();
                 break;
@@ -735,55 +898,63 @@ wxHtmlSearchStatus::wxHtmlSearchStatus(wxHtmlHelpData* data, const wxString& key
     {
         // no book specified; search all books
         m_CurIndex = 0;
-        m_MaxIndex = m_Data->m_ContentsCnt;
+        m_MaxIndex = m_Data->m_contents.size();
     }
     m_Engine.LookFor(keyword, case_sensitive, whole_words_only);
     m_Active = (m_CurIndex < m_MaxIndex);
-    m_LastPage = NULL;
 }
 
+#if WXWIN_COMPATIBILITY_2_4
+wxHtmlContentsItem* wxHtmlSearchStatus::GetContentsItem()
+{
+    static wxHtmlContentsItem it;
+    it = wxHtmlContentsItem(*m_CurItem);
+    return &it;
+}
+#endif
+
 bool wxHtmlSearchStatus::Search()
 {
     wxFSFile *file;
     int i = m_CurIndex;  // shortcut
-    bool found = FALSE;
-    wxChar *thepage;
+    bool found = false;
+    wxString thepage;
 
     if (!m_Active)
     {
         // sanity check. Illegal use, but we'll try to prevent a crash anyway
         wxASSERT(m_Active);
-        return FALSE;
+        return false;
     }
 
     m_Name = wxEmptyString;
-    m_ContentsItem = NULL;
-    thepage = m_Data->m_Contents[i].m_Page;
+    m_CurItem = NULL;
+    thepage = m_Data->m_contents[i].page;
 
     m_Active = (++m_CurIndex < m_MaxIndex);
     // check if it is same page with different anchor:
-    if (m_LastPage != NULL)
+    if (!m_LastPage.empty())
     {
-        wxChar *p1, *p2;
-        for (p1 = thepage, p2 = m_LastPage;
+        const wxChar *p1, *p2;
+        for (p1 = thepage.c_str(), p2 = m_LastPage.c_str();
              *p1 != 0 && *p1 != _T('#') && *p1 == *p2; p1++, p2++) {}
 
         m_LastPage = thepage;
 
         if (*p1 == 0 || *p1 == _T('#'))
-            return FALSE;
+            return false;
     }
     else m_LastPage = thepage;
 
     wxFileSystem fsys;
-    file = fsys.OpenFile(m_Data->m_Contents[i].m_Book->GetFullPath(thepage));
+    file = fsys.OpenFile(m_Data->m_contents[i].book->GetFullPath(thepage));
     if (file)
     {
-        if (m_Engine.Scan(file->GetStream()))
+        if (m_Engine.Scan(*file))
         {
-            m_Name = m_Data->m_Contents[i].m_Name;
-            m_ContentsItem = m_Data->m_Contents + i;
-            found = TRUE;
+            m_Name = m_Data->m_contents[i].name;
+            m_CurItem = &m_Data->m_contents[i];
+            found = true;
         }
         delete file;
     }
@@ -798,46 +969,41 @@ bool wxHtmlSearchStatus::Search()
 
 
 //--------------------------------------------------------------------------------
-// wxSearchEngine
+// wxHtmlSearchEngine
 //--------------------------------------------------------------------------------
 
-void wxSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only)
+void wxHtmlSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only)
 {
     m_CaseSensitive = case_sensitive;
     m_WholeWords = whole_words_only;
-    if (m_Keyword) delete[] m_Keyword;
-    m_Keyword = new wxChar[keyword.Length() + 1];
-    wxStrcpy(m_Keyword, keyword.c_str());
+    m_Keyword = keyword;
 
     if (!m_CaseSensitive)
-    {
-        for (int i = wxStrlen(m_Keyword) - 1; i >= 0; i--)
-        {
-            if ((m_Keyword[i] >= wxT('A')) && (m_Keyword[i] <= wxT('Z')))
-                m_Keyword[i] += wxT('a') - wxT('A');
-        }
-    }
+        m_Keyword.LowerCase();
 }
 
 
+static inline bool WHITESPACE(wxChar c)
+{
+    return c == _T(' ') || c == _T('\n') || c == _T('\r') || c == _T('\t');
+}
 
-#define WHITESPACE(c)  (c == ' ' || c == '\n' || c == '\r' || c == '\t')
-
-bool wxSearchEngine::Scan(wxInputStream *stream)
+bool wxHtmlSearchEngine::Scan(const wxFSFile& file)
 {
-    wxASSERT_MSG(m_Keyword != NULL, wxT("wxSearchEngine::LookFor must be called before scanning!"));
+    wxASSERT_MSG(!m_Keyword.empty(), wxT("wxHtmlSearchEngine::LookFor must be called before scanning!"));
 
     int i, j;
-    int lng = stream ->GetSize();
-    int wrd = wxStrlen(m_Keyword);
-    bool found = FALSE;
-    char *buf = new char[lng + 1];
-    stream->Read(buf, lng);
-    buf[lng] = 0;
+    int wrd = m_Keyword.Length();
+    bool found = false;
+    wxHtmlFilterHTML filter;
+    wxString tmp = filter.ReadFile(file);
+    int lng = tmp.length();
+    const wxChar *buf = tmp.c_str();
 
     if (!m_CaseSensitive)
-        for (i = 0; i < lng; i++)
-            if ((buf[i] >= 'A') && (buf[i] <= 'Z')) buf[i] += 'a' - 'A';
+        tmp.LowerCase();
+
+    const wxChar *kwd = m_Keyword.c_str();
 
     if (m_WholeWords)
     {
@@ -845,8 +1011,8 @@ bool wxSearchEngine::Scan(wxInputStream *stream)
         {
             if (WHITESPACE(buf[i])) continue;
             j = 0;
-            while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++;
-            if (j == wrd && WHITESPACE(buf[i + j])) { found = TRUE; break; }
+            while ((j < wrd) && (buf[i + j] == kwd[j])) j++;
+            if (j == wrd && WHITESPACE(buf[i + j])) { found = true; break; }
         }
     }
 
@@ -855,12 +1021,11 @@ bool wxSearchEngine::Scan(wxInputStream *stream)
         for (i = 0; i < lng - wrd; i++)
         {
             j = 0;
-            while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++;
-            if (j == wrd) { found = TRUE; break; }
+            while ((j < wrd) && (buf[i + j] == kwd[j])) j++;
+            if (j == wrd) { found = true; break; }
         }
     }
 
-    delete[] buf;
     return found;
 }