// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma implementation "helpdata.h"
#endif
// For compilers that support precompilation, includes "wx.h".
#if wxUSE_HTML && wxUSE_STREAMS
#ifndef WXPRECOMP
-#include "wx/wx.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
#endif
+#include <ctype.h>
+
#include "wx/html/helpdata.h"
#include "wx/tokenzr.h"
#include "wx/wfstream.h"
#include "wx/log.h"
#include "wx/html/htmlpars.h"
#include "wx/html/htmldefs.h"
+#include "wx/html/htmlfilt.h"
+#include "wx/filename.h"
#include "wx/arrimpl.cpp"
WX_DEFINE_OBJARRAY(wxHtmlBookRecArray)
//-----------------------------------------------------------------------------
// Reads one line, stores it into buf and returns pointer to new line or NULL.
-static char* ReadLine(char *line, char *buf)
+static const wxChar* ReadLine(const wxChar *line, wxChar *buf, size_t bufsize)
{
- char *writeptr = buf, *readptr = line;
+ wxChar *writeptr = buf;
+ wxChar *endptr = buf + bufsize - 1;
+ const wxChar *readptr = line;
- while (*readptr != 0 && *readptr != '\r' && *readptr != '\n') *(writeptr++) = *(readptr++);
+ while (*readptr != 0 && *readptr != _T('\r') && *readptr != _T('\n') &&
+ writeptr != endptr)
+ *(writeptr++) = *(readptr++);
*writeptr = 0;
- while (*readptr == '\r' || *readptr == '\n') readptr++;
- if (*readptr == 0) return NULL;
- else return readptr;
+ while (*readptr == _T('\r') || *readptr == _T('\n'))
+ readptr++;
+ if (*readptr == 0)
+ return NULL;
+ else
+ return readptr;
}
-static int LINKAGEMODE IndexCompareFunc(const void *a, const void *b)
+extern "C" int LINKAGEMODE
+wxHtmlHelpIndexCompareFunc(const void *a, const void *b)
{
- return wxStrcmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name);
+ return wxStricmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name);
}
class HP_Parser : public wxHtmlParser
{
- public:
- void AddText(const char* WXUNUSED(text)) { }
- wxObject* GetProduct() { return NULL; }
+public:
+ HP_Parser() { }
+
+ wxObject* GetProduct() { return NULL; }
+
+protected:
+ virtual void AddText(const wxChar* WXUNUSED(txt)) {}
+
+ DECLARE_NO_COPY_CLASS(HP_Parser)
};
wxHtmlContentsItem *m_Items;
int m_ItemsCnt;
wxHtmlBookRecord *m_Book;
- bool m_firstTime; // For checking if we're adding sections at level zero, so we 'delete' the first one
public:
- HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler()
- { m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString;
- m_Level = 0; m_ID = -1; m_firstTime = TRUE; }
+ HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler()
+ { m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString;
+ m_Level = 0; m_ID = -1; }
wxString GetSupportedTags() { return wxT("UL,OBJECT,PARAM"); }
bool HandleTag(const wxHtmlTag& tag);
void WriteOut(wxHtmlContentsItem*& array, int& size);
void ReadIn(wxHtmlContentsItem* array, int size);
+
+ DECLARE_NO_COPY_CLASS(HP_TagHandler)
};
bool HP_TagHandler::HandleTag(const wxHtmlTag& tag)
{
- if (tag.GetName() == wxT("UL"))
+ if (tag.GetName() == wxT("UL"))
{
m_Level++;
ParseInner(tag);
m_Level--;
return TRUE;
}
- else if (tag.GetName() == wxT("OBJECT"))
+ else if (tag.GetName() == wxT("OBJECT"))
{
m_Name = m_Page = wxEmptyString;
ParseInner(tag);
- if (tag.GetParam("TYPE") == "text/sitemap")
-
- // if (!m_Page.IsEmpty())
+#if 0
+ if (!m_Page.IsEmpty())
/* Valid HHW's file may contain only two object tags:
-
+
<OBJECT type="text/site properties">
<param name="ImageType" value="Folder">
</OBJECT>
-
+
or
-
- <OBJECT type="text/sitemap">
- <param name="Name" value="main page">
- <param name="Local" value="another.htm">
- </OBJECT>
-
+
+ <OBJECT type="text/sitemap">
+ <param name="Name" value="main page">
+ <param name="Local" value="another.htm">
+ </OBJECT>
+
We're interested in the latter. !m_Page.IsEmpty() is valid
condition because text/site properties does not contain Local param
*/
+#endif
+ if (tag.GetParam(wxT("TYPE")) == wxT("text/sitemap"))
{
- // We're reading in items at level zero, which must mean we want to specify
- // our own 'books', so chuck out the first (empty) one that AddBook already
- // created
- if (m_firstTime && (m_Level == 0) && (m_ItemsCnt > 0))
- {
- m_ItemsCnt --;
- }
- else
- {
- if (m_ItemsCnt % wxHTML_REALLOC_STEP == 0)
- m_Items = (wxHtmlContentsItem*) realloc(m_Items, (m_ItemsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem));
- }
+ if (m_ItemsCnt % wxHTML_REALLOC_STEP == 0)
+ m_Items = (wxHtmlContentsItem*) realloc(m_Items,
+ (m_ItemsCnt + wxHTML_REALLOC_STEP) *
+ sizeof(wxHtmlContentsItem));
+
m_Items[m_ItemsCnt].m_Level = m_Level;
m_Items[m_ItemsCnt].m_ID = m_ID;
m_Items[m_ItemsCnt].m_Page = new wxChar[m_Page.Length() + 1];
wxStrcpy(m_Items[m_ItemsCnt].m_Name, m_Name.c_str());
m_Items[m_ItemsCnt].m_Book = m_Book;
m_ItemsCnt++;
-
- m_firstTime = FALSE;
}
return TRUE;
}
- else
+ else
{ // "PARAM"
- if (m_Name == wxEmptyString && tag.GetParam(wxT("NAME")) == wxT("Name"))
- {
+ if (m_Name == wxEmptyString && tag.GetParam(wxT("NAME")) == wxT("Name"))
m_Name = tag.GetParam(wxT("VALUE"));
- if (m_Name.Find(wxT('&')) != -1)
- {
- #define ESCSEQ(escape, subst) \
- { _T("&") _T(escape) _T(";"), _T("&") _T(escape) _T(" "), _T(subst) }
- static wxChar* substitutions[][3] =
- {
- ESCSEQ("quot", "\""),
- ESCSEQ("lt", "<"),
- ESCSEQ("gt", ">"),
-
- ESCSEQ("nbsp", " "),
- ESCSEQ("iexcl", "!"),
- ESCSEQ("cent", "\242"/* ¢ */),
-
- ESCSEQ("yen", " "),
- ESCSEQ("brkbar", " "),
- ESCSEQ("sect", " "),
- ESCSEQ("uml", " "),
-
- ESCSEQ("copy", "(c)"),
- ESCSEQ("ordf", " "),
- ESCSEQ("laquo", " "),
- ESCSEQ("not", " "),
-
- ESCSEQ("reg", "(r)"),
-
- ESCSEQ("deg", " "),
- ESCSEQ("plusm", " "),
-
- ESCSEQ("acute", " "),
- ESCSEQ("micro", " "),
- ESCSEQ("para", " "),
-
- ESCSEQ("ordm", " "),
- ESCSEQ("raquo", " "),
-
- ESCSEQ("iquest", " "),
- ESCSEQ("Agrave", "\300"/* À */),
-
- ESCSEQ("Acirc", "\302"/* Â */),
- ESCSEQ("Atilde", "\303"/* Ã */),
- ESCSEQ("Auml", "\304"/* Ä */),
- ESCSEQ("Aring", " "),
- ESCSEQ("AElig", " "),
- ESCSEQ("Ccedil", "\347"/* ç */),
- ESCSEQ("Egrave", "\310"/* È */),
- ESCSEQ("Eacute", "\311"/* É */),
- ESCSEQ("Ecirc", "\312"/* Ê */),
- ESCSEQ("Euml", "\313"/* Ë */),
- ESCSEQ("Igrave", "\314"/* Ì */),
-
- ESCSEQ("Icirc", "\316"/* Î */),
- ESCSEQ("Iuml", "\317"/* Ï */),
-
- ESCSEQ("Ntilde", "\321"/* Ñ */),
- ESCSEQ("Ograve", "\322"/* Ò */),
-
- ESCSEQ("Ocirc", "\324"/* Ô */),
- ESCSEQ("Otilde", "\325"/* Õ */),
- ESCSEQ("Ouml", "\326"/* Ö */),
-
- ESCSEQ("Oslash", " "),
- ESCSEQ("Ugrave", "\331"/* Ù */),
-
- ESCSEQ("Ucirc", " "),
- ESCSEQ("Uuml", "\334"/* Ü */),
-
- ESCSEQ("szlig", "\247"/* § */),
- ESCSEQ("agrave;","à"),
- ESCSEQ("aacute", "\341"/* á */),
- ESCSEQ("acirc", "\342"/* â */),
- ESCSEQ("atilde", "\343"/* ã */),
- ESCSEQ("auml", "\344"/* ä */),
- ESCSEQ("aring", "a"),
- ESCSEQ("aelig", "ae"),
- ESCSEQ("ccedil", "\347"/* ç */),
- ESCSEQ("egrave", "\350"/* è */),
- ESCSEQ("eacute", "\351"/* é */),
- ESCSEQ("ecirc", "\352"/* ê */),
- ESCSEQ("euml", "\353"/* ë */),
- ESCSEQ("igrave", "\354"/* ì */),
- ESCSEQ("iacute", "\355"/* í */),
- ESCSEQ("icirc", " "),
- ESCSEQ("iuml", "\357"/* ï */),
- ESCSEQ("eth", " "),
- ESCSEQ("ntilde", "\361"/* ñ */),
- ESCSEQ("ograve", "\362"/* ò */),
- ESCSEQ("oacute", "\363"/* ó */),
- ESCSEQ("ocirc", "\364"/* ô */),
- ESCSEQ("otilde", "\365"/* õ */),
- ESCSEQ("ouml", "\366"/* ö */),
- ESCSEQ("divide", " "),
- ESCSEQ("oslash", " "),
- ESCSEQ("ugrave", "\371"/* ù */),
- ESCSEQ("uacute", "\372"/* ú */),
- ESCSEQ("ucirc", "\373"/* û */),
- ESCSEQ("uuml", "\374"/* ü */),
-
- ESCSEQ("yuml", ""),
-
- /* this one should ALWAYS stay the last one!!! */
- ESCSEQ("amp", "&"),
-
- { NULL, NULL, NULL }
- };
-
- for (int i = 0; substitutions[i][0] != NULL; i++)
- {
- m_Name.Replace(substitutions[i][0], substitutions[i][2], TRUE);
- m_Name.Replace(substitutions[i][1], substitutions[i][2], TRUE);
- }
- }
- }
- if (tag.GetParam(wxT("NAME")) == wxT("Local")) m_Page = tag.GetParam(wxT("VALUE"));
- if (tag.GetParam(wxT("NAME")) == wxT("ID")) tag.ScanParam(wxT("VALUE"), wxT("%i"), &m_ID);
+ if (tag.GetParam(wxT("NAME")) == wxT("Local"))
+ m_Page = tag.GetParam(wxT("VALUE"));
+ if (tag.GetParam(wxT("NAME")) == wxT("ID"))
+ tag.GetParamAsInt(wxT("VALUE"), &m_ID);
return FALSE;
}
}
// wxHtmlHelpData
//-----------------------------------------------------------------------------
+wxString wxHtmlBookRecord::GetFullPath(const wxString &page) const
+{
+ if (wxIsAbsolutePath(page))
+ return page;
+ else
+ return m_BasePath + page;
+}
+
+
+
IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpData, wxObject)
wxHtmlHelpData::wxHtmlHelpData()
int i;
m_BookRecords.Empty();
- if (m_Contents)
+ if (m_Contents)
{
- for (i = 0; i < m_ContentsCnt; i++)
- {
+ for (i = 0; i < m_ContentsCnt; i++)
+ {
delete[] m_Contents[i].m_Page;
delete[] m_Contents[i].m_Name;
}
free(m_Contents);
}
- if (m_Index)
+ if (m_Index)
{
- for (i = 0; i < m_IndexCnt; i++)
- {
+ for (i = 0; i < m_IndexCnt; i++)
+ {
delete[] m_Index[i].m_Page;
delete[] m_Index[i].m_Name;
}
bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, const wxString& indexfile, const wxString& contentsfile)
{
wxFSFile *f;
- char *buf;
- int sz;
+ wxHtmlFilterHTML filter;
+ wxString buf;
wxString string;
HP_Parser parser;
parser.AddTagHandler(handler);
f = ( contentsfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(contentsfile) );
- if (f)
+ if (f)
{
- sz = f->GetStream()->GetSize();
- buf = new char[sz + 1];
- buf[sz] = 0;
- f->GetStream()->Read(buf, sz);
+ buf.clear();
+ buf = filter.ReadFile(*f);
delete f;
handler->ReadIn(m_Contents, m_ContentsCnt);
parser.Parse(buf);
handler->WriteOut(m_Contents, m_ContentsCnt);
- delete[] buf;
}
else
+ {
wxLogError(_("Cannot open contents file: %s"), contentsfile.c_str());
+ }
f = ( indexfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(indexfile) );
- if (f)
+ if (f)
{
- sz = f->GetStream()->GetSize();
- buf = new char[sz + 1];
- buf[sz] = 0;
- f->GetStream()->Read(buf, sz);
+ buf.clear();
+ buf = filter.ReadFile(*f);
delete f;
handler->ReadIn(m_Index, m_IndexCnt);
parser.Parse(buf);
handler->WriteOut(m_Index, m_IndexCnt);
- delete[] buf;
}
else if (!indexfile.IsEmpty())
+ {
wxLogError(_("Cannot open index file: %s"), indexfile.c_str());
+ }
return TRUE;
}
+inline static void CacheWriteInt32(wxOutputStream *f, wxInt32 value)
+{
+ wxInt32 x = wxINT32_SWAP_ON_BE(value);
+ f->Write(&x, sizeof(x));
+}
-#if wxUSE_UNICODE
-
-#define READ_STRING(f, s, lng) { char tmpc; for (int i = 0; i < lng; i++) { f->Read(&tmpc, 1); s[i] = (wxChar)tmpc;} }
-#define WRITE_STRING(f, s, lng) { char tmpc; for (int i = 0; i < lng; i++) { tmpc = (char)s[i]; f->Write(&tmpc, 1);} }
+inline static wxInt32 CacheReadInt32(wxInputStream *f)
+{
+ wxInt32 x;
+ f->Read(&x, sizeof(x));
+ return wxINT32_SWAP_ON_BE(x);
+}
+inline static void CacheWriteString(wxOutputStream *f, const wxChar *str)
+{
+#if wxUSE_UNICODE
+ wxWX2MBbuf mbstr(wxConvUTF8.cWX2MB(str));
#else
+ const wxChar *mbstr = str;
+#endif
+ size_t len = strlen(mbstr)+1;
+ CacheWriteInt32(f, len);
+ f->Write(mbstr, len);
+}
-#define READ_STRING(f, s, lng) f->Read(s, lng * sizeof(char));
-#define WRITE_STRING(f, s, lng) f->Write(s, lng * sizeof(char));
-
+inline static wxChar* CacheReadString(wxInputStream *f)
+{
+ char *str;
+ size_t len = (size_t)CacheReadInt32(f);
+ str = new char[len];
+ f->Read(str, len);
+#if !wxUSE_UNICODE
+ return str;
+#else
+ wxMB2WXbuf wxstr(wxConvUTF8.cMB2WX(str));
+ wxChar *outstr = new wxChar[wxStrlen(wxstr)+1];
+ wxStrcpy(outstr, wxstr);
+ return outstr;
#endif
+}
+#define CURRENT_CACHED_BOOK_VERSION 4
+
+// Additional flags to detect incompatibilities of the runtime environment:
+#define CACHED_BOOK_FORMAT_FLAGS \
+ (wxUSE_UNICODE << 0)
-#define CURRENT_CACHED_BOOK_VERSION 1
bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f)
{
int i, st;
- wxInt32 x;
wxInt32 version;
/* load header - version info : */
-
- f->Read(&x, sizeof(x));
- version = wxINT32_SWAP_ON_BE(x);
+ version = CacheReadInt32(f);
- if (version != CURRENT_CACHED_BOOK_VERSION)
+ if (version != CURRENT_CACHED_BOOK_VERSION)
{
- wxLogError(_("Incorrect version of HTML help book"));
+ // NB: We can just silently return FALSE here and don't worry about
+ // it anymore, because AddBookParam will load the MS project in
+ // absence of (properly versioned) .cached file and automatically
+ // create new .cached file immediately afterward.
return FALSE;
- // NOTE: when adding new version, please ensure backward compatibility!
}
-
- /* load contents : */
- f->Read(&x, sizeof(x));
+ if (CacheReadInt32(f) != CACHED_BOOK_FORMAT_FLAGS)
+ return FALSE;
+
+ /* load contents : */
st = m_ContentsCnt;
- m_ContentsCnt += wxINT32_SWAP_ON_BE(x);
- m_Contents = (wxHtmlContentsItem*) realloc(m_Contents,
- (m_ContentsCnt / wxHTML_REALLOC_STEP + 1) *
+ m_ContentsCnt += CacheReadInt32(f);
+ m_Contents = (wxHtmlContentsItem*) realloc(m_Contents,
+ (m_ContentsCnt / wxHTML_REALLOC_STEP + 1) *
wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
- for (i = st; i < m_ContentsCnt; i++)
- {
- f->Read(&x, sizeof(x));
- m_Contents[i].m_Level = wxINT32_SWAP_ON_BE(x);
- f->Read(&x, sizeof(x));
- m_Contents[i].m_ID = wxINT32_SWAP_ON_BE(x);
- f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
- m_Contents[i].m_Name = new wxChar[x];
- READ_STRING(f, m_Contents[i].m_Name, x);
- f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
- m_Contents[i].m_Page = new wxChar[x];
- READ_STRING(f, m_Contents[i].m_Page, x);
+ for (i = st; i < m_ContentsCnt; i++)
+ {
+ m_Contents[i].m_Level = CacheReadInt32(f);
+ m_Contents[i].m_ID = CacheReadInt32(f);
+ m_Contents[i].m_Name = CacheReadString(f);
+ m_Contents[i].m_Page = CacheReadString(f);
m_Contents[i].m_Book = book;
}
/* load index : */
-
- f->Read(&x, sizeof(x));
st = m_IndexCnt;
- m_IndexCnt += wxINT32_SWAP_ON_BE(x);
- m_Index = (wxHtmlContentsItem*) realloc(m_Index, (m_IndexCnt / wxHTML_REALLOC_STEP + 1) *
+ m_IndexCnt += CacheReadInt32(f);
+ m_Index = (wxHtmlContentsItem*) realloc(m_Index, (m_IndexCnt / wxHTML_REALLOC_STEP + 1) *
wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
- for (i = st; i < m_IndexCnt; i++)
- {
- f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
- m_Index[i].m_Name = new wxChar[x];
- READ_STRING(f, m_Index[i].m_Name, x);
- f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
- m_Index[i].m_Page = new wxChar[x];
- READ_STRING(f, m_Index[i].m_Page, x);
+ for (i = st; i < m_IndexCnt; i++)
+ {
+ m_Index[i].m_Name = CacheReadString(f);
+ m_Index[i].m_Page = CacheReadString(f);
m_Index[i].m_Book = book;
}
return TRUE;
bool wxHtmlHelpData::SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f)
{
int i;
- wxInt32 x;
+ wxInt32 cnt;
/* save header - version info : */
-
- x = wxINT32_SWAP_ON_BE(CURRENT_CACHED_BOOK_VERSION);
- f->Write(&x, sizeof(x));
+ CacheWriteInt32(f, CURRENT_CACHED_BOOK_VERSION);
+ CacheWriteInt32(f, CACHED_BOOK_FORMAT_FLAGS);
/* save contents : */
+ for (cnt = 0, i = 0; i < m_ContentsCnt; i++)
+ if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0)
+ cnt++;
+ CacheWriteInt32(f, cnt);
- x = 0;
- for (i = 0; i < m_ContentsCnt; i++) if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0) x++;
- x = wxINT32_SWAP_ON_BE(x);
- f->Write(&x, sizeof(x));
- for (i = 0; i < m_ContentsCnt; i++)
+ for (i = 0; i < m_ContentsCnt; i++)
{
- if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0) continue;
- x = wxINT32_SWAP_ON_BE(m_Contents[i].m_Level);
- f->Write(&x, sizeof(x));
- x = wxINT32_SWAP_ON_BE(m_Contents[i].m_ID);
- f->Write(&x, sizeof(x));
- x = wxINT32_SWAP_ON_BE(wxStrlen(m_Contents[i].m_Name) + 1);
- f->Write(&x, sizeof(x));
- WRITE_STRING(f, m_Contents[i].m_Name, x);
- x = wxINT32_SWAP_ON_BE(wxStrlen(m_Contents[i].m_Page) + 1);
- f->Write(&x, sizeof(x));
- WRITE_STRING(f, m_Contents[i].m_Page, x);
+ if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0)
+ continue;
+ CacheWriteInt32(f, m_Contents[i].m_Level);
+ CacheWriteInt32(f, m_Contents[i].m_ID);
+ CacheWriteString(f, m_Contents[i].m_Name);
+ CacheWriteString(f, m_Contents[i].m_Page);
}
/* save index : */
+ for (cnt = 0, i = 0; i < m_IndexCnt; i++)
+ if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0)
+ cnt++;
+ CacheWriteInt32(f, cnt);
- x = 0;
- for (i = 0; i < m_IndexCnt; i++) if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0) x++;
- x = wxINT32_SWAP_ON_BE(x);
- f->Write(&x, sizeof(x));
- for (i = 0; i < m_IndexCnt; i++)
+ for (i = 0; i < m_IndexCnt; i++)
{
- if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0) continue;
- x = wxINT32_SWAP_ON_BE(wxStrlen(m_Index[i].m_Name) + 1);
- f->Write(&x, sizeof(x));
- WRITE_STRING(f, m_Index[i].m_Name, x);
- x = wxINT32_SWAP_ON_BE(wxStrlen(m_Index[i].m_Page) + 1);
- f->Write(&x, sizeof(x));
- WRITE_STRING(f, m_Index[i].m_Page, x);
+ if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0)
+ continue;
+ CacheWriteString(f, m_Index[i].m_Name);
+ CacheWriteString(f, m_Index[i].m_Page);
}
return TRUE;
}
void wxHtmlHelpData::SetTempDir(const wxString& path)
{
if (path == wxEmptyString) m_TempPath = path;
- else
+ else
{
if (wxIsAbsolutePath(path)) m_TempPath = path;
else m_TempPath = wxGetCwd() + _T("/") + path;
wxFileSystem fsys;
wxFSFile *fi;
wxHtmlBookRecord *bookr;
-
+
int IndexOld = m_IndexCnt,
ContentsOld = m_ContentsCnt;
- if (! path.IsEmpty())
+ if (!path.IsEmpty())
fsys.ChangePathTo(path, TRUE);
- bookr = new wxHtmlBookRecord(fsys.GetPath(), title, deftopic);
+ size_t booksCnt = m_BookRecords.GetCount();
+ for (size_t i = 0; i < booksCnt; i++)
+ {
+ if ( m_BookRecords[i].GetBookFile() == bookfile.GetLocation() )
+ return TRUE; // book is (was) loaded
+ }
+ bookr = new wxHtmlBookRecord(bookfile.GetLocation(), fsys.GetPath(), title, deftopic);
+
if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0)
m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem));
m_Contents[m_ContentsCnt].m_Level = 0;
// 1. save file as book, but with .hhp.cached extension
// 2. same as 1. but in temp path
// 3. otherwise or if cache load failed, load it from MS.
-
+
fi = fsys.OpenFile(bookfile.GetLocation() + wxT(".cached"));
-
- if (fi == NULL ||
- fi->GetModificationTime() < bookfile.GetModificationTime() ||
+
+ if (fi == NULL ||
+#if wxUSE_DATETIME
+ fi->GetModificationTime() < bookfile.GetModificationTime() ||
+#endif // wxUSE_DATETIME
!LoadCachedBook(bookr, fi->GetStream()))
{
if (fi != NULL) delete fi;
fi = fsys.OpenFile(m_TempPath + wxFileNameFromPath(bookfile.GetLocation()) + wxT(".cached"));
- if (m_TempPath == wxEmptyString || fi == NULL ||
- fi->GetModificationTime() < bookfile.GetModificationTime() ||
+ if (m_TempPath == wxEmptyString || fi == NULL ||
+#if wxUSE_DATETIME
+ fi->GetModificationTime() < bookfile.GetModificationTime() ||
+#endif // wxUSE_DATETIME
!LoadCachedBook(bookr, fi->GetStream()))
{
LoadMSProject(bookr, fsys, indexfile, contfile);
- if (m_TempPath != wxEmptyString)
+ if (m_TempPath != wxEmptyString)
{
- wxFileOutputStream *outs = new wxFileOutputStream(m_TempPath +
+ wxFileOutputStream *outs = new wxFileOutputStream(m_TempPath +
SafeFileName(wxFileNameFromPath(bookfile.GetLocation())) + wxT(".cached"));
SaveCachedBook(bookr, outs);
delete outs;
}
}
}
-
+
if (fi != NULL) delete fi;
// Now store the contents range
bookr->SetContentsRange(cont_start, m_ContentsCnt);
-
+
// Convert encoding, if neccessary:
if (encoding != wxFONTENCODING_SYSTEM)
{
int i;
wxEncodingConverter conv;
conv.Init(encoding, a[0]);
-
+
for (i = IndexOld; i < m_IndexCnt; i++)
conv.Convert(m_Index[i].m_Name);
for (i = ContentsOld; i < m_ContentsCnt; i++)
m_BookRecords.Add(bookr);
if (m_IndexCnt > 0)
- qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), IndexCompareFunc);
+ qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), wxHtmlHelpIndexCompareFunc);
return TRUE;
}
bool wxHtmlHelpData::AddBook(const wxString& book)
{
- if (book.Right(4).Lower() == wxT(".zip") ||
- book.Right(4).Lower() == wxT(".htb") /*html book*/)
-
+ wxString extension(book.Right(4).Lower());
+ if (extension == wxT(".zip") ||
+#if wxUSE_LIBMSPACK
+ extension == wxT(".chm") /*compressed html help book*/ ||
+#endif
+ extension == wxT(".htb") /*html book*/)
{
wxFileSystem fsys;
wxString s;
bool rt = FALSE;
- s = fsys.FindFirst(book + wxT("#zip:") + wxT("*.hhp"), wxFILE);
- while (!s.IsEmpty())
+#if wxUSE_LIBMSPACK
+ if (extension == wxT(".chm"))
+ s = fsys.FindFirst(book + wxT("#chm:*.hhp"), wxFILE);
+ else
+#endif
+ s = fsys.FindFirst(book + wxT("#zip:*.hhp"), wxFILE);
+
+ while (!s.IsEmpty())
{
if (AddBook(s)) rt = TRUE;
s = fsys.FindNext();
}
-
+
return rt;
}
+ wxFSFile *fi;
+ wxFileSystem fsys;
- else
- {
- wxFSFile *fi;
- wxFileSystem fsys;
- wxInputStream *s;
- wxString bookFull;
-
- int sz;
- char *buff, *lineptr;
- char linebuf[300];
+ wxString title = _("noname"),
+ safetitle,
+ start = wxEmptyString,
+ contents = wxEmptyString,
+ index = wxEmptyString,
+ charset = wxEmptyString;
- wxString title = _("noname"),
- safetitle,
- start = wxEmptyString,
- contents = wxEmptyString,
- index = wxEmptyString,
- charset = wxEmptyString;
+ fi = fsys.OpenFile(book);
+ if (fi == NULL)
+ {
+ wxLogError(_("Cannot open HTML help book: %s"), book.c_str());
+ return FALSE;
+ }
+ fsys.ChangePathTo(book);
- if (wxIsAbsolutePath(book)) bookFull = book;
- else bookFull = wxGetCwd() + "/" + book;
+ const wxChar *lineptr;
+ wxChar linebuf[300];
+ wxString tmp;
+ wxHtmlFilterPlainText filter;
+ tmp = filter.ReadFile(*fi);
+ lineptr = tmp.c_str();
- fi = fsys.OpenFile(bookFull);
- if (fi == NULL)
- {
- wxLogError(_("Cannot open HTML help book: %s"), bookFull.c_str());
- return FALSE;
- }
- fsys.ChangePathTo(bookFull);
- s = fi->GetStream();
- sz = s->GetSize();
- buff = new char[sz + 1];
- buff[sz] = 0;
- s->Read(buff, sz);
- lineptr = buff;
-
- do {
- lineptr = ReadLine(lineptr, linebuf);
-
- if (strstr(linebuf, "Title=") == linebuf)
- title = linebuf + strlen("Title=");
- if (strstr(linebuf, "Default topic=") == linebuf)
- start = linebuf + strlen("Default topic=");
- if (strstr(linebuf, "Index file=") == linebuf)
- index = linebuf + strlen("Index file=");
- if (strstr(linebuf, "Contents file=") == linebuf)
- contents = linebuf + strlen("Contents file=");
- if (strstr(linebuf, "Charset=") == linebuf)
- charset = linebuf + strlen("Charset=");
- } while (lineptr != NULL);
- delete[] buff;
-
- wxFontEncoding enc;
- if (charset == wxEmptyString) enc = wxFONTENCODING_SYSTEM;
- else enc = wxTheFontMapper->CharsetToEncoding(charset);
- bool rtval = AddBookParam(*fi, enc,
- title, contents, index, start, fsys.GetPath());
- delete fi;
- return rtval;
- }
+ do
+ {
+ lineptr = ReadLine(lineptr, linebuf, 300);
+
+ for (wxChar *ch = linebuf; *ch != wxT('\0') && *ch != wxT('='); ch++)
+ *ch = tolower(*ch);
+
+ if (wxStrstr(linebuf, _T("title=")) == linebuf)
+ title = linebuf + wxStrlen(_T("title="));
+ if (wxStrstr(linebuf, _T("default topic=")) == linebuf)
+ start = linebuf + wxStrlen(_T("default topic="));
+ if (wxStrstr(linebuf, _T("index file=")) == linebuf)
+ index = linebuf + wxStrlen(_T("index file="));
+ if (wxStrstr(linebuf, _T("contents file=")) == linebuf)
+ contents = linebuf + wxStrlen(_T("contents file="));
+ if (wxStrstr(linebuf, _T("charset=")) == linebuf)
+ charset = linebuf + wxStrlen(_T("charset="));
+ } while (lineptr != NULL);
+
+ wxFontEncoding enc;
+ if (charset == wxEmptyString) enc = wxFONTENCODING_SYSTEM;
+ else enc = wxFontMapper::Get()->CharsetToEncoding(charset);
+ bool rtval = AddBookParam(*fi, enc,
+ title, contents, index, start, fsys.GetPath());
+ delete fi;
+ return rtval;
}
wxString wxHtmlHelpData::FindPageByName(const wxString& x)
/* 1. try to open given file: */
cnt = m_BookRecords.GetCount();
- for (i = 0; i < cnt; i++)
+ for (i = 0; i < cnt; i++)
{
- f = fsys.OpenFile(m_BookRecords[i].GetBasePath() + x);
- if (f)
- {
- url = m_BookRecords[i].GetBasePath() + x;
+ f = fsys.OpenFile(m_BookRecords[i].GetFullPath(x));
+ if (f)
+ {
+ url = m_BookRecords[i].GetFullPath(x);
delete f;
return url;
}
/* 2. try to find a book: */
- for (i = 0; i < cnt; i++)
+ for (i = 0; i < cnt; i++)
{
- if (m_BookRecords[i].GetTitle() == x)
- {
- url = m_BookRecords[i].GetBasePath() + m_BookRecords[i].GetStart();
+ if (m_BookRecords[i].GetTitle() == x)
+ {
+ url = m_BookRecords[i].GetFullPath(m_BookRecords[i].GetStart());
return url;
}
}
/* 3. try to find in contents: */
cnt = m_ContentsCnt;
- for (i = 0; i < cnt; i++)
+ for (i = 0; i < cnt; i++)
{
- if (wxStrcmp(m_Contents[i].m_Name, x) == 0)
- {
- url = m_Contents[i].m_Book->GetBasePath() + m_Contents[i].m_Page;
+ if (wxStrcmp(m_Contents[i].m_Name, x) == 0)
+ {
+ url = m_Contents[i].GetFullPath();
return url;
}
}
/* 4. try to find in index: */
cnt = m_IndexCnt;
- for (i = 0; i < cnt; i++)
+ for (i = 0; i < cnt; i++)
{
- if (wxStrcmp(m_Index[i].m_Name, x) == 0)
- {
- url = m_Index[i].m_Book->GetBasePath() + m_Index[i].m_Page;
+ if (wxStrcmp(m_Index[i].m_Name, x) == 0)
+ {
+ url = m_Index[i].GetFullPath();
return url;
}
}
int i;
wxString url(wxEmptyString);
- for (i = 0; i < m_ContentsCnt; i++)
+ for (i = 0; i < m_ContentsCnt; i++)
{
- if (m_Contents[i].m_ID == id)
- {
- url = m_Contents[i].m_Book->GetBasePath() + m_Contents[i].m_Page;
+ if (m_Contents[i].m_ID == id)
+ {
+ url = m_Contents[i].GetFullPath();
return url;
}
}
m_Data = data;
m_Keyword = keyword;
wxHtmlBookRecord* bookr = NULL;
- if (book != wxEmptyString)
+ if (book != wxEmptyString)
{
// we have to search in a specific book. Find it first
int i, cnt = data->m_BookRecords.GetCount();
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]);
m_CurIndex = bookr->GetContentsStart();
m_MaxIndex = bookr->GetContentsEnd();
// check; we won't crash if the book doesn't exist, but it's Bad Anyway.
wxASSERT(bookr);
}
- if (! bookr)
+ if (! bookr)
{
// no book specified; search all books
m_CurIndex = 0;
bool found = FALSE;
wxChar *thepage;
- if (!m_Active)
+ if (!m_Active)
{
// sanity check. Illegal use, but we'll try to prevent a crash anyway
wxASSERT(m_Active);
if (m_LastPage != NULL)
{
wxChar *p1, *p2;
- for (p1 = thepage, p2 = m_LastPage;
+ for (p1 = thepage, p2 = m_LastPage;
*p1 != 0 && *p1 != _T('#') && *p1 == *p2; p1++, p2++) {}
m_LastPage = thepage;
return FALSE;
}
else m_LastPage = thepage;
-
+
wxFileSystem fsys;
- file = fsys.OpenFile(m_Data->m_Contents[i].m_Book->GetBasePath() + thepage);
- if (file)
+ file = fsys.OpenFile(m_Data->m_Contents[i].m_Book->GetFullPath(thepage));
+ if (file)
{
- if (m_Engine.Scan(file->GetStream())) {
+ if (m_Engine.Scan(*file))
+ {
m_Name = m_Data->m_Contents[i].m_Name;
m_ContentsItem = m_Data->m_Contents + i;
found = TRUE;
//--------------------------------------------------------------------------------
-// wxSearchEngine
+// wxHtmlSearchEngine
//--------------------------------------------------------------------------------
-void wxSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only)
+void wxHtmlSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only)
{
m_CaseSensitive = case_sensitive;
m_WholeWords = whole_words_only;
if (m_Keyword) delete[] m_Keyword;
m_Keyword = new wxChar[keyword.Length() + 1];
wxStrcpy(m_Keyword, keyword.c_str());
-
+
if (!m_CaseSensitive)
{
for (int i = wxStrlen(m_Keyword) - 1; i >= 0; i--)
- {
+ {
if ((m_Keyword[i] >= wxT('A')) && (m_Keyword[i] <= wxT('Z')))
m_Keyword[i] += wxT('a') - wxT('A');
- }
- }
+ }
+ }
}
+static inline bool WHITESPACE(wxChar c)
+{
+ return c == _T(' ') || c == _T('\n') || c == _T('\r') || c == _T('\t');
+}
-#define WHITESPACE(c) (c == ' ' || c == '\n' || c == '\r' || c == '\t')
-
-bool wxSearchEngine::Scan(wxInputStream *stream)
+bool wxHtmlSearchEngine::Scan(const wxFSFile& file)
{
- wxASSERT_MSG(m_Keyword != NULL, wxT("wxSearchEngine::LookFor must be called before scanning!"));
+ wxASSERT_MSG(m_Keyword != NULL, wxT("wxHtmlSearchEngine::LookFor must be called before scanning!"));
int i, j;
- int lng = stream ->GetSize();
int wrd = wxStrlen(m_Keyword);
bool found = FALSE;
- char *buf = new char[lng + 1];
- stream->Read(buf, lng);
- buf[lng] = 0;
+ wxHtmlFilterHTML filter;
+ wxString tmp = filter.ReadFile(file);
+ int lng = tmp.length();
+ const wxChar *buf = tmp.c_str();
if (!m_CaseSensitive)
for (i = 0; i < lng; i++)
- if ((buf[i] >= 'A') && (buf[i] <= 'Z')) buf[i] += 'a' - 'A';
+ tmp[(size_t)i] = (wxChar)wxTolower(tmp[(size_t)i]);
if (m_WholeWords)
{
- for (i = 0; i < lng - wrd; i++)
- {
+ for (i = 0; i < lng - wrd; i++)
+ {
if (WHITESPACE(buf[i])) continue;
j = 0;
while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++;
if (j == wrd && WHITESPACE(buf[i + j])) { found = TRUE; break; }
}
}
-
+
else
{
- for (i = 0; i < lng - wrd; i++)
- {
+ 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