X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/53e46b61bbe4ce72b92c8898907f0a879d5f012b..3a7c125370cf6fd2b66eb06ba031efcfd5c5b9b0:/src/html/helpdata.cpp diff --git a/src/html/helpdata.cpp b/src/html/helpdata.cpp index 6ba01be7f7..c0418b8d39 100644 --- a/src/html/helpdata.cpp +++ b/src/html/helpdata.cpp @@ -9,8 +9,8 @@ // 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". @@ -29,6 +29,8 @@ #include "wx/log.h" #endif +#include + #include "wx/html/helpdata.h" #include "wx/tokenzr.h" #include "wx/wfstream.h" @@ -38,6 +40,7 @@ #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" @@ -48,22 +51,30 @@ 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); } @@ -73,9 +84,15 @@ static int LINKAGEMODE IndexCompareFunc(const void *a, const void *b) 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) }; @@ -102,6 +119,8 @@ class HP_TagHandler : public wxHtmlTagHandler bool HandleTag(const wxHtmlTag& tag); void WriteOut(wxHtmlContentsItem*& array, int& size); void ReadIn(wxHtmlContentsItem* array, int size); + + DECLARE_NO_COPY_CLASS(HP_TagHandler) }; @@ -242,8 +261,8 @@ wxHtmlHelpData::~wxHtmlHelpData() 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; @@ -253,111 +272,129 @@ bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, c f = ( contentsfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(contentsfile) ); 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) { - 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) { - 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 : */ + if (CacheReadInt32(f) != CACHED_BOOK_FORMAT_FLAGS) + return FALSE; - f->Read(&x, sizeof(x)); + /* load contents : */ st = m_ContentsCnt; - m_ContentsCnt += wxINT32_SWAP_ON_BE(x); + 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); + 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_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); + m_Index[i].m_Name = CacheReadString(f); + m_Index[i].m_Page = CacheReadString(f); m_Index[i].m_Book = book; } return TRUE; @@ -367,49 +404,40 @@ bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f) 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++) { - 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++) { - 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; } @@ -453,11 +481,18 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, 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; @@ -479,13 +514,17 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, fi = fsys.OpenFile(bookfile.GetLocation() + wxT(".cached")); 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 || +#if wxUSE_DATETIME fi->GetModificationTime() < bookfile.GetModificationTime() || +#endif // wxUSE_DATETIME !LoadCachedBook(bookr, fi->GetStream())) { LoadMSProject(bookr, fsys, indexfile, contfile); @@ -523,7 +562,7 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, 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; } @@ -531,15 +570,24 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, 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); +#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; @@ -549,73 +597,57 @@ bool wxHtmlHelpData::AddBook(const wxString& book) 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; - -#ifdef __WXMAC__ - if (wxIsAbsolutePath(book)) bookFull = book; - else bookFull = wxGetCwd() + book; // no slash or dot - wxFileName fn( bookFull ); - bookFull = fn.GetFullPath( wxPATH_UNIX ); -#else - if (wxIsAbsolutePath(book)) bookFull = book; - else bookFull = wxGetCwd() + "/" + book; -#endif + wxString title = _("noname"), + safetitle, + start = wxEmptyString, + contents = wxEmptyString, + index = wxEmptyString, + charset = wxEmptyString; - 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; + fi = fsys.OpenFile(book); + if (fi == NULL) + { + wxLogError(_("Cannot open HTML help book: %s"), book.c_str()); + return FALSE; } + fsys.ChangePathTo(book); + + const wxChar *lineptr; + wxChar linebuf[300]; + wxString tmp; + wxHtmlFilterPlainText filter; + tmp = filter.ReadFile(*fi); + lineptr = tmp.c_str(); + + 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) @@ -771,7 +803,7 @@ bool wxHtmlSearchStatus::Search() 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; @@ -790,10 +822,10 @@ bool wxHtmlSearchStatus::Search() //-------------------------------------------------------------------------------- -// 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; @@ -812,24 +844,26 @@ void wxSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool } +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) { @@ -852,7 +886,6 @@ bool wxSearchEngine::Scan(wxInputStream *stream) } } - delete[] buf; return found; }