New HTML help system. The old controller class has been split in

three parts; basic data, a frame and a controller. Docs will appear
shortly...

All Makefiles should be correctly updated. To be sure, I put an
#error pragma in the old files, which will be removed in a few days.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3620 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/html/helpdata.h

@@ -0,0 +1,192 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        helpdata.h
+// Purpose:     wxHtmlHelpData
+// Notes:       Based on htmlhelp.cpp, implementing a monolithic 
+//              HTML Help controller class,  by Vaclav Slavik
+// Author:      Harm van der Heijden and Vaclav Slavik
+// Created:
+// RCS-ID:
+// Copyright:   (c) Harm van der Heijden and Vaclav Slavik
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_HELPDATA_H_
+#define _WX_HELPDATA_H_
+
+#ifdef __GNUG__
+#pragma interface "helpdata.h"
+#endif
+
+#include "wx/defs.h"
+
+#if wxUSE_HTML
+
+#include "wx/object.h"
+#include "wx/string.h"
+#include "wx/filesys.h"
+#include "wx/dynarray.h"
+
+//--------------------------------------------------------------------------------
+// helper classes & structs
+//--------------------------------------------------------------------------------
+
+class WXDLLEXPORT wxHtmlBookRecord : public wxObject
+{
+public:
+    wxHtmlBookRecord(const wxString& basepath, const wxString& title, 
+		     const wxString& start) {
+	m_BasePath = basepath; m_Title = title; m_Start = start;
+	// for debugging, give the contents index obvious default values
+	contents_start = contents_end = -1;
+    }
+    wxString GetTitle() const {return m_Title;}
+    wxString GetStart() const {return m_Start;}
+    wxString GetBasePath() const {return m_BasePath;}
+    /* SetContentsRange: store in the bookrecord where in the index/contents lists the
+     * book's records are stored. This to facilitate searching in a specific book.
+     * This code will have to be revised when loading/removing books becomes dynamic.
+     * (as opposed to appending only) 
+     * Note that storing index range is pointless, because the index is alphab. sorted. */
+    void SetContentsRange(int start, int end) { contents_start = start; contents_end = end; }
+    GetContentsStart() const { return contents_start; }
+    GetContentsEnd() const { return contents_end; }
+protected:
+    wxString m_BasePath;
+    wxString m_Title;
+    wxString m_Start;
+    int contents_start;
+    int contents_end;
+};
+
+
+#undef WXDLLEXPORTLOCAL
+#define WXDLLEXPORTLOCAL WXDLLEXPORT
+     // ?? Don't know why - but Allen Van Sickel reported it to fix problems with DLL
+WX_DECLARE_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray);
+
+#undef WXDLLEXPORTLOCAL
+#define WXDLLEXPORTLOCAL
+
+
+typedef struct
+{
+    short int m_Level;
+    int m_ID;
+    char* m_Name;
+    char* m_Page;
+    wxHtmlBookRecord *m_Book;
+} wxHtmlContentsItem;
+
+//------------------------------------------------------------------------------
+// wxSearchEngine
+//                  This class takes input streams and scans them for occurence
+//                  of keyword(s)
+//------------------------------------------------------------------------------
+class wxSearchEngine : public wxObject
+{
+private:
+    char *m_Keyword;
+
+public:
+    wxSearchEngine() : wxObject() {m_Keyword = NULL;}
+    ~wxSearchEngine() {if (m_Keyword) free(m_Keyword);}
+    
+    virtual void LookFor(const wxString& keyword);
+    // Sets the keyword we will be searching for
+
+    virtual bool Scan(wxInputStream *stream);
+    // Scans the stream for the keyword.
+    // Returns TRUE if the stream contains keyword, fALSE otherwise
+};
+
+class wxHtmlHelpData;
+
+// State information of a search action. I'd have prefered to make this a nested
+// class inside wxHtmlHelpData, but that's against coding standards :-(
+// Never construct this class yourself, obtain a copy from 
+// wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
+class WXDLLEXPORT wxHtmlSearchStatus
+{
+public:
+    // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
+    // title of the book to search. By default, all books are searched.
+    wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
+		       const wxString& book = wxEmptyString);
+    bool Search(); // do the next iteration
+    bool IsActive() { return m_Active; }
+    int GetCurIndex() { return m_CurIndex; }
+    int GetMaxIndex() { return m_MaxIndex; }
+    const wxString& GetName() { return m_Name; }
+    wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
+private:
+    wxHtmlHelpData* m_Data;
+    wxSearchEngine m_Engine;
+    wxString m_Keyword, m_Name, m_LastPage;
+    wxHtmlContentsItem* m_ContentsItem; 
+    bool m_Active; // search is not finished
+    int m_CurIndex; // where we are now
+    int m_MaxIndex; // number of files we search 
+    // For progress bar: 100*curindex/maxindex = % complete
+};
+
+class WXDLLEXPORT wxHtmlHelpData : public wxObject
+{
+    DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
+
+    friend class wxHtmlSearchStatus;
+
+public:
+    wxHtmlHelpData();
+    ~wxHtmlHelpData();
+    
+    void SetTempDir(const wxString& path);
+    // Sets directory where temporary files are stored.
+    // These temp files are index & contents file in binary (much faster to read)
+    // form. These files are NOT deleted on program's exit.
+    
+    bool AddBook(const wxString& book);
+    // Adds new book. 'book' is location of .htb file (stands for "html book").
+    // See documentation for details on its format.
+    // Returns success.
+    bool AddBookParam(const wxString& title, const wxString& contfile, 
+		      const wxString& indexfile=wxEmptyString, 
+		      const wxString& deftopic=wxEmptyString, 
+		      const wxString& path=wxEmptyString);
+    
+    // Some accessing stuff
+    wxString FindPageByName(const wxString& page);
+    // returns URL of page on basis of (file)name
+    wxString FindPageById(int id);
+    // returns URL of page on basis of MS id
+
+    const wxHtmlBookRecArray& GetBookRecArray() { return m_BookRecords; }
+    wxHtmlContentsItem* GetContents() { return m_Contents; }
+    int GetContentsCnt() { return m_ContentsCnt; }
+    wxHtmlContentsItem* GetIndex() { return m_Index; }
+    int GetIndexCnt() { return m_IndexCnt; }
+    
+protected:
+    wxString m_TempPath;
+    
+    wxHtmlBookRecArray m_BookRecords;
+    // each book has one record in this array
+    wxHtmlContentsItem* m_Contents;
+    int m_ContentsCnt;
+    // list of all available books and pages.
+    wxHtmlContentsItem* m_Index;
+    int m_IndexCnt;
+    // list of index items
+    
+protected:
+    bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, 
+		       const wxString& indexfile, const wxString& contentsfile);
+    // Imports .hhp files (MS HTML Help Workshop)
+    bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);
+    // Reads binary book
+    bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
+    // Writes binary book
+};
+
+#endif
+
+#endif