Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleaned Harm's new wxHTML help code

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4227 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
1999-10-27 23:26:24 +00:00
parent a7a4d01bdb
commit d5bb85a0a4
8 changed files with 606 additions and 616 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/wx/html/helpctrl.h
View File

@@ -26,31 +26,38 @@ class WXDLLEXPORT wxHtmlHelpController : public wxEvtHandler
{ {
DECLARE_DYNAMIC_CLASS(wxHtmlHelpController) DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
public: public:
wxHtmlHelpController(); wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
virtual ~wxHtmlHelpController(); virtual ~wxHtmlHelpController();
void SetTitleFormat(const wxString& format); void SetTitleFormat(const wxString& format);
void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); } void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
bool AddBook(const wxString& book, bool show_wait_msg = FALSE); bool AddBook(const wxString& book, bool show_wait_msg = FALSE);
bool Display(const wxString& x) { bool Display(const wxString& x)
{
CreateHelpWindow(); return m_helpFrame->Display(x); CreateHelpWindow(); return m_helpFrame->Display(x);
} }
bool Display(int id) { bool Display(int id)
{
CreateHelpWindow(); return m_helpFrame->Display(id); CreateHelpWindow(); return m_helpFrame->Display(id);
} }
bool DisplayContents() { bool DisplayContents()
{
CreateHelpWindow(); return m_helpFrame->DisplayContents(); CreateHelpWindow(); return m_helpFrame->DisplayContents();
} }
bool DisplayIndex() { bool DisplayIndex()
{
CreateHelpWindow(); return m_helpFrame->DisplayIndex(); CreateHelpWindow(); return m_helpFrame->DisplayIndex();
} }
bool KeywordSearch(const wxString& keyword) { bool KeywordSearch(const wxString& keyword)
{
CreateHelpWindow(); return KeywordSearch(keyword); CreateHelpWindow(); return KeywordSearch(keyword);
} }
wxHtmlHelpFrame* GetFrame() { return m_helpFrame; } wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) { void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString)
m_Config = config; m_ConfigRoot = rootpath; {
m_Config = config;
m_ConfigRoot = rootpath;
ReadCustomization(config, rootpath); ReadCustomization(config, rootpath);
} }
// Assigns config object to the Ctrl. This config is then // Assigns config object to the Ctrl. This config is then
@@ -59,17 +66,20 @@ public:
virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
virtual void CreateHelpWindow(bool show_progress = FALSE); virtual void CreateHelpWindow(bool show_progress = FALSE);
virtual void DestroyHelpWindow() { virtual void DestroyHelpWindow()
{
//if (m_Config) WriteCustomization(m_Config, m_ConfigRoot); //if (m_Config) WriteCustomization(m_Config, m_ConfigRoot);
if (m_helpFrame) m_helpFrame->Destroy(); if (m_helpFrame) m_helpFrame->Destroy();
} }
protected:
protected:
void OnCloseFrame(wxCloseEvent& evt) { m_helpFrame = NULL; evt.Skip(); } void OnCloseFrame(wxCloseEvent& evt) { m_helpFrame = NULL; evt.Skip(); }
wxHtmlHelpData m_helpData; wxHtmlHelpData m_helpData;
wxHtmlHelpFrame* m_helpFrame; wxHtmlHelpFrame* m_helpFrame;
wxConfigBase *m_Config; wxConfigBase *m_Config;
wxString m_ConfigRoot; wxString m_ConfigRoot;
wxString m_titleFormat; wxString m_titleFormat;
int m_FrameStyle;
DECLARE_EVENT_TABLE() DECLARE_EVENT_TABLE()
}; };

68
include/wx/html/helpdata.h
View File

