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

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

@@ -27,30 +27,37 @@ class WXDLLEXPORT wxHtmlHelpController : public wxEvtHandler
DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
public:
wxHtmlHelpController();
wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
virtual ~wxHtmlHelpController();
void SetTitleFormat(const wxString& format);
void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
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);
}
bool Display(int id) {
bool Display(int id)
{
CreateHelpWindow(); return m_helpFrame->Display(id);
}
bool DisplayContents() {
bool DisplayContents()
{
CreateHelpWindow(); return m_helpFrame->DisplayContents();
}
bool DisplayIndex() {
bool DisplayIndex()
{
CreateHelpWindow(); return m_helpFrame->DisplayIndex();
}
bool KeywordSearch(const wxString& keyword) {
bool KeywordSearch(const wxString& keyword)
{
CreateHelpWindow(); return KeywordSearch(keyword);
}
wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) {
m_Config = config; m_ConfigRoot = rootpath;
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString)
{
m_Config = config;
m_ConfigRoot = rootpath;
ReadCustomization(config, rootpath);
}
// Assigns config object to the Ctrl. This config is then
@@ -59,10 +66,12 @@ public:
virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
virtual void CreateHelpWindow(bool show_progress = FALSE);
virtual void DestroyHelpWindow() {
virtual void DestroyHelpWindow()
{
//if (m_Config) WriteCustomization(m_Config, m_ConfigRoot);
if (m_helpFrame) m_helpFrame->Destroy();
}
protected:
void OnCloseFrame(wxCloseEvent& evt) { m_helpFrame = NULL; evt.Skip(); }
wxHtmlHelpData m_helpData;
@@ -70,6 +79,7 @@ protected:
wxConfigBase *m_Config;
wxString m_ConfigRoot;
wxString m_titleFormat;
int m_FrameStyle;
DECLARE_EVENT_TABLE()
};

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

@@ -33,10 +33,13 @@ class WXDLLEXPORT wxHtmlBookRecord : public wxObject
{
public:
wxHtmlBookRecord(const wxString& basepath, const wxString& title,
const wxString& start) {
m_BasePath = basepath; m_Title = title; m_Start = start;
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;
m_ContentsStart = m_ContentsEnd = -1;
}
wxString GetTitle() const { return m_Title; }
wxString GetStart() const { return m_Start; }
@@ -46,15 +49,16 @@ public:
* 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; }
protected:
wxString m_BasePath;
wxString m_Title;
wxString m_Start;
int contents_start;
int contents_end;
int m_ContentsStart;
int m_ContentsEnd;
};
@@ -68,7 +72,8 @@ typedef struct
char* m_Name;
char* m_Page;
wxHtmlBookRecord *m_Book;
} wxHtmlContentsItem;
}
wxHtmlContentsItem;
//------------------------------------------------------------------------------
// wxSearchEngine
@@ -90,7 +95,8 @@ public:
virtual bool Scan(wxInputStream *stream);
// Scans the stream for the keyword.
// Returns TRUE if the stream contains keyword, fALSE otherwise
};
}
;
class wxHtmlHelpData;
@@ -103,6 +109,7 @@ class WXDLLEXPORT 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
@@ -111,6 +118,7 @@ public:
int GetMaxIndex() { return m_MaxIndex; }
const wxString& GetName() { return m_Name; }
wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
private:
wxHtmlHelpData* m_Data;
wxSearchEngine m_Engine;
@@ -120,7 +128,8 @@ private:
int m_CurIndex; // where we are now
int m_MaxIndex; // number of files we search
// For progress bar: 100*curindex/maxindex = % complete
};
}
;
class WXDLLEXPORT wxHtmlHelpData : public wxObject
{
@@ -178,7 +187,8 @@ protected:
// Reads binary book
bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
// Writes binary book
};
}
;
#endif

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

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

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

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

7
src/html/helpctrl.cpp
View File

@@ -34,12 +34,13 @@ BEGIN_EVENT_TABLE(wxHtmlHelpController, wxEvtHandler)
EVT_CLOSE(wxHtmlHelpController::OnCloseFrame)
END_EVENT_TABLE()
wxHtmlHelpController::wxHtmlHelpController()
wxHtmlHelpController::wxHtmlHelpController(int style)
{
m_helpFrame = NULL;
m_Config = NULL;
m_ConfigRoot = wxEmptyString;
m_titleFormat = _("Help: %s");
m_FrameStyle = style;
}
wxHtmlHelpController::~wxHtmlHelpController()
@@ -56,6 +57,7 @@ void wxHtmlHelpController::SetTitleFormat(const wxString& title)
m_helpFrame->SetTitleFormat(title);
}
bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
{
wxBusyCursor cur;
@@ -82,10 +84,11 @@ void wxHtmlHelpController::CreateHelpWindow(bool show_progress)
return ;
}
m_helpFrame = new wxHtmlHelpFrame(&m_helpData);
m_helpFrame->PushEventHandler(this);
if (m_Config)
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->SetTitleFormat(m_titleFormat);
m_helpFrame->Show(TRUE);

68
src/html/helpdata.cpp
View File

@@ -118,7 +118,6 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
m_Level--;
return TRUE;
}
else if (tag.GetName() == "OBJECT") {
m_Name = m_Page = wxEmptyString;
ParseInner(tag);
@@ -136,7 +135,6 @@ bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
}
return TRUE;
}
else { // "PARAM"
if (m_Name == wxEmptyString && tag.GetParam("NAME") == "Name") m_Name = 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;
}
//-----------------------------------------------------------------------------
// wxHtmlHelpData
//-----------------------------------------------------------------------------
@@ -347,8 +348,7 @@ bool wxHtmlHelpData::AddBookParam(const wxString& title, const wxString& contfil
wxString safetitle;
if (! path.IsEmpty())
// workaround for bug in ChangePathTo(name, TRUE)
fsys.ChangePathTo(path+"/gaga");
fsys.ChangePathTo(path, TRUE);
bookr = new wxHtmlBookRecord(path + '/', title, deftopic);
@@ -376,8 +376,7 @@ bool wxHtmlHelpData::AddBookParam(const wxString& title, const wxString& contfil
SaveCachedBook(bookr, outs);
delete outs;
}
}
else {
} else {
LoadCachedBook(bookr, fi -> GetStream());
delete fi;
}
@@ -423,7 +422,9 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
lineptr = buff;
delete fi;
while ((lineptr = ReadLine(lineptr, linebuf)) != NULL) {
do {
lineptr = ReadLine(lineptr, linebuf);
if (strstr(linebuf, "Title=") == linebuf)
title = linebuf + strlen("Title=");
if (strstr(linebuf, "Default topic=") == linebuf)
@@ -432,7 +433,7 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
index = linebuf + strlen("Index file=");
if (strstr(linebuf, "Contents file=") == linebuf)
contents = linebuf + strlen("Contents file=");
}
} while (lineptr != NULL);
delete[] buff;
return AddBookParam(title, contents, index, start, fsys.GetPath());
@@ -577,4 +578,55 @@ wxASSERT(m_Active);
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

54
src/html/helpfrm.cpp
View File

@@ -53,7 +53,7 @@
// number of times that the contents/index creation progress dialog
// is updated.
static const int PROGRESS_STEP = 40;
#define PROGRESS_STEP 40
//--------------------------------------------------------------------------
// wxHtmlHelpTreeItemData
@@ -90,8 +90,7 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
if (data) {
m_Data = data;
m_DataCreated = FALSE;
}
else {
} else {
m_Data = new wxHtmlHelpData();
m_DataCreated = TRUE;
}
@@ -114,22 +113,21 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
m_ConfigRoot = wxEmptyString;
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.navig_on = TRUE;
m_Cfg.titleformat = _("Help: %s");
m_Cfg.style = wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH;
}
/* Create: builds the GUI components.
* with the style flag it's possible to toggle the toolbar, contents, index and search
* controls.
* 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_SearchButton may be NULL.
* 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)
*/
// Create: builds the GUI components.
// with the style flag it's possible to toggle the toolbar, contents, index and search
// controls.
// 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_SearchButton may be NULL.
// 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)
bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& title,
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));
if (style == wxHF_DEFAULTSTYLE)
style = m_Cfg.style;
if (! title.IsEmpty()) // overridden?
m_Cfg.titleformat = title;
int notebook_page = 0;
CreateStatusBar();
// 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);
toolBar -> SetMargins(2, 2);
wxBitmap* toolBarBitmaps[3];
@@ -200,8 +192,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& ti
m_HtmlWin = new wxHtmlWindow(m_Splitter);
m_NavigPan = new wxNotebook(m_Splitter, wxID_HTML_NOTEBOOK,
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);
}
@@ -430,7 +421,7 @@ void wxHtmlHelpFrame::CreateContents(bool show_progress)
for (i = 0; i < cnt; i++, it++) {
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))
break;
wxYield();
@@ -444,8 +435,7 @@ void wxHtmlHelpFrame::CreateContents(bool show_progress)
m_ContentsBox -> SetItemImage(roots[1], IMG_Book);
m_ContentsBox -> SetItemSelectedImage(roots[1], IMG_Book);
imaged[1] = TRUE;
}
else imaged[it -> m_Level + 1] = FALSE;
} else imaged[it -> m_Level + 1] = FALSE;
if (!imaged[it -> m_Level]) {
m_ContentsBox -> SetItemImage(roots[it -> m_Level], IMG_Folder);
@@ -480,7 +470,7 @@ void wxHtmlHelpFrame::CreateIndex(bool show_progress)
wxPD_AUTO_HIDE);
for (int i = 0; i < cnt; i++) {
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))
break;
wxYield();
@@ -530,8 +520,6 @@ void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
m_Cfg.y = cfg -> Read("hcY", m_Cfg.y);
m_Cfg.w = cfg -> Read("hcW", m_Cfg.w);
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)
m_HtmlWin->ReadCustomization(cfg, path);
@@ -544,7 +532,6 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path
{
wxString oldpath;
wxString tmp;
//printf("wxHtmlHelpFrame. Writing config to %s\n", (const char*)path);
if (path != wxEmptyString) {
oldpath = cfg -> GetPath();
@@ -557,8 +544,6 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path
cfg -> Write("hcY", (long)m_Cfg.y);
cfg -> Write("hcW", (long)m_Cfg.w);
cfg -> Write("hcH", (long)m_Cfg.h);
cfg -> Write("hcTitleFormat", m_Cfg.titleformat);
cfg -> Write("hcStyle", (long)m_Cfg.style);
if (m_HtmlWin)
m_HtmlWin->WriteCustomization(cfg, path);
@@ -588,8 +573,7 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
if (m_Splitter -> IsSplit()) {
m_Cfg.sashpos = m_Splitter -> GetSashPosition();
m_Splitter -> Unsplit(m_NavigPan);
}
else {
} else {
m_NavigPan -> Show(TRUE);
m_HtmlWin -> Show(TRUE);
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