Don't define __STRICT_ANSI__, we should build both with and without it.

[wxWidgets.git] / include / wx / html / helpdata.h

diff --git a/include/wx/html/helpdata.h b/include/wx/html/helpdata.h
index a731bed94b6904f595249aa3ed3f4f87638136f5..5b4480379bebd7bc7ed06828a424cca1caf69dc7 100644 (file)
--- a/include/wx/html/helpdata.h
+++ b/include/wx/html/helpdata.h
@@ -1,11 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        helpdata.h
+// Name:        wx/html/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
 // 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
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Harm van der Heijden and Vaclav Slavik
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -13,10 +11,6 @@
 #ifndef _WX_HELPDATA_H_
 #define _WX_HELPDATA_H_
 
 #ifndef _WX_HELPDATA_H_
 #define _WX_HELPDATA_H_
 

-#ifdef __GNUG__
-#pragma interface "helpdata.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_HTML
 #include "wx/defs.h"
 
 #if wxUSE_HTML


@@ -25,166 +19,202 @@
 #include "wx/string.h"
 #include "wx/filesys.h"
 #include "wx/dynarray.h"
 #include "wx/string.h"
 #include "wx/filesys.h"
 #include "wx/dynarray.h"

+#include "wx/font.h"
+
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpData;

 
 //--------------------------------------------------------------------------------
 // helper classes & structs
 //--------------------------------------------------------------------------------
 
 
 //--------------------------------------------------------------------------------
 // helper classes & structs
 //--------------------------------------------------------------------------------
 

-class WXDLLEXPORT wxHtmlBookRecord : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlBookRecord

 {
 public:
 {
 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)
      * Note that storing index range is pointless, because the index is alphab. sorted. */
     /* 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; }
-    int GetContentsStart() const { return contents_start; }
-    int 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:
 protected:

+    wxString m_BookFile;

     wxString m_BasePath;
     wxString m_Title;
     wxString m_Start;
     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);

 
 

-#undef WXDLLEXPORTLOCAL
-#define WXDLLEXPORTLOCAL
+struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem
+{
+    wxHtmlHelpDataItem() : level(0), parent(NULL), id(wxID_ANY), book(NULL) {}

 
 

+    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); }
+
+    // returns item indented with spaces if it has level>1:
+    wxString GetIndentedName() const;
+};
+
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems,
+                                  WXDLLIMPEXP_HTML);

 
 

-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
+// wxHtmlSearchEngine
+//                  This class takes input streams and scans them for occurrence

 //                  of keyword(s)
 //------------------------------------------------------------------------------
 //                  of keyword(s)
 //------------------------------------------------------------------------------

-class WXDLLEXPORT wxSearchEngine : public wxObject
-{
-private:
-    char *m_Keyword;

 
 

+class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject
+{

 public:
 public:

-    wxSearchEngine() : wxObject() {m_Keyword = NULL;}
-    ~wxSearchEngine() {if (m_Keyword) free(m_Keyword);}
+    wxHtmlSearchEngine() : wxObject() {}
+    virtual ~wxHtmlSearchEngine() {}

 
 

-    virtual void LookFor(const wxString& keyword);

     // Sets the keyword we will be searching for
     // 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.
     // 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;
+
+    wxDECLARE_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 :-(
+// 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)
 // 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,
 {
 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; }
     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; }
+

 private:
     wxHtmlHelpData* m_Data;
 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
     // For progress bar: 100*curindex/maxindex = % complete

+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlSearchStatus);

 };
 
 };
 

-class WXDLLEXPORT wxHtmlHelpData : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject

 {
     DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)

-

     friend class wxHtmlSearchStatus;
 
 public:
     wxHtmlHelpData();
     friend class wxHtmlSearchStatus;
 
 public:
     wxHtmlHelpData();

-    ~wxHtmlHelpData();
+    virtual ~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.
     // 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.

+    void SetTempDir(const wxString& path);

 
 

-    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.
     // 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);
+    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:

 
 

-    // Some accessing stuff
-    wxString FindPageByName(const wxString& page);

     // returns URL of page on basis of (file)name
     // 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
     // returns URL of page on basis of MS id

+    wxString FindPageById(int id);
+
+    const wxHtmlBookRecArray& GetBookRecArray() const { return m_bookRecords; }

 
 

-    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; }
+    const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; }
+    const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; }

 
 protected:
 
 protected:

-    wxString m_TempPath;
+    wxString m_tempPath;
+
+    // each book has one record in this array:
+    wxHtmlBookRecArray m_bookRecords;

 
 

-    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
+    wxHtmlHelpDataItems m_contents; // list of all available books and pages
+    wxHtmlHelpDataItems m_index; // list of index itesm

 
 protected:
 
 protected:

-    bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
-                      const wxString& indexfile, const wxString& contentsfile);

     // Imports .hhp files (MS HTML Help Workshop)
     // 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
     // Reads binary book

-    bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
+    bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);

     // Writes binary book
     // Writes binary book

+    bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
+
+    wxDECLARE_NO_COPY_CLASS(wxHtmlHelpData);

 };
 
 #endif
 };
 
 #endif