@@ -31,30 +31,34 @@
class WXDLLEXPORT wxHtmlBookRecord : public wxObject class WXDLLEXPORT wxHtmlBookRecord : public wxObject
{ {
public: public:
wxHtmlBookRecord(const wxString& basepath, const wxString& title, wxHtmlBookRecord(const wxString& basepath, const wxString& title,
const wxString& start) { const wxString& start)
m_BasePath = basepath; m_Title = title; m_Start = start; {
m_BasePath = basepath;
m_Title = title;
m_Start = start;
// for debugging, give the contents index obvious default values // for debugging, give the contents index obvious default values
contents_start = contents_end = -1; m_ContentsStart = m_ContentsEnd = -1;
} }
wxString GetTitle() const {return m_Title;} wxString GetTitle() const { return m_Title; }
wxString GetStart() const {return m_Start;} wxString GetStart() const { return m_Start; }
wxString GetBasePath() const {return m_BasePath;} wxString GetBasePath() const { return m_BasePath; }
/* SetContentsRange: store in the bookrecord where in the index/contents lists the /* 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. * 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. * 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. */ * 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; } void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; }
int GetContentsStart() const { return contents_start; } int GetContentsStart() const { return m_ContentsStart; }
int GetContentsEnd() const { return contents_end; } int GetContentsEnd() const { return m_ContentsEnd; }
protected:
protected:
wxString m_BasePath; wxString m_BasePath;
wxString m_Title; wxString m_Title;
wxString m_Start; wxString m_Start;
int contents_start; int m_ContentsStart;
int contents_end; int m_ContentsEnd;
}; };
@@ -68,7 +72,8 @@ typedef struct
char* m_Name; char* m_Name;
char* m_Page; char* m_Page;
wxHtmlBookRecord *m_Book; wxHtmlBookRecord *m_Book;
} wxHtmlContentsItem; }
wxHtmlContentsItem;
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
// wxSearchEngine // wxSearchEngine
@@ -77,12 +82,12 @@ typedef struct
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
class WXDLLEXPORT wxSearchEngine : public wxObject class WXDLLEXPORT wxSearchEngine : public wxObject
{ {
private: private:
char *m_Keyword; char *m_Keyword;
public: public:
wxSearchEngine() : wxObject() {m_Keyword = NULL;} wxSearchEngine() : wxObject() {m_Keyword = NULL; }
~wxSearchEngine() {if (m_Keyword) free(m_Keyword);} ~wxSearchEngine() {if (m_Keyword) free(m_Keyword); }
virtual void LookFor(const wxString& keyword); virtual void LookFor(const wxString& keyword);
// Sets the keyword we will be searching for // Sets the keyword we will be searching for
@@ -90,7 +95,8 @@ public:
virtual bool Scan(wxInputStream *stream); 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
}; }
;
class wxHtmlHelpData; class wxHtmlHelpData;
@@ -100,9 +106,10 @@ class wxHtmlHelpData;
// wxHtmlHelpData::PrepareKeywordSearch(const wxString& key) // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
class WXDLLEXPORT wxHtmlSearchStatus class WXDLLEXPORT wxHtmlSearchStatus
{ {
public: public:
// constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
// title of the book to search. By default, all books are searched. // title of the book to search. By default, all books are searched.
wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword, wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
const wxString& book = wxEmptyString); const wxString& book = wxEmptyString);
bool Search(); // do the next iteration bool Search(); // do the next iteration
@@ -111,7 +118,8 @@ public:
int GetMaxIndex() { return m_MaxIndex; } int GetMaxIndex() { return m_MaxIndex; }
const wxString& GetName() { return m_Name; } const wxString& GetName() { return m_Name; }
wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; } wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
private:
private:
wxHtmlHelpData* m_Data; wxHtmlHelpData* m_Data;
wxSearchEngine m_Engine; wxSearchEngine m_Engine;
wxString m_Keyword, m_Name, m_LastPage; wxString m_Keyword, m_Name, m_LastPage;
@@ -120,7 +128,8 @@ private:
int m_CurIndex; // where we are now int m_CurIndex; // where we are now
int m_MaxIndex; // number of files we search int m_MaxIndex; // number of files we search
// For progress bar: 100*curindex/maxindex = % complete // For progress bar: 100*curindex/maxindex = % complete
}; }
;
class WXDLLEXPORT wxHtmlHelpData : public wxObject class WXDLLEXPORT wxHtmlHelpData : public wxObject
{ {
@@ -128,7 +137,7 @@ class WXDLLEXPORT wxHtmlHelpData : public wxObject
friend class wxHtmlSearchStatus; friend class wxHtmlSearchStatus;
public: public:
wxHtmlHelpData(); wxHtmlHelpData();
~wxHtmlHelpData(); ~wxHtmlHelpData();
@@ -142,9 +151,9 @@ public:
// See documentation for details on its format. // See documentation for details on its format.
// Returns success. // Returns success.
bool AddBookParam(const wxString& title, const wxString& contfile, bool AddBookParam(const wxString& title, const wxString& contfile,
const wxString& indexfile=wxEmptyString, const wxString& indexfile = wxEmptyString,
const wxString& deftopic=wxEmptyString, const wxString& deftopic = wxEmptyString,
const wxString& path=wxEmptyString); const wxString& path = wxEmptyString);
// Some accessing stuff // Some accessing stuff
wxString FindPageByName(const wxString& page); wxString FindPageByName(const wxString& page);
@@ -158,7 +167,7 @@ public:
wxHtmlContentsItem* GetIndex() { return m_Index; } wxHtmlContentsItem* GetIndex() { return m_Index; }
int GetIndexCnt() { return m_IndexCnt; } int GetIndexCnt() { return m_IndexCnt; }
protected: protected:
wxString m_TempPath; wxString m_TempPath;
wxHtmlBookRecArray m_BookRecords; wxHtmlBookRecArray m_BookRecords;
@@ -170,7 +179,7 @@ protected:
int m_IndexCnt; int m_IndexCnt;
// list of index items // list of index items
protected: protected:
bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
const wxString& indexfile, const wxString& contentsfile); const wxString& indexfile, const wxString& contentsfile);
// Imports .hhp files (MS HTML Help Workshop) // Imports .hhp files (MS HTML Help Workshop)
@@ -178,7 +187,8 @@ protected:
// Reads binary book // Reads binary book
bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f); bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
// Writes binary book // Writes binary book
}; }
;
#endif #endif

46
include/wx/html/helpfrm.h
View File

@@ -30,15 +30,18 @@
#include "wx/choice.h" #include "wx/choice.h"
#include "wx/html/htmlwin.h" #include "wx/html/htmlwin.h"
// style flags for the Help Frame // style flags for the Help Frame
const int wxHF_TOOLBAR = 1; #define wxHF_TOOLBAR 0x0001
const int wxHF_CONTENTS = 2; #define wxHF_CONTENTS 0x0002
const int wxHF_INDEX = 4; #define wxHF_INDEX 0x0004
const int wxHF_SEARCH = 8; #define wxHF_SEARCH 0x0008
const int wxHF_DEFAULTSTYLE = -1; #define wxHF_DEFAULTSTYLE (wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)
// Command IDs : // Command IDs :
enum { enum
{
wxID_HTML_PANEL = wxID_HIGHEST + 1, wxID_HTML_PANEL = wxID_HIGHEST + 1,
wxID_HTML_BACK, wxID_HTML_BACK,
wxID_HTML_FORWARD, wxID_HTML_FORWARD,
@@ -52,24 +55,25 @@ enum {
wxID_HTML_SEARCHBUTTON, wxID_HTML_SEARCHBUTTON,
wxID_HTML_SEARCHCHOICE, wxID_HTML_SEARCHCHOICE,
wxID_HTML_HELPFRAME // the id of wxHtmlHelpController's helpframe wxID_HTML_HELPFRAME // the id of wxHtmlHelpController's helpframe
}; }
;
class WXDLLEXPORT wxHtmlHelpFrameCfg
typedef struct
{ {
public:
wxHtmlHelpFrameCfg() {};
long x, y, w, h; long x, y, w, h;
long sashpos; long sashpos;
bool navig_on; bool navig_on;
int style; // flags given to wxHtmlHelpFrame ctor }
wxString titleformat; wxHtmlHelpFrameCfg;
};
class WXDLLEXPORT wxHtmlHelpFrame : public wxFrame class WXDLLEXPORT wxHtmlHelpFrame : public wxFrame
{ {
DECLARE_DYNAMIC_CLASS(wxHtmlHelpFrame) DECLARE_DYNAMIC_CLASS(wxHtmlHelpFrame)
public: public:
wxHtmlHelpFrame(wxHtmlHelpData* data = NULL) { Init(data); } wxHtmlHelpFrame(wxHtmlHelpData* data = NULL) { Init(data); }
wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
const wxString& title = wxEmptyString, const wxString& title = wxEmptyString,
@@ -80,7 +84,8 @@ public:
wxHtmlHelpData* GetData() { return m_Data; } wxHtmlHelpData* GetData() { return m_Data; }
void SetTitleFormat(const wxString& format) { void SetTitleFormat(const wxString& format)
{
if (m_HtmlWin) if (m_HtmlWin)
m_HtmlWin->SetRelatedFrame(this, format); m_HtmlWin->SetRelatedFrame(this, format);
m_TitleFormat = format; m_TitleFormat = format;
@@ -123,8 +128,10 @@ public:
// Adds items to m_IndexList // Adds items to m_IndexList
void CreateSearch(); void CreateSearch();
// Add books to search choice panel // Add books to search choice panel
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) { void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString)
m_Config = config; m_ConfigRoot = rootpath; {
m_Config = config;
m_ConfigRoot = rootpath;
ReadCustomization(config, rootpath); ReadCustomization(config, rootpath);
} }
void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
@@ -147,7 +154,7 @@ public:
IMG_Page IMG_Page
}; };
protected: protected:
wxHtmlHelpData* m_Data; wxHtmlHelpData* m_Data;
bool m_DataCreated; // m_Data created by frame, or supplied? bool m_DataCreated; // m_Data created by frame, or supplied?
wxString m_TitleFormat; // title of the help frame wxString m_TitleFormat; // title of the help frame
@@ -164,6 +171,7 @@ protected:
wxChoice *m_SearchChoice; wxChoice *m_SearchChoice;
wxHtmlHelpFrameCfg m_Cfg; wxHtmlHelpFrameCfg m_Cfg;
wxConfigBase *m_Config; wxConfigBase *m_Config;
wxString m_ConfigRoot; wxString m_ConfigRoot;
@@ -172,7 +180,7 @@ protected:
int m_IndexPage; int m_IndexPage;
int m_SearchPage; int m_SearchPage;
protected: protected:
void Init(wxHtmlHelpData* data = NULL); void Init(wxHtmlHelpData* data = NULL);
DECLARE_EVENT_TABLE() DECLARE_EVENT_TABLE()

3
samples/html/help/helpfiles/another.hhp
View File

@@ -4,6 +4,3 @@ Contents file=another.hhc
Display compile progress=No Display compile progress=No
Title=Another book Title=Another book
Default topic=another.htm Default topic=another.htm
Embarassment=extra line because project parsing is slightly buggy

11
src/html/helpctrl.cpp
View File

@@ -31,15 +31,16 @@
IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxEvtHandler) IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxEvtHandler)
BEGIN_EVENT_TABLE(wxHtmlHelpController, wxEvtHandler) BEGIN_EVENT_TABLE(wxHtmlHelpController, wxEvtHandler)
EVT_CLOSE(wxHtmlHelpController::OnCloseFrame) EVT_CLOSE(wxHtmlHelpController::OnCloseFrame)
END_EVENT_TABLE() END_EVENT_TABLE()
wxHtmlHelpController::wxHtmlHelpController() wxHtmlHelpController::wxHtmlHelpController(int style)
{ {
m_helpFrame = NULL; m_helpFrame = NULL;
m_Config = NULL; m_Config = NULL;
m_ConfigRoot = wxEmptyString; m_ConfigRoot = wxEmptyString;
m_titleFormat = _("Help: %s"); m_titleFormat = _("Help: %s");
m_FrameStyle = style;
} }
wxHtmlHelpController::~wxHtmlHelpController() wxHtmlHelpController::~wxHtmlHelpController()
@@ -56,6 +57,7 @@ void wxHtmlHelpController::SetTitleFormat(const wxString& title)
m_helpFrame->SetTitleFormat(title); m_helpFrame->SetTitleFormat(title);
} }
bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg) bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
{ {
wxBusyCursor cur; wxBusyCursor cur;
@@ -79,13 +81,14 @@ void wxHtmlHelpController::CreateHelpWindow(bool show_progress)
{ {
if (m_helpFrame) { if (m_helpFrame) {
m_helpFrame->Raise(); m_helpFrame->Raise();
return; return ;
} }
m_helpFrame = new wxHtmlHelpFrame(&m_helpData); m_helpFrame = new wxHtmlHelpFrame(&m_helpData);
m_helpFrame->PushEventHandler(this); m_helpFrame->PushEventHandler(this);
if (m_Config) if (m_Config)
m_helpFrame->UseConfig(m_Config, m_ConfigRoot); m_helpFrame->UseConfig(m_Config, m_ConfigRoot);
m_helpFrame->Create(NULL, wxID_HTML_HELPFRAME); m_helpFrame->Create(NULL, wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle);
m_helpFrame->RefreshLists(show_progress); m_helpFrame->RefreshLists(show_progress);
m_helpFrame->SetTitleFormat(m_titleFormat); m_helpFrame->SetTitleFormat(m_titleFormat);
m_helpFrame->Show(TRUE); m_helpFrame->Show(TRUE);

84
src/html/helpdata.cpp
View File

@@ -102,8 +102,8 @@ class HP_TagHandler : public wxHtmlTagHandler
wxHtmlBookRecord *m_Book; wxHtmlBookRecord *m_Book;
public: public:
HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler() {m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString; m_Level = 0;} HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler() {m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString; m_Level = 0; }
wxString GetSupportedTags() {return "UL,OBJECT,PARAM";} wxString GetSupportedTags() { return "UL,OBJECT,PARAM"; }
bool HandleTag(const wxHtmlTag& tag); bool HandleTag(const wxHtmlTag& tag);
void WriteOut(wxHtmlContentsItem*& array, int& size); void WriteOut(wxHtmlContentsItem*& array, int& size);
void ReadIn(wxHtmlContentsItem* array, int size); void ReadIn(wxHtmlContentsItem* array, int size);
@@ -118,7 +118,6 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
m_Level--; m_Level--;
return TRUE; return TRUE;
} }
else if (tag.GetName() == "OBJECT") { else if (tag.GetName() == "OBJECT") {
m_Name = m_Page = wxEmptyString; m_Name = m_Page = wxEmptyString;
ParseInner(tag); ParseInner(tag);
@@ -136,7 +135,6 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
} }
return TRUE; return TRUE;
} }
else { // "PARAM" else { // "PARAM"
if (m_Name == wxEmptyString && tag.GetParam("NAME") == "Name") m_Name = tag.GetParam("VALUE"); if (m_Name == wxEmptyString && tag.GetParam("NAME") == "Name") m_Name = tag.GetParam("VALUE");
if (tag.GetParam("NAME") == "Local") m_Page = tag.GetParam("VALUE"); if (tag.GetParam("NAME") == "Local") m_Page = tag.GetParam("VALUE");
@@ -161,6 +159,9 @@ void HP_TagHandler::ReadIn(wxHtmlContentsItem* array, int size)
m_ItemsCnt = size; m_ItemsCnt = size;
} }
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
// wxHtmlHelpData // wxHtmlHelpData
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
@@ -212,7 +213,7 @@ bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, c
f = ( contentsfile.IsEmpty() ? 0 : fsys.OpenFile(contentsfile) ); f = ( contentsfile.IsEmpty() ? 0 : fsys.OpenFile(contentsfile) );
if (f) { if (f) {
sz = f -> GetStream() -> GetSize(); sz = f -> GetStream() -> GetSize();
buf = new char[sz+1]; buf = new char[sz + 1];
buf[sz] = 0; buf[sz] = 0;
f -> GetStream() -> Read(buf, sz); f -> GetStream() -> Read(buf, sz);
delete f; delete f;
@@ -225,7 +226,7 @@ bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, c
f = ( indexfile.IsEmpty() ? 0 : fsys.OpenFile(indexfile) ); f = ( indexfile.IsEmpty() ? 0 : fsys.OpenFile(indexfile) );
if (f) { if (f) {
sz = f -> GetStream() -> GetSize(); sz = f -> GetStream() -> GetSize();
buf = new char[sz+1]; buf = new char[sz + 1];
buf[sz] = 0; buf[sz] = 0;
f -> GetStream() -> Read(buf, sz); f -> GetStream() -> Read(buf, sz);
delete f; delete f;
@@ -347,10 +348,9 @@ bool wxHtmlHelpData::AddBookParam(const wxString& title, const wxString& contfil
wxString safetitle; wxString safetitle;
if (! path.IsEmpty()) if (! path.IsEmpty())
// workaround for bug in ChangePathTo(name, TRUE) fsys.ChangePathTo(path, TRUE);
fsys.ChangePathTo(path+"/gaga");
bookr = new wxHtmlBookRecord(path+'/', title, deftopic); bookr = new wxHtmlBookRecord(path + '/', title, deftopic);
if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0) if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0)
m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem)); m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem));
@@ -376,8 +376,7 @@ bool wxHtmlHelpData::AddBookParam(const wxString& title, const wxString& contfil
SaveCachedBook(bookr, outs); SaveCachedBook(bookr, outs);
delete outs; delete outs;
} }
} } else {
else {
LoadCachedBook(bookr, fi -> GetStream()); LoadCachedBook(bookr, fi -> GetStream());
delete fi; delete fi;
} }
@@ -417,13 +416,15 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
fsys.ChangePathTo(bookFull); fsys.ChangePathTo(bookFull);
s = fi -> GetStream(); s = fi -> GetStream();
sz = s -> GetSize(); sz = s -> GetSize();
buff = new char[sz+1]; buff = new char[sz + 1];
buff[sz] = 0; buff[sz] = 0;
s -> Read(buff, sz); s -> Read(buff, sz);
lineptr = buff; lineptr = buff;
delete fi; delete fi;
while ((lineptr = ReadLine(lineptr, linebuf)) != NULL) { do {
lineptr = ReadLine(lineptr, linebuf);
if (strstr(linebuf, "Title=") == linebuf) if (strstr(linebuf, "Title=") == linebuf)
title = linebuf + strlen("Title="); title = linebuf + strlen("Title=");
if (strstr(linebuf, "Default topic=") == linebuf) if (strstr(linebuf, "Default topic=") == linebuf)
@@ -432,7 +433,7 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
index = linebuf + strlen("Index file="); index = linebuf + strlen("Index file=");
if (strstr(linebuf, "Contents file=") == linebuf) if (strstr(linebuf, "Contents file=") == linebuf)
contents = linebuf + strlen("Contents file="); contents = linebuf + strlen("Contents file=");
} } while (lineptr != NULL);
delete[] buff; delete[] buff;
return AddBookParam(title, contents, index, start, fsys.GetPath()); return AddBookParam(title, contents, index, start, fsys.GetPath());
@@ -519,8 +520,8 @@ wxHtmlSearchStatus::wxHtmlSearchStatus(wxHtmlHelpData* data, const wxString& key
wxHtmlBookRecord* bookr = NULL; wxHtmlBookRecord* bookr = NULL;
if (book != wxEmptyString) { if (book != wxEmptyString) {
// we have to search in a specific book. Find it first // we have to search in a specific book. Find it first
int i,cnt = data->m_BookRecords.GetCount(); int i, cnt = data->m_BookRecords.GetCount();
for (i=0; i<cnt; i++) for (i = 0; i < cnt; i++)
if (data->m_BookRecords[i].GetTitle() == book) { if (data->m_BookRecords[i].GetTitle() == book) {
bookr = &(data->m_BookRecords[i]); bookr = &(data->m_BookRecords[i]);
m_CurIndex = bookr->GetContentsStart(); m_CurIndex = bookr->GetContentsStart();
@@ -577,4 +578,55 @@ wxASSERT(m_Active);
return found; return found;
} }
//--------------------------------------------------------------------------------
// wxSearchEngine
//--------------------------------------------------------------------------------
void wxSearchEngine::LookFor(const wxString& keyword)
{
if (m_Keyword) delete[] m_Keyword;
m_Keyword = new char[keyword.Length() + 1];
strcpy(m_Keyword, keyword.c_str());
for (int i = strlen(m_Keyword) - 1; i >= 0; i--)
if ((m_Keyword[i] >= 'A') && (m_Keyword[i] <= 'Z'))
m_Keyword[i] += 'a' - 'A';
}
bool wxSearchEngine::Scan(wxInputStream *stream)
{
wxASSERT_MSG(m_Keyword != NULL, _("wxSearchEngine::LookFor must be called before scanning!"));
int i, j;
int lng = stream ->GetSize();
int wrd = strlen(m_Keyword);
bool found = FALSE;
char *buf = new char[lng + 1];
stream -> Read(buf, lng);
buf[lng] = 0;
for (i = 0; i < lng; i++)
if ((buf[i] >= 'A') && (buf[i] <= 'Z')) buf[i] += 'a' - 'A';
for (i = 0; i < lng - wrd; i++) {
j = 0;
while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++;
if (j == wrd) {found = TRUE; break; }
}
delete[] buf;
return found;
}
#endif #endif

70
src/html/helpfrm.cpp
View File

@@ -53,7 +53,7 @@
// number of times that the contents/index creation progress dialog // number of times that the contents/index creation progress dialog
// is updated. // is updated.
static const int PROGRESS_STEP = 40; #define PROGRESS_STEP 40
//-------------------------------------------------------------------------- //--------------------------------------------------------------------------
// wxHtmlHelpTreeItemData // wxHtmlHelpTreeItemData
@@ -69,7 +69,7 @@ class wxHtmlHelpTreeItemData : public wxTreeItemData
{ {
m_Page = it -> m_Book -> GetBasePath() + it -> m_Page; m_Page = it -> m_Book -> GetBasePath() + it -> m_Page;
} }
const wxString& GetPage() {return m_Page;} const wxString& GetPage() { return m_Page; }
}; };
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
@@ -90,8 +90,7 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
if (data) { if (data) {
m_Data = data; m_Data = data;
m_DataCreated = FALSE; m_DataCreated = FALSE;
} } else {
else {
m_Data = new wxHtmlHelpData(); m_Data = new wxHtmlHelpData();
m_DataCreated = TRUE; m_DataCreated = TRUE;
} }
@@ -114,22 +113,21 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
m_ConfigRoot = wxEmptyString; m_ConfigRoot = wxEmptyString;
m_Cfg.x = m_Cfg.y = 0; m_Cfg.x = m_Cfg.y = 0;
m_Cfg.w = 700; m_Cfg.h = 480; m_Cfg.w = 700;
m_Cfg.h = 480;
m_Cfg.sashpos = 240; m_Cfg.sashpos = 240;
m_Cfg.navig_on = TRUE; m_Cfg.navig_on = TRUE;
m_Cfg.titleformat = _("Help: %s");
m_Cfg.style = wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH;
} }
/* Create: builds the GUI components. // Create: builds the GUI components.
* with the style flag it's possible to toggle the toolbar, contents, index and search // with the style flag it's possible to toggle the toolbar, contents, index and search
* controls. // controls.
* m_HtmlWin will *always* be created, but it's important to realize that // m_HtmlWin will *always* be created, but it's important to realize that
* m_ContentsBox, m_IndexBox, m_SearchList, m_SearchButton, m_SearchText and // m_ContentsBox, m_IndexBox, m_SearchList, m_SearchButton, m_SearchText and
* m_SearchButton may be NULL. // m_SearchButton may be NULL.
* moreover, if no contents, index or searchpage is needed, m_Splitter and // moreover, if no contents, index or searchpage is needed, m_Splitter and
* m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame) // m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame)
*/
bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& title, bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& title,
int style) int style)
{ {
@@ -140,19 +138,13 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& ti
wxFrame::Create(parent, id, "", wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h)); wxFrame::Create(parent, id, "", wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h));
if (style == wxHF_DEFAULTSTYLE)
style = m_Cfg.style;
if (! title.IsEmpty()) // overridden?
m_Cfg.titleformat = title;
int notebook_page = 0; int notebook_page = 0;
CreateStatusBar(); CreateStatusBar();
// toolbar? // toolbar?
if (style & wxHF_TOOLBAR) { if (style & wxHF_TOOLBAR) {
wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT | wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL | /*wxTB_FLAT | */
wxTB_DOCKABLE); wxTB_DOCKABLE);
toolBar -> SetMargins(2, 2); toolBar -> SetMargins(2, 2);
wxBitmap* toolBarBitmaps[3]; wxBitmap* toolBarBitmaps[3];
@@ -163,7 +155,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& ti
toolBarBitmaps[2] = new wxBitmap("forward"); toolBarBitmaps[2] = new wxBitmap("forward");
int width = 24; int width = 24;
#else #else
toolBarBitmaps[0] = new wxBitmap(panel_xpm); toolBarBitmaps[0] = new wxBitmap(panel_xpm);
toolBarBitmaps[1] = new wxBitmap(back_xpm); toolBarBitmaps[1] = new wxBitmap(back_xpm);
toolBarBitmaps[2] = new wxBitmap(forward_xpm); toolBarBitmaps[2] = new wxBitmap(forward_xpm);
int width = 16; int width = 16;
@@ -200,8 +192,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& ti
m_HtmlWin = new wxHtmlWindow(m_Splitter); m_HtmlWin = new wxHtmlWindow(m_Splitter);
m_NavigPan = new wxNotebook(m_Splitter, wxID_HTML_NOTEBOOK, m_NavigPan = new wxNotebook(m_Splitter, wxID_HTML_NOTEBOOK,
wxDefaultPosition, wxDefaultSize); wxDefaultPosition, wxDefaultSize);
} } else { // only html window, no notebook with index,contents etc
else { // only html window, no notebook with index,contents etc
m_HtmlWin = new wxHtmlWindow(this); m_HtmlWin = new wxHtmlWindow(this);
} }
@@ -229,7 +220,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& ti
b1 -> width.PercentOf (dummy, wxWidth, 100); b1 -> width.PercentOf (dummy, wxWidth, 100);
b1 -> bottom.SameAs (dummy, wxBottom, 0); b1 -> bottom.SameAs (dummy, wxBottom, 0);
m_IndexBox = new wxListBox(dummy, wxID_HTML_INDEXLIST, wxDefaultPosition, m_IndexBox = new wxListBox(dummy, wxID_HTML_INDEXLIST, wxDefaultPosition,
wxDefaultSize, 0, NULL, wxLB_SINGLE |wxLB_ALWAYS_SB); wxDefaultSize, 0, NULL, wxLB_SINGLE | wxLB_ALWAYS_SB);
m_IndexBox -> SetConstraints(b1); m_IndexBox -> SetConstraints(b1);
dummy -> SetAutoLayout(TRUE); dummy -> SetAutoLayout(TRUE);
m_NavigPan -> AddPage(dummy, _("Index")); m_NavigPan -> AddPage(dummy, _("Index"));
@@ -403,7 +394,7 @@ bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword)
void wxHtmlHelpFrame::CreateContents(bool show_progress) void wxHtmlHelpFrame::CreateContents(bool show_progress)
{ {
if (! m_ContentsBox) if (! m_ContentsBox)
return; return ;
wxProgressDialog *progress; wxProgressDialog *progress;
wxString proginfo; wxString proginfo;
@@ -430,7 +421,7 @@ void wxHtmlHelpFrame::CreateContents(bool show_progress)
for (i = 0; i < cnt; i++, it++) { for (i = 0; i < cnt; i++, it++) {
if (show_progress && ((i % div) == 0)) { if (show_progress && ((i % div) == 0)) {
proginfo.Printf("Added %d/%d items", i, cnt); proginfo.Printf(_("Added %d/%d items"), i, cnt);
if (! progress->Update(i, proginfo)) if (! progress->Update(i, proginfo))
break; break;
wxYield(); wxYield();
@@ -444,8 +435,7 @@ void wxHtmlHelpFrame::CreateContents(bool show_progress)
m_ContentsBox -> SetItemImage(roots[1], IMG_Book); m_ContentsBox -> SetItemImage(roots[1], IMG_Book);
m_ContentsBox -> SetItemSelectedImage(roots[1], IMG_Book); m_ContentsBox -> SetItemSelectedImage(roots[1], IMG_Book);
imaged[1] = TRUE; imaged[1] = TRUE;
} } else imaged[it -> m_Level + 1] = FALSE;
else imaged[it -> m_Level + 1] = FALSE;
if (!imaged[it -> m_Level]) { if (!imaged[it -> m_Level]) {
m_ContentsBox -> SetItemImage(roots[it -> m_Level], IMG_Folder); m_ContentsBox -> SetItemImage(roots[it -> m_Level], IMG_Folder);
@@ -462,7 +452,7 @@ void wxHtmlHelpFrame::CreateContents(bool show_progress)
void wxHtmlHelpFrame::CreateIndex(bool show_progress) void wxHtmlHelpFrame::CreateIndex(bool show_progress)
{ {
if (! m_IndexBox) if (! m_IndexBox)
return; return ;
wxProgressDialog *progress; wxProgressDialog *progress;
wxString proginfo; wxString proginfo;
@@ -480,7 +470,7 @@ void wxHtmlHelpFrame::CreateIndex(bool show_progress)
wxPD_AUTO_HIDE); wxPD_AUTO_HIDE);
for (int i = 0; i < cnt; i++) { for (int i = 0; i < cnt; i++) {
if (show_progress && ((i % div) == 0)) { if (show_progress && ((i % div) == 0)) {
proginfo.Printf("Added %d/%d items", i, cnt); proginfo.Printf(_("Added %d/%d items"), i, cnt);
if (! progress->Update(i, proginfo)) if (! progress->Update(i, proginfo))
break; break;
wxYield(); wxYield();
@@ -495,13 +485,13 @@ void wxHtmlHelpFrame::CreateIndex(bool show_progress)
void wxHtmlHelpFrame::CreateSearch() void wxHtmlHelpFrame::CreateSearch()
{ {
if (! (m_SearchList && m_SearchChoice)) if (! (m_SearchList && m_SearchChoice))
return; return ;
m_SearchList -> Clear(); m_SearchList -> Clear();
m_SearchChoice -> Clear(); m_SearchChoice -> Clear();
m_SearchChoice -> Append(_("all books")); m_SearchChoice -> Append(_("all books"));
const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray(); const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray();
int i, cnt = bookrec.GetCount(); int i, cnt = bookrec.GetCount();
for (i=0; i<cnt; i++) for (i = 0; i < cnt; i++)
m_SearchChoice->Append(bookrec[i].GetTitle()); m_SearchChoice->Append(bookrec[i].GetTitle());
m_SearchChoice->SetSelection(0); m_SearchChoice->SetSelection(0);
} }
@@ -530,8 +520,6 @@ void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
m_Cfg.y = cfg -> Read("hcY", m_Cfg.y); m_Cfg.y = cfg -> Read("hcY", m_Cfg.y);
m_Cfg.w = cfg -> Read("hcW", m_Cfg.w); m_Cfg.w = cfg -> Read("hcW", m_Cfg.w);
m_Cfg.h = cfg -> Read("hcH", m_Cfg.h); m_Cfg.h = cfg -> Read("hcH", m_Cfg.h);
m_Cfg.titleformat = cfg -> Read("hcTitleFormat", m_Cfg.titleformat);
m_Cfg.style = (int)cfg -> Read("hcStyle", (long)m_Cfg.style);
if (m_HtmlWin) if (m_HtmlWin)
m_HtmlWin->ReadCustomization(cfg, path); m_HtmlWin->ReadCustomization(cfg, path);
@@ -544,7 +532,6 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path
{ {
wxString oldpath; wxString oldpath;
wxString tmp; wxString tmp;
//printf("wxHtmlHelpFrame. Writing config to %s\n", (const char*)path);
if (path != wxEmptyString) { if (path != wxEmptyString) {
oldpath = cfg -> GetPath(); oldpath = cfg -> GetPath();
@@ -557,8 +544,6 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path
cfg -> Write("hcY", (long)m_Cfg.y); cfg -> Write("hcY", (long)m_Cfg.y);
cfg -> Write("hcW", (long)m_Cfg.w); cfg -> Write("hcW", (long)m_Cfg.w);
cfg -> Write("hcH", (long)m_Cfg.h); cfg -> Write("hcH", (long)m_Cfg.h);
cfg -> Write("hcTitleFormat", m_Cfg.titleformat);
cfg -> Write("hcStyle", (long)m_Cfg.style);
if (m_HtmlWin) if (m_HtmlWin)
m_HtmlWin->WriteCustomization(cfg, path); m_HtmlWin->WriteCustomization(cfg, path);
@@ -584,12 +569,11 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
break; break;
case wxID_HTML_PANEL : case wxID_HTML_PANEL :
if (! (m_Splitter && m_NavigPan)) if (! (m_Splitter && m_NavigPan))
return; return ;
if (m_Splitter -> IsSplit()) { if (m_Splitter -> IsSplit()) {
m_Cfg.sashpos = m_Splitter -> GetSashPosition(); m_Cfg.sashpos = m_Splitter -> GetSashPosition();
m_Splitter -> Unsplit(m_NavigPan); m_Splitter -> Unsplit(m_NavigPan);
} } else {
else {
m_NavigPan -> Show(TRUE); m_NavigPan -> Show(TRUE);
m_HtmlWin -> Show(TRUE); m_HtmlWin -> Show(TRUE);
m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);

74
src/html/search.cpp
View File

@@ -1,74 +0,0 @@
/////////////////////////////////////////////////////////////////////////////
// Name: search.cpp
// Purpose: search engine
// Author: Vaclav Slavik
// RCS-ID: $Id$
// Copyright: (c) 1999 Vaclav Slavik
// Licence: wxWindows Licence
/////////////////////////////////////////////////////////////////////////////
#ifdef __GNUG__
#pragma implementation
#endif
#include "wx/wxprec.h"
#include "wx/defs.h"
#if wxUSE_HTML
#ifdef __BORDLANDC__
#pragma hdrstop
#endif
#ifndef WXPRECOMP
#include <wx/wx.h>
#endif
#include "wx/html/helpdata.h"
//--------------------------------------------------------------------------------
// wxSearchEngine
//--------------------------------------------------------------------------------
void wxSearchEngine::LookFor(const wxString& keyword)
{
if (m_Keyword) delete[] m_Keyword;
m_Keyword = new char[keyword.Length() + 1];
strcpy(m_Keyword, keyword.c_str());
for (int i = strlen(m_Keyword) - 1; i >= 0; i--)
if ((m_Keyword[i] >= 'A') && (m_Keyword[i] <= 'Z'))
m_Keyword[i] += 'a' - 'A';
}
bool wxSearchEngine::Scan(wxInputStream *stream)
{
wxASSERT_MSG(m_Keyword != NULL, _("wxSearchEngine::LookFor must be called before scanning!"));
int i, j;
int lng = stream ->GetSize();
int wrd = strlen(m_Keyword);
bool found = FALSE;
char *buf = new char[lng + 1];
stream -> Read(buf, lng);
buf[lng] = 0;
for (i = 0; i < lng; i++)
if ((buf[i] >= 'A') && (buf[i] <= 'Z')) buf[i] += 'a' - 'A';
for (i = 0; i < lng - wrd; i++) {
j = 0;
while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++;
if (j == wrd) {found = TRUE; break;}
}
delete[] buf;
return found;
}
#endif