X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8ec2b48446fa4f17187dcd73c3a314e4030333f6..c21f7aa162dfc4ff910c67a9d6241557dab96075:/include/wx/html/helpdata.h diff --git a/include/wx/html/helpdata.h b/include/wx/html/helpdata.h index 22c3d7ccf7..a330095139 100644 --- a/include/wx/html/helpdata.h +++ b/include/wx/html/helpdata.h @@ -1,11 +1,10 @@ ///////////////////////////////////////////////////////////////////////////// // Name: helpdata.h // Purpose: wxHtmlHelpData -// Notes: Based on htmlhelp.cpp, implementing a monolithic +// 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: +// RCS-ID: $Id$ // Copyright: (c) Harm van der Heijden and Vaclav Slavik // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -13,10 +12,6 @@ #ifndef _WX_HELPDATA_H_ #define _WX_HELPDATA_H_ -#ifdef __GNUG__ -#pragma interface "helpdata.h" -#endif - #include "wx/defs.h" #if wxUSE_HTML @@ -25,166 +20,245 @@ #include "wx/string.h" #include "wx/filesys.h" #include "wx/dynarray.h" +#include "wx/font.h" + +class WXDLLIMPEXP_HTML wxHtmlHelpData; //-------------------------------------------------------------------------------- // helper classes & structs //-------------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlBookRecord : public wxObject +class WXDLLIMPEXP_HTML wxHtmlBookRecord { 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; + wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath, + const wxString& title, const wxString& start) + { + m_BookFile = bookfile; + m_BasePath = basepath; + m_Title = title; + m_Start = start; + // for debugging, give the contents index obvious default values + m_ContentsStart = m_ContentsEnd = -1; } - wxString GetTitle() const {return m_Title;} - wxString GetStart() const {return m_Start;} - wxString GetBasePath() const {return m_BasePath;} + wxString GetBookFile() const { return m_BookFile; } + 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) + * (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; } + void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; } + int GetContentsStart() const { return m_ContentsStart; } + int GetContentsEnd() const { return m_ContentsEnd; } + + void SetTitle(const wxString& title) { m_Title = title; } + void SetBasePath(const wxString& path) { m_BasePath = path; } + void SetStart(const wxString& start) { m_Start = start; } + + // returns full filename of page (which is part of the book), + // i.e. with book's basePath prepended. If page is already absolute + // path, basePath is _not_ prepended. + wxString GetFullPath(const wxString &page) const; + protected: + wxString m_BookFile; wxString m_BasePath; wxString m_Title; wxString m_Start; - int contents_start; - int contents_end; + int m_ContentsStart; + int m_ContentsEnd; }; -#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); +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray, + WXDLLIMPEXP_HTML); + +struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem +{ + wxHtmlHelpDataItem() : level(0), parent(NULL), id(wxID_ANY), book(NULL) {} -#undef WXDLLEXPORTLOCAL -#define WXDLLEXPORTLOCAL + int level; + wxHtmlHelpDataItem *parent; + int id; + wxString name; + wxString page; + wxHtmlBookRecord *book; + // returns full filename of m_Page, i.e. with book's basePath prepended + wxString GetFullPath() const { return book->GetFullPath(page); } -typedef struct + // returns item indented with spaces if it has level>1: + wxString GetIndentedName() const; +}; + +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems, + WXDLLIMPEXP_HTML); + +#if WXWIN_COMPATIBILITY_2_4 +// old interface to contents and index: +struct wxHtmlContentsItem { - short int m_Level; + wxHtmlContentsItem(); + wxHtmlContentsItem(const wxHtmlHelpDataItem& d); + wxHtmlContentsItem& operator=(const wxHtmlContentsItem& d); + ~wxHtmlContentsItem(); + + int m_Level; int m_ID; - char* m_Name; - char* m_Page; + wxChar *m_Name; + wxChar *m_Page; wxHtmlBookRecord *m_Book; -} wxHtmlContentsItem; + + // returns full filename of m_Page, i.e. with book's basePath prepended + wxString GetFullPath() const { return m_Book->GetFullPath(m_Page); } + +private: + bool m_autofree; +}; +#endif + //------------------------------------------------------------------------------ -// wxSearchEngine +// wxHtmlSearchEngine // This class takes input streams and scans them for occurence // of keyword(s) //------------------------------------------------------------------------------ -class wxSearchEngine : public wxObject -{ -private: - char *m_Keyword; +class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject +{ public: - wxSearchEngine() : wxObject() {m_Keyword = NULL;} - ~wxSearchEngine() {if (m_Keyword) free(m_Keyword);} - - virtual void LookFor(const wxString& keyword); + wxHtmlSearchEngine() : wxObject() {} + ~wxHtmlSearchEngine() {} + // Sets the keyword we will be searching for + virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only); - virtual bool Scan(wxInputStream *stream); // Scans the stream for the keyword. - // Returns TRUE if the stream contains keyword, fALSE otherwise + // Returns true if the stream contains keyword, fALSE otherwise + virtual bool Scan(const wxFSFile& file); + +private: + wxString m_Keyword; + bool m_CaseSensitive; + bool m_WholeWords; + + DECLARE_NO_COPY_CLASS(wxHtmlSearchEngine) }; -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 +// State information of a search action. I'd have preferred 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 +class WXDLLIMPEXP_HTML 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 case_sensitive, bool whole_words_only, + 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; } + + const wxHtmlHelpDataItem *GetCurItem() const { return m_CurItem; } +#if WXWIN_COMPATIBILITY_2_4 + wxDEPRECATED( wxHtmlContentsItem* GetContentsItem() ); +#endif + 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 + wxHtmlSearchEngine m_Engine; + wxString m_Keyword, m_Name; + wxString m_LastPage; + wxHtmlHelpDataItem* m_CurItem; + 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 + + DECLARE_NO_COPY_CLASS(wxHtmlSearchStatus) }; -class WXDLLEXPORT wxHtmlHelpData : public wxObject +class WXDLLIMPEXP_HTML 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); + void SetTempDir(const wxString& path); + // 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); + bool AddBook(const wxString& book); + bool AddBookParam(const wxFSFile& bookfile, + wxFontEncoding encoding, + const wxString& title, const wxString& contfile, + const wxString& indexfile = wxEmptyString, + const wxString& deftopic = wxEmptyString, + const wxString& path = wxEmptyString); + + // Some accessing stuff: + // returns URL of page on basis of (file)name - wxString FindPageById(int id); + wxString FindPageByName(const wxString& page); // returns URL of page on basis of MS id + wxString FindPageById(int id); + + const wxHtmlBookRecArray& GetBookRecArray() const { return m_bookRecords; } + + const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; } + const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; } + +#if WXWIN_COMPATIBILITY_2_4 + // deprecated interface, new interface is arrays-based (see above) + wxDEPRECATED( wxHtmlContentsItem* GetContents() ); + wxDEPRECATED( int GetContentsCnt() ); + wxDEPRECATED( wxHtmlContentsItem* GetIndex() ); + wxDEPRECATED( int GetIndexCnt() ); +#endif - 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 - + wxString m_tempPath; + + // each book has one record in this array: + wxHtmlBookRecArray m_bookRecords; + + wxHtmlHelpDataItems m_contents; // list of all available books and pages + wxHtmlHelpDataItems m_index; // list of index itesm + +#if WXWIN_COMPATIBILITY_2_4 + // deprecated data structures, set only if GetContents(), GetIndex() + // called + wxHtmlContentsItem* m_cacheContents; + wxHtmlContentsItem* m_cacheIndex; +private: + void CleanCompatibilityData(); +#endif + 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); + bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, + const wxString& indexfile, const wxString& contentsfile); // Reads binary book - bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f); + bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f); // Writes binary book + bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f); + + DECLARE_NO_COPY_CLASS(wxHtmlHelpData) }; #endif