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 #include "wx/defs.h"
  16
  17 #if wxUSE_HTML
  18
  19 #include "wx/object.h"
  20 #include "wx/string.h"
  21 #include "wx/filesys.h"
  22 #include "wx/dynarray.h"
  23 #include "wx/font.h"
  24
  25 class WXDLLIMPEXP_FWD_HTML wxHtmlHelpData;
  26
  27 //--------------------------------------------------------------------------------
  28 // helper classes & structs
  29 //--------------------------------------------------------------------------------
  30
  31 class WXDLLIMPEXP_HTML wxHtmlBookRecord
  32 {
  33 public:
  34     wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath,
  35                      const wxString& title, const wxString& start)
  36     {
  37         m_BookFile = bookfile;
  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 GetBookFile() const { return m_BookFile; }
  45     wxString GetTitle() const { return m_Title; }
  46     wxString GetStart() const { return m_Start; }
  47     wxString GetBasePath() const { return m_BasePath; }
  48     /* SetContentsRange: store in the bookrecord where in the index/contents lists the
  49      * book's records are stored. This to facilitate searching in a specific book.
  50      * This code will have to be revised when loading/removing books becomes dynamic.
  51      * (as opposed to appending only)
  52      * Note that storing index range is pointless, because the index is alphab. sorted. */
  53     void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; }
  54     int GetContentsStart() const { return m_ContentsStart; }
  55     int GetContentsEnd() const { return m_ContentsEnd; }
  56
  57     void SetTitle(const wxString& title) { m_Title = title; }
  58     void SetBasePath(const wxString& path) { m_BasePath = path; }
  59     void SetStart(const wxString& start) { m_Start = start; }
  60
  61     // returns full filename of page (which is part of the book),
  62     // i.e. with book's basePath prepended. If page is already absolute
  63     // path, basePath is _not_ prepended.
  64     wxString GetFullPath(const wxString &page) const;
  65
  66 protected:
  67     wxString m_BookFile;
  68     wxString m_BasePath;
  69     wxString m_Title;
  70     wxString m_Start;
  71     int m_ContentsStart;
  72     int m_ContentsEnd;
  73 };
  74
  75
  76 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray,
  77                                   WXDLLIMPEXP_HTML);
  78
  79 struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem
  80 {
  81     wxHtmlHelpDataItem() : level(0), parent(NULL), id(wxID_ANY), book(NULL) {}
  82
  83     int level;
  84     wxHtmlHelpDataItem *parent;
  85     int id;
  86     wxString name;
  87     wxString page;
  88     wxHtmlBookRecord *book;
  89
  90     // returns full filename of m_Page, i.e. with book's basePath prepended
  91     wxString GetFullPath() const { return book->GetFullPath(page); }
  92
  93     // returns item indented with spaces if it has level>1:
  94     wxString GetIndentedName() const;
  95 };
  96
  97 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems,
  98                                   WXDLLIMPEXP_HTML);
  99
 100
 101 //------------------------------------------------------------------------------
 102 // wxHtmlSearchEngine
 103 //                  This class takes input streams and scans them for occurrence
 104 //                  of keyword(s)
 105 //------------------------------------------------------------------------------
 106
 107 class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject
 108 {
 109 public:
 110     wxHtmlSearchEngine() : wxObject() {}
 111     virtual ~wxHtmlSearchEngine() {}
 112
 113     // Sets the keyword we will be searching for
 114     virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only);
 115
 116     // Scans the stream for the keyword.
 117     // Returns true if the stream contains keyword, fALSE otherwise
 118     virtual bool Scan(const wxFSFile& file);
 119
 120 private:
 121     wxString m_Keyword;
 122     bool m_CaseSensitive;
 123     bool m_WholeWords;
 124
 125     wxDECLARE_NO_COPY_CLASS(wxHtmlSearchEngine);
 126 };
 127
 128
 129 // State information of a search action. I'd have preferred to make this a
 130 // nested class inside wxHtmlHelpData, but that's against coding standards :-(
 131 // Never construct this class yourself, obtain a copy from
 132 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
 133 class WXDLLIMPEXP_HTML wxHtmlSearchStatus
 134 {
 135 public:
 136     // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
 137     // title of the book to search. By default, all books are searched.
 138     wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
 139                        bool case_sensitive, bool whole_words_only,
 140                        const wxString& book = wxEmptyString);
 141     bool Search();  // do the next iteration
 142     bool IsActive() { return m_Active; }
 143     int GetCurIndex() { return m_CurIndex; }
 144     int GetMaxIndex() { return m_MaxIndex; }
 145     const wxString& GetName() { return m_Name; }
 146
 147     const wxHtmlHelpDataItem *GetCurItem() const { return m_CurItem; }
 148
 149 private:
 150     wxHtmlHelpData* m_Data;
 151     wxHtmlSearchEngine m_Engine;
 152     wxString m_Keyword, m_Name;
 153     wxString m_LastPage;
 154     wxHtmlHelpDataItem* m_CurItem;
 155     bool m_Active;   // search is not finished
 156     int m_CurIndex;  // where we are now
 157     int m_MaxIndex;  // number of files we search
 158     // For progress bar: 100*curindex/maxindex = % complete
 159
 160     wxDECLARE_NO_COPY_CLASS(wxHtmlSearchStatus);
 161 };
 162
 163 class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject
 164 {
 165     DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
 166     friend class wxHtmlSearchStatus;
 167
 168 public:
 169     wxHtmlHelpData();
 170     virtual ~wxHtmlHelpData();
 171
 172     // Sets directory where temporary files are stored.
 173     // These temp files are index & contents file in binary (much faster to read)
 174     // form. These files are NOT deleted on program's exit.
 175     void SetTempDir(const wxString& path);
 176
 177     // Adds new book. 'book' is location of .htb file (stands for "html book").
 178     // See documentation for details on its format.
 179     // Returns success.
 180     bool AddBook(const wxString& book);
 181     bool AddBookParam(const wxFSFile& bookfile,
 182                       wxFontEncoding encoding,
 183                       const wxString& title, const wxString& contfile,
 184                       const wxString& indexfile = wxEmptyString,
 185                       const wxString& deftopic = wxEmptyString,
 186                       const wxString& path = wxEmptyString);
 187
 188     // Some accessing stuff:
 189
 190     // returns URL of page on basis of (file)name
 191     wxString FindPageByName(const wxString& page);
 192     // returns URL of page on basis of MS id
 193     wxString FindPageById(int id);
 194
 195     const wxHtmlBookRecArray& GetBookRecArray() const { return m_bookRecords; }
 196
 197     const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; }
 198     const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; }
 199
 200 protected:
 201     wxString m_tempPath;
 202
 203     // each book has one record in this array:
 204     wxHtmlBookRecArray m_bookRecords;
 205
 206     wxHtmlHelpDataItems m_contents; // list of all available books and pages
 207     wxHtmlHelpDataItems m_index; // list of index itesm
 208
 209 protected:
 210     // Imports .hhp files (MS HTML Help Workshop)
 211     bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
 212                        const wxString& indexfile, const wxString& contentsfile);
 213     // Reads binary book
 214     bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);
 215     // Writes binary book
 216     bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
 217
 218     wxDECLARE_NO_COPY_CLASS(wxHtmlHelpData);
 219 };
 220
 221 #endif
 222
 223 #endif