include/wx/html/helpdata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpdata.h
   3 // Purpose:     wxHtmlHelpData
   4 // Notes:       Based on htmlhelp.cpp, implementing a monolithic
   5 //              HTML Help controller class,  by Vaclav Slavik
   6 // Author:      Harm van der Heijden and Vaclav Slavik
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Harm van der Heijden and Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPDATA_H_
  13 #define _WX_HELPDATA_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_HTML
  22
  23 #include "wx/object.h"
  24 #include "wx/string.h"
  25 #include "wx/filesys.h"
  26 #include "wx/dynarray.h"
  27
  28 //--------------------------------------------------------------------------------
  29 // helper classes & structs
  30 //--------------------------------------------------------------------------------
  31
  32 class WXDLLEXPORT wxHtmlBookRecord : public wxObject
  33 {
  34     public:
  35         wxHtmlBookRecord(const wxString& basepath, const wxString& title,
  36                          const wxString& start)
  37         {
  38             m_BasePath = basepath;
  39             m_Title = title;
  40             m_Start = start;
  41             // for debugging, give the contents index obvious default values
  42             m_ContentsStart = m_ContentsEnd = -1;
  43         }
  44         wxString GetTitle() const { return m_Title; }
  45         wxString GetStart() const { return m_Start; }
  46         wxString GetBasePath() const { return m_BasePath; }
  47         /* SetContentsRange: store in the bookrecord where in the index/contents lists the
  48          * book's records are stored. This to facilitate searching in a specific book.
  49          * This code will have to be revised when loading/removing books becomes dynamic.
  50          * (as opposed to appending only)
  51          * Note that storing index range is pointless, because the index is alphab. sorted. */
  52         void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; }
  53         int GetContentsStart() const { return m_ContentsStart; }
  54         int GetContentsEnd() const { return m_ContentsEnd; }
  55
  56     protected:
  57         wxString m_BasePath;
  58         wxString m_Title;
  59         wxString m_Start;
  60         int m_ContentsStart;
  61         int m_ContentsEnd;
  62 };
  63
  64
  65 WX_DECLARE_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray);
  66
  67
  68 typedef struct
  69 {
  70     short int m_Level;
  71     int m_ID;
  72     wxChar* m_Name;
  73     wxChar* m_Page;
  74     wxHtmlBookRecord *m_Book;
  75 }
  76 wxHtmlContentsItem;
  77
  78 //------------------------------------------------------------------------------
  79 // wxSearchEngine
  80 //                  This class takes input streams and scans them for occurence
  81 //                  of keyword(s)
  82 //------------------------------------------------------------------------------
  83 class WXDLLEXPORT wxSearchEngine : public wxObject
  84 {
  85     private:
  86         wxChar *m_Keyword;
  87
  88     public:
  89         wxSearchEngine() : wxObject() {m_Keyword = NULL; }
  90         ~wxSearchEngine() {if (m_Keyword) free(m_Keyword); }
  91
  92         virtual void LookFor(const wxString& keyword);
  93         // Sets the keyword we will be searching for
  94
  95         virtual bool Scan(wxInputStream *stream);
  96         // Scans the stream for the keyword.
  97         // Returns TRUE if the stream contains keyword, fALSE otherwise
  98 }
  99 ;
 100
 101 class wxHtmlHelpData;
 102
 103 // State information of a search action. I'd have prefered to make this a nested
 104 // class inside wxHtmlHelpData, but that's against coding standards :-(
 105 // Never construct this class yourself, obtain a copy from
 106 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
 107 class WXDLLEXPORT wxHtmlSearchStatus
 108 {
 109     public:
 110         // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
 111         // title of the book to search. By default, all books are searched.
 112
 113         wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
 114                            const wxString& book = wxEmptyString);
 115         bool Search();  // do the next iteration
 116         bool IsActive() { return m_Active; }
 117         int GetCurIndex() { return m_CurIndex; }
 118         int GetMaxIndex() { return m_MaxIndex; }
 119         const wxString& GetName() { return m_Name; }
 120         wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
 121
 122     private:
 123         wxHtmlHelpData* m_Data;
 124         wxSearchEngine m_Engine;
 125         wxString m_Keyword, m_Name, m_LastPage;
 126         wxHtmlContentsItem* m_ContentsItem;
 127         bool m_Active;  // search is not finished
 128         int m_CurIndex;  // where we are now
 129         int m_MaxIndex;  // number of files we search
 130         // For progress bar: 100*curindex/maxindex = % complete
 131 }
 132 ;
 133
 134 class WXDLLEXPORT wxHtmlHelpData : public wxObject
 135 {
 136         DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
 137
 138         friend class wxHtmlSearchStatus;
 139
 140     public:
 141         wxHtmlHelpData();
 142         ~wxHtmlHelpData();
 143
 144         void SetTempDir(const wxString& path);
 145         // Sets directory where temporary files are stored.
 146         // These temp files are index & contents file in binary (much faster to read)
 147         // form. These files are NOT deleted on program's exit.
 148
 149         bool AddBook(const wxString& book);
 150         // Adds new book. 'book' is location of .htb file (stands for "html book").
 151         // See documentation for details on its format.
 152         // Returns success.
 153         bool AddBookParam(const wxString& title, const wxString& contfile,
 154                           const wxString& indexfile = wxEmptyString,
 155                           const wxString& deftopic = wxEmptyString,
 156                           const wxString& path = wxEmptyString);
 157
 158         // Some accessing stuff
 159         wxString FindPageByName(const wxString& page);
 160         // returns URL of page on basis of (file)name
 161         wxString FindPageById(int id);
 162         // returns URL of page on basis of MS id
 163
 164         const wxHtmlBookRecArray& GetBookRecArray() { return m_BookRecords; }
 165         wxHtmlContentsItem* GetContents() { return m_Contents; }
 166         int GetContentsCnt() { return m_ContentsCnt; }
 167         wxHtmlContentsItem* GetIndex() { return m_Index; }
 168         int GetIndexCnt() { return m_IndexCnt; }
 169
 170     protected:
 171         wxString m_TempPath;
 172
 173         wxHtmlBookRecArray m_BookRecords;
 174         // each book has one record in this array
 175         wxHtmlContentsItem* m_Contents;
 176         int m_ContentsCnt;
 177         // list of all available books and pages.
 178         wxHtmlContentsItem* m_Index;
 179         int m_IndexCnt;
 180         // list of index items
 181
 182     protected:
 183         bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
 184                            const wxString& indexfile, const wxString& contentsfile);
 185         // Imports .hhp files (MS HTML Help Workshop)
 186         bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);
 187         // Reads binary book
 188         bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
 189         // Writes binary book
 190 }
 191 ;
 192
 193 #endif
 194
 195 #endif