| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: helpdata.cpp |
| 3 | // Purpose: wxHtmlHelpData |
| 4 | // Notes: Based on htmlhelp.cpp, implementing a monolithic |
| 5 | // HTML Help controller class, by Vaclav Slavik |
| 6 | // Author: Harm van der Heijden and Vaclav Slavik |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) Harm van der Heijden and Vaclav Slavik |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
| 13 | #pragma implementation "helpdata.h" |
| 14 | #endif |
| 15 | |
| 16 | // For compilers that support precompilation, includes "wx.h". |
| 17 | #include "wx/wxprec.h" |
| 18 | |
| 19 | #ifdef __BORLANDC__ |
| 20 | #pragma hdrstop |
| 21 | #endif |
| 22 | |
| 23 | #include "wx/defs.h" |
| 24 | |
| 25 | #if wxUSE_HTML && wxUSE_STREAMS |
| 26 | |
| 27 | #ifndef WXPRECOMP |
| 28 | #include "wx/intl.h" |
| 29 | #include "wx/log.h" |
| 30 | #endif |
| 31 | |
| 32 | #include <ctype.h> |
| 33 | |
| 34 | #include "wx/html/helpdata.h" |
| 35 | #include "wx/tokenzr.h" |
| 36 | #include "wx/wfstream.h" |
| 37 | #include "wx/busyinfo.h" |
| 38 | #include "wx/encconv.h" |
| 39 | #include "wx/fontmap.h" |
| 40 | #include "wx/log.h" |
| 41 | #include "wx/html/htmlpars.h" |
| 42 | #include "wx/html/htmldefs.h" |
| 43 | #include "wx/html/htmlfilt.h" |
| 44 | #include "wx/filename.h" |
| 45 | |
| 46 | #include "wx/arrimpl.cpp" |
| 47 | WX_DEFINE_OBJARRAY(wxHtmlBookRecArray) |
| 48 | |
| 49 | //----------------------------------------------------------------------------- |
| 50 | // static helper functions |
| 51 | //----------------------------------------------------------------------------- |
| 52 | |
| 53 | // Reads one line, stores it into buf and returns pointer to new line or NULL. |
| 54 | static const wxChar* ReadLine(const wxChar *line, wxChar *buf, size_t bufsize) |
| 55 | { |
| 56 | wxChar *writeptr = buf; |
| 57 | wxChar *endptr = buf + bufsize - 1; |
| 58 | const wxChar *readptr = line; |
| 59 | |
| 60 | while (*readptr != 0 && *readptr != _T('\r') && *readptr != _T('\n') && |
| 61 | writeptr != endptr) |
| 62 | *(writeptr++) = *(readptr++); |
| 63 | *writeptr = 0; |
| 64 | while (*readptr == _T('\r') || *readptr == _T('\n')) |
| 65 | readptr++; |
| 66 | if (*readptr == 0) |
| 67 | return NULL; |
| 68 | else |
| 69 | return readptr; |
| 70 | } |
| 71 | |
| 72 | |
| 73 | |
| 74 | extern "C" int LINKAGEMODE |
| 75 | wxHtmlHelpIndexCompareFunc(const void *a, const void *b) |
| 76 | { |
| 77 | return wxStricmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name); |
| 78 | } |
| 79 | |
| 80 | |
| 81 | //----------------------------------------------------------------------------- |
| 82 | // HP_Parser |
| 83 | //----------------------------------------------------------------------------- |
| 84 | |
| 85 | class HP_Parser : public wxHtmlParser |
| 86 | { |
| 87 | public: |
| 88 | HP_Parser() { } |
| 89 | |
| 90 | wxObject* GetProduct() { return NULL; } |
| 91 | |
| 92 | protected: |
| 93 | virtual void AddText(const wxChar* WXUNUSED(txt)) {} |
| 94 | |
| 95 | DECLARE_NO_COPY_CLASS(HP_Parser) |
| 96 | }; |
| 97 | |
| 98 | |
| 99 | //----------------------------------------------------------------------------- |
| 100 | // HP_TagHandler |
| 101 | //----------------------------------------------------------------------------- |
| 102 | |
| 103 | class HP_TagHandler : public wxHtmlTagHandler |
| 104 | { |
| 105 | private: |
| 106 | wxString m_Name, m_Page; |
| 107 | int m_Level; |
| 108 | int m_ID; |
| 109 | int m_Index; |
| 110 | wxHtmlContentsItem *m_Items; |
| 111 | int m_ItemsCnt; |
| 112 | wxHtmlBookRecord *m_Book; |
| 113 | |
| 114 | public: |
| 115 | HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler() |
| 116 | { m_Book = b; m_Items = NULL; m_ItemsCnt = 0; m_Name = m_Page = wxEmptyString; |
| 117 | m_Level = 0; m_ID = -1; } |
| 118 | wxString GetSupportedTags() { return wxT("UL,OBJECT,PARAM"); } |
| 119 | bool HandleTag(const wxHtmlTag& tag); |
| 120 | void WriteOut(wxHtmlContentsItem*& array, int& size); |
| 121 | void ReadIn(wxHtmlContentsItem* array, int size); |
| 122 | |
| 123 | DECLARE_NO_COPY_CLASS(HP_TagHandler) |
| 124 | }; |
| 125 | |
| 126 | |
| 127 | bool HP_TagHandler::HandleTag(const wxHtmlTag& tag) |
| 128 | { |
| 129 | if (tag.GetName() == wxT("UL")) |
| 130 | { |
| 131 | m_Level++; |
| 132 | ParseInner(tag); |
| 133 | m_Level--; |
| 134 | return TRUE; |
| 135 | } |
| 136 | else if (tag.GetName() == wxT("OBJECT")) |
| 137 | { |
| 138 | m_Name = m_Page = wxEmptyString; |
| 139 | ParseInner(tag); |
| 140 | |
| 141 | #if 0 |
| 142 | if (!m_Page.IsEmpty()) |
| 143 | /* Valid HHW's file may contain only two object tags: |
| 144 | |
| 145 | <OBJECT type="text/site properties"> |
| 146 | <param name="ImageType" value="Folder"> |
| 147 | </OBJECT> |
| 148 | |
| 149 | or |
| 150 | |
| 151 | <OBJECT type="text/sitemap"> |
| 152 | <param name="Name" value="main page"> |
| 153 | <param name="Local" value="another.htm"> |
| 154 | </OBJECT> |
| 155 | |
| 156 | We're interested in the latter. !m_Page.IsEmpty() is valid |
| 157 | condition because text/site properties does not contain Local param |
| 158 | */ |
| 159 | #endif |
| 160 | if (tag.GetParam(wxT("TYPE")) == wxT("text/sitemap")) |
| 161 | { |
| 162 | if (m_ItemsCnt % wxHTML_REALLOC_STEP == 0) |
| 163 | m_Items = (wxHtmlContentsItem*) realloc(m_Items, |
| 164 | (m_ItemsCnt + wxHTML_REALLOC_STEP) * |
| 165 | sizeof(wxHtmlContentsItem)); |
| 166 | |
| 167 | m_Items[m_ItemsCnt].m_Level = m_Level; |
| 168 | m_Items[m_ItemsCnt].m_ID = m_ID; |
| 169 | m_Items[m_ItemsCnt].m_Page = new wxChar[m_Page.Length() + 1]; |
| 170 | wxStrcpy(m_Items[m_ItemsCnt].m_Page, m_Page.c_str()); |
| 171 | m_Items[m_ItemsCnt].m_Name = new wxChar [m_Name.Length() + 1]; |
| 172 | wxStrcpy(m_Items[m_ItemsCnt].m_Name, m_Name.c_str()); |
| 173 | m_Items[m_ItemsCnt].m_Book = m_Book; |
| 174 | m_ItemsCnt++; |
| 175 | } |
| 176 | |
| 177 | return TRUE; |
| 178 | } |
| 179 | else |
| 180 | { // "PARAM" |
| 181 | if (m_Name == wxEmptyString && tag.GetParam(wxT("NAME")) == wxT("Name")) |
| 182 | m_Name = tag.GetParam(wxT("VALUE")); |
| 183 | if (tag.GetParam(wxT("NAME")) == wxT("Local")) |
| 184 | m_Page = tag.GetParam(wxT("VALUE")); |
| 185 | if (tag.GetParam(wxT("NAME")) == wxT("ID")) |
| 186 | tag.GetParamAsInt(wxT("VALUE"), &m_ID); |
| 187 | return FALSE; |
| 188 | } |
| 189 | } |
| 190 | |
| 191 | |
| 192 | |
| 193 | void HP_TagHandler::WriteOut(wxHtmlContentsItem*& array, int& size) |
| 194 | { |
| 195 | array = m_Items; |
| 196 | size = m_ItemsCnt; |
| 197 | m_Items = NULL; |
| 198 | m_ItemsCnt = 0; |
| 199 | } |
| 200 | |
| 201 | void HP_TagHandler::ReadIn(wxHtmlContentsItem* array, int size) |
| 202 | { |
| 203 | m_Items = array; |
| 204 | m_ItemsCnt = size; |
| 205 | } |
| 206 | |
| 207 | |
| 208 | |
| 209 | |
| 210 | //----------------------------------------------------------------------------- |
| 211 | // wxHtmlHelpData |
| 212 | //----------------------------------------------------------------------------- |
| 213 | |
| 214 | wxString wxHtmlBookRecord::GetFullPath(const wxString &page) const |
| 215 | { |
| 216 | if (wxIsAbsolutePath(page)) |
| 217 | return page; |
| 218 | else |
| 219 | return m_BasePath + page; |
| 220 | } |
| 221 | |
| 222 | |
| 223 | |
| 224 | IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpData, wxObject) |
| 225 | |
| 226 | wxHtmlHelpData::wxHtmlHelpData() |
| 227 | { |
| 228 | m_TempPath = wxEmptyString; |
| 229 | |
| 230 | m_Contents = NULL; |
| 231 | m_ContentsCnt = 0; |
| 232 | m_Index = NULL; |
| 233 | m_IndexCnt = 0; |
| 234 | } |
| 235 | |
| 236 | wxHtmlHelpData::~wxHtmlHelpData() |
| 237 | { |
| 238 | int i; |
| 239 | |
| 240 | m_BookRecords.Empty(); |
| 241 | if (m_Contents) |
| 242 | { |
| 243 | for (i = 0; i < m_ContentsCnt; i++) |
| 244 | { |
| 245 | delete[] m_Contents[i].m_Page; |
| 246 | delete[] m_Contents[i].m_Name; |
| 247 | } |
| 248 | free(m_Contents); |
| 249 | } |
| 250 | if (m_Index) |
| 251 | { |
| 252 | for (i = 0; i < m_IndexCnt; i++) |
| 253 | { |
| 254 | delete[] m_Index[i].m_Page; |
| 255 | delete[] m_Index[i].m_Name; |
| 256 | } |
| 257 | free(m_Index); |
| 258 | } |
| 259 | } |
| 260 | |
| 261 | bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, const wxString& indexfile, const wxString& contentsfile) |
| 262 | { |
| 263 | wxFSFile *f; |
| 264 | wxHtmlFilterHTML filter; |
| 265 | wxString buf; |
| 266 | wxString string; |
| 267 | |
| 268 | HP_Parser parser; |
| 269 | HP_TagHandler *handler = new HP_TagHandler(book); |
| 270 | parser.AddTagHandler(handler); |
| 271 | |
| 272 | f = ( contentsfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(contentsfile) ); |
| 273 | if (f) |
| 274 | { |
| 275 | buf.clear(); |
| 276 | buf = filter.ReadFile(*f); |
| 277 | delete f; |
| 278 | handler->ReadIn(m_Contents, m_ContentsCnt); |
| 279 | parser.Parse(buf); |
| 280 | handler->WriteOut(m_Contents, m_ContentsCnt); |
| 281 | } |
| 282 | else |
| 283 | { |
| 284 | wxLogError(_("Cannot open contents file: %s"), contentsfile.c_str()); |
| 285 | } |
| 286 | |
| 287 | f = ( indexfile.IsEmpty() ? (wxFSFile*) NULL : fsys.OpenFile(indexfile) ); |
| 288 | if (f) |
| 289 | { |
| 290 | buf.clear(); |
| 291 | buf = filter.ReadFile(*f); |
| 292 | delete f; |
| 293 | handler->ReadIn(m_Index, m_IndexCnt); |
| 294 | parser.Parse(buf); |
| 295 | handler->WriteOut(m_Index, m_IndexCnt); |
| 296 | } |
| 297 | else if (!indexfile.IsEmpty()) |
| 298 | { |
| 299 | wxLogError(_("Cannot open index file: %s"), indexfile.c_str()); |
| 300 | } |
| 301 | return TRUE; |
| 302 | } |
| 303 | |
| 304 | |
| 305 | |
| 306 | inline static void CacheWriteInt32(wxOutputStream *f, wxInt32 value) |
| 307 | { |
| 308 | wxInt32 x = wxINT32_SWAP_ON_BE(value); |
| 309 | f->Write(&x, sizeof(x)); |
| 310 | } |
| 311 | |
| 312 | inline static wxInt32 CacheReadInt32(wxInputStream *f) |
| 313 | { |
| 314 | wxInt32 x; |
| 315 | f->Read(&x, sizeof(x)); |
| 316 | return wxINT32_SWAP_ON_BE(x); |
| 317 | } |
| 318 | |
| 319 | inline static void CacheWriteString(wxOutputStream *f, const wxChar *str) |
| 320 | { |
| 321 | #if wxUSE_UNICODE |
| 322 | wxWX2MBbuf mbstr(wxConvUTF8.cWX2MB(str)); |
| 323 | #else |
| 324 | const wxChar *mbstr = str; |
| 325 | #endif |
| 326 | size_t len = strlen(mbstr)+1; |
| 327 | CacheWriteInt32(f, len); |
| 328 | f->Write(mbstr, len); |
| 329 | } |
| 330 | |
| 331 | inline static wxChar* CacheReadString(wxInputStream *f) |
| 332 | { |
| 333 | char *str; |
| 334 | size_t len = (size_t)CacheReadInt32(f); |
| 335 | str = new char[len]; |
| 336 | f->Read(str, len); |
| 337 | #if !wxUSE_UNICODE |
| 338 | return str; |
| 339 | #else |
| 340 | wxMB2WXbuf wxstr(wxConvUTF8.cMB2WX(str)); |
| 341 | wxChar *outstr = new wxChar[wxStrlen(wxstr)+1]; |
| 342 | wxStrcpy(outstr, wxstr); |
| 343 | return outstr; |
| 344 | #endif |
| 345 | } |
| 346 | |
| 347 | #define CURRENT_CACHED_BOOK_VERSION 4 |
| 348 | |
| 349 | // Additional flags to detect incompatibilities of the runtime environment: |
| 350 | #define CACHED_BOOK_FORMAT_FLAGS \ |
| 351 | (wxUSE_UNICODE << 0) |
| 352 | |
| 353 | |
| 354 | bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f) |
| 355 | { |
| 356 | int i, st; |
| 357 | wxInt32 version; |
| 358 | |
| 359 | /* load header - version info : */ |
| 360 | version = CacheReadInt32(f); |
| 361 | |
| 362 | if (version != CURRENT_CACHED_BOOK_VERSION) |
| 363 | { |
| 364 | // NB: We can just silently return FALSE here and don't worry about |
| 365 | // it anymore, because AddBookParam will load the MS project in |
| 366 | // absence of (properly versioned) .cached file and automatically |
| 367 | // create new .cached file immediately afterward. |
| 368 | return FALSE; |
| 369 | } |
| 370 | |
| 371 | if (CacheReadInt32(f) != CACHED_BOOK_FORMAT_FLAGS) |
| 372 | return FALSE; |
| 373 | |
| 374 | /* load contents : */ |
| 375 | st = m_ContentsCnt; |
| 376 | m_ContentsCnt += CacheReadInt32(f); |
| 377 | m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, |
| 378 | (m_ContentsCnt / wxHTML_REALLOC_STEP + 1) * |
| 379 | wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem)); |
| 380 | for (i = st; i < m_ContentsCnt; i++) |
| 381 | { |
| 382 | m_Contents[i].m_Level = CacheReadInt32(f); |
| 383 | m_Contents[i].m_ID = CacheReadInt32(f); |
| 384 | m_Contents[i].m_Name = CacheReadString(f); |
| 385 | m_Contents[i].m_Page = CacheReadString(f); |
| 386 | m_Contents[i].m_Book = book; |
| 387 | } |
| 388 | |
| 389 | /* load index : */ |
| 390 | st = m_IndexCnt; |
| 391 | m_IndexCnt += CacheReadInt32(f); |
| 392 | m_Index = (wxHtmlContentsItem*) realloc(m_Index, (m_IndexCnt / wxHTML_REALLOC_STEP + 1) * |
| 393 | wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem)); |
| 394 | for (i = st; i < m_IndexCnt; i++) |
| 395 | { |
| 396 | m_Index[i].m_Name = CacheReadString(f); |
| 397 | m_Index[i].m_Page = CacheReadString(f); |
| 398 | m_Index[i].m_Book = book; |
| 399 | } |
| 400 | return TRUE; |
| 401 | } |
| 402 | |
| 403 | |
| 404 | bool wxHtmlHelpData::SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f) |
| 405 | { |
| 406 | int i; |
| 407 | wxInt32 cnt; |
| 408 | |
| 409 | /* save header - version info : */ |
| 410 | CacheWriteInt32(f, CURRENT_CACHED_BOOK_VERSION); |
| 411 | CacheWriteInt32(f, CACHED_BOOK_FORMAT_FLAGS); |
| 412 | |
| 413 | /* save contents : */ |
| 414 | for (cnt = 0, i = 0; i < m_ContentsCnt; i++) |
| 415 | if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0) |
| 416 | cnt++; |
| 417 | CacheWriteInt32(f, cnt); |
| 418 | |
| 419 | for (i = 0; i < m_ContentsCnt; i++) |
| 420 | { |
| 421 | if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0) |
| 422 | continue; |
| 423 | CacheWriteInt32(f, m_Contents[i].m_Level); |
| 424 | CacheWriteInt32(f, m_Contents[i].m_ID); |
| 425 | CacheWriteString(f, m_Contents[i].m_Name); |
| 426 | CacheWriteString(f, m_Contents[i].m_Page); |
| 427 | } |
| 428 | |
| 429 | /* save index : */ |
| 430 | for (cnt = 0, i = 0; i < m_IndexCnt; i++) |
| 431 | if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0) |
| 432 | cnt++; |
| 433 | CacheWriteInt32(f, cnt); |
| 434 | |
| 435 | for (i = 0; i < m_IndexCnt; i++) |
| 436 | { |
| 437 | if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0) |
| 438 | continue; |
| 439 | CacheWriteString(f, m_Index[i].m_Name); |
| 440 | CacheWriteString(f, m_Index[i].m_Page); |
| 441 | } |
| 442 | return TRUE; |
| 443 | } |
| 444 | |
| 445 | |
| 446 | void wxHtmlHelpData::SetTempDir(const wxString& path) |
| 447 | { |
| 448 | if (path == wxEmptyString) m_TempPath = path; |
| 449 | else |
| 450 | { |
| 451 | if (wxIsAbsolutePath(path)) m_TempPath = path; |
| 452 | else m_TempPath = wxGetCwd() + _T("/") + path; |
| 453 | |
| 454 | if (m_TempPath[m_TempPath.Length() - 1] != _T('/')) |
| 455 | m_TempPath << _T('/'); |
| 456 | } |
| 457 | } |
| 458 | |
| 459 | |
| 460 | |
| 461 | static wxString SafeFileName(const wxString& s) |
| 462 | { |
| 463 | wxString res(s); |
| 464 | res.Replace(wxT("#"), wxT("_")); |
| 465 | res.Replace(wxT(":"), wxT("_")); |
| 466 | res.Replace(wxT("\\"), wxT("_")); |
| 467 | res.Replace(wxT("/"), wxT("_")); |
| 468 | return res; |
| 469 | } |
| 470 | |
| 471 | bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, |
| 472 | wxFontEncoding encoding, |
| 473 | const wxString& title, const wxString& contfile, |
| 474 | const wxString& indexfile, const wxString& deftopic, |
| 475 | const wxString& path) |
| 476 | { |
| 477 | wxFileSystem fsys; |
| 478 | wxFSFile *fi; |
| 479 | wxHtmlBookRecord *bookr; |
| 480 | |
| 481 | int IndexOld = m_IndexCnt, |
| 482 | ContentsOld = m_ContentsCnt; |
| 483 | |
| 484 | if (!path.IsEmpty()) |
| 485 | fsys.ChangePathTo(path, TRUE); |
| 486 | |
| 487 | size_t booksCnt = m_BookRecords.GetCount(); |
| 488 | for (size_t i = 0; i < booksCnt; i++) |
| 489 | { |
| 490 | if ( m_BookRecords[i].GetBookFile() == bookfile.GetLocation() ) |
| 491 | return TRUE; // book is (was) loaded |
| 492 | } |
| 493 | |
| 494 | bookr = new wxHtmlBookRecord(bookfile.GetLocation(), fsys.GetPath(), title, deftopic); |
| 495 | |
| 496 | if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0) |
| 497 | m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem)); |
| 498 | m_Contents[m_ContentsCnt].m_Level = 0; |
| 499 | m_Contents[m_ContentsCnt].m_ID = 0; |
| 500 | m_Contents[m_ContentsCnt].m_Page = new wxChar[deftopic.Length() + 1]; |
| 501 | wxStrcpy(m_Contents[m_ContentsCnt].m_Page, deftopic.c_str()); |
| 502 | m_Contents[m_ContentsCnt].m_Name = new wxChar [title.Length() + 1]; |
| 503 | wxStrcpy(m_Contents[m_ContentsCnt].m_Name, title.c_str()); |
| 504 | m_Contents[m_ContentsCnt].m_Book = bookr; |
| 505 | |
| 506 | // store the contents index for later |
| 507 | int cont_start = m_ContentsCnt++; |
| 508 | |
| 509 | // Try to find cached binary versions: |
| 510 | // 1. save file as book, but with .hhp.cached extension |
| 511 | // 2. same as 1. but in temp path |
| 512 | // 3. otherwise or if cache load failed, load it from MS. |
| 513 | |
| 514 | fi = fsys.OpenFile(bookfile.GetLocation() + wxT(".cached")); |
| 515 | |
| 516 | if (fi == NULL || |
| 517 | #if wxUSE_DATETIME |
| 518 | fi->GetModificationTime() < bookfile.GetModificationTime() || |
| 519 | #endif // wxUSE_DATETIME |
| 520 | !LoadCachedBook(bookr, fi->GetStream())) |
| 521 | { |
| 522 | if (fi != NULL) delete fi; |
| 523 | fi = fsys.OpenFile(m_TempPath + wxFileNameFromPath(bookfile.GetLocation()) + wxT(".cached")); |
| 524 | if (m_TempPath == wxEmptyString || fi == NULL || |
| 525 | #if wxUSE_DATETIME |
| 526 | fi->GetModificationTime() < bookfile.GetModificationTime() || |
| 527 | #endif // wxUSE_DATETIME |
| 528 | !LoadCachedBook(bookr, fi->GetStream())) |
| 529 | { |
| 530 | LoadMSProject(bookr, fsys, indexfile, contfile); |
| 531 | if (m_TempPath != wxEmptyString) |
| 532 | { |
| 533 | wxFileOutputStream *outs = new wxFileOutputStream(m_TempPath + |
| 534 | SafeFileName(wxFileNameFromPath(bookfile.GetLocation())) + wxT(".cached")); |
| 535 | SaveCachedBook(bookr, outs); |
| 536 | delete outs; |
| 537 | } |
| 538 | } |
| 539 | } |
| 540 | |
| 541 | if (fi != NULL) delete fi; |
| 542 | |
| 543 | // Now store the contents range |
| 544 | bookr->SetContentsRange(cont_start, m_ContentsCnt); |
| 545 | |
| 546 | // Convert encoding, if neccessary: |
| 547 | if (encoding != wxFONTENCODING_SYSTEM) |
| 548 | { |
| 549 | wxFontEncodingArray a = wxEncodingConverter::GetPlatformEquivalents(encoding); |
| 550 | if (a.GetCount() != 0 && a[0] != encoding) |
| 551 | { |
| 552 | int i; |
| 553 | wxEncodingConverter conv; |
| 554 | conv.Init(encoding, a[0]); |
| 555 | |
| 556 | for (i = IndexOld; i < m_IndexCnt; i++) |
| 557 | conv.Convert(m_Index[i].m_Name); |
| 558 | for (i = ContentsOld; i < m_ContentsCnt; i++) |
| 559 | conv.Convert(m_Contents[i].m_Name); |
| 560 | } |
| 561 | } |
| 562 | |
| 563 | m_BookRecords.Add(bookr); |
| 564 | if (m_IndexCnt > 0) |
| 565 | qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), wxHtmlHelpIndexCompareFunc); |
| 566 | |
| 567 | return TRUE; |
| 568 | } |
| 569 | |
| 570 | |
| 571 | bool wxHtmlHelpData::AddBook(const wxString& book) |
| 572 | { |
| 573 | if (book.Right(4).Lower() == wxT(".zip") || |
| 574 | book.Right(4).Lower() == wxT(".htb") /*html book*/) |
| 575 | { |
| 576 | wxFileSystem fsys; |
| 577 | wxString s; |
| 578 | bool rt = FALSE; |
| 579 | |
| 580 | s = fsys.FindFirst(book + wxT("#zip:") + wxT("*.hhp"), wxFILE); |
| 581 | while (!s.IsEmpty()) |
| 582 | { |
| 583 | if (AddBook(s)) rt = TRUE; |
| 584 | s = fsys.FindNext(); |
| 585 | } |
| 586 | |
| 587 | return rt; |
| 588 | } |
| 589 | else |
| 590 | { |
| 591 | wxFSFile *fi; |
| 592 | wxFileSystem fsys; |
| 593 | |
| 594 | wxString title = _("noname"), |
| 595 | safetitle, |
| 596 | start = wxEmptyString, |
| 597 | contents = wxEmptyString, |
| 598 | index = wxEmptyString, |
| 599 | charset = wxEmptyString; |
| 600 | |
| 601 | fi = fsys.OpenFile(book); |
| 602 | if (fi == NULL) |
| 603 | { |
| 604 | wxLogError(_("Cannot open HTML help book: %s"), book.c_str()); |
| 605 | return FALSE; |
| 606 | } |
| 607 | fsys.ChangePathTo(book); |
| 608 | |
| 609 | const wxChar *lineptr; |
| 610 | wxChar linebuf[300]; |
| 611 | wxString tmp; |
| 612 | wxHtmlFilterPlainText filter; |
| 613 | tmp = filter.ReadFile(*fi); |
| 614 | lineptr = tmp.c_str(); |
| 615 | |
| 616 | do |
| 617 | { |
| 618 | lineptr = ReadLine(lineptr, linebuf, 300); |
| 619 | |
| 620 | for (wxChar *ch = linebuf; *ch != wxT('\0') && *ch != wxT('='); ch++) |
| 621 | *ch = tolower(*ch); |
| 622 | |
| 623 | if (wxStrstr(linebuf, _T("title=")) == linebuf) |
| 624 | title = linebuf + wxStrlen(_T("title=")); |
| 625 | if (wxStrstr(linebuf, _T("default topic=")) == linebuf) |
| 626 | start = linebuf + wxStrlen(_T("default topic=")); |
| 627 | if (wxStrstr(linebuf, _T("index file=")) == linebuf) |
| 628 | index = linebuf + wxStrlen(_T("index file=")); |
| 629 | if (wxStrstr(linebuf, _T("contents file=")) == linebuf) |
| 630 | contents = linebuf + wxStrlen(_T("contents file=")); |
| 631 | if (wxStrstr(linebuf, _T("charset=")) == linebuf) |
| 632 | charset = linebuf + wxStrlen(_T("charset=")); |
| 633 | } while (lineptr != NULL); |
| 634 | |
| 635 | wxFontEncoding enc; |
| 636 | if (charset == wxEmptyString) enc = wxFONTENCODING_SYSTEM; |
| 637 | else enc = wxFontMapper::Get()->CharsetToEncoding(charset); |
| 638 | bool rtval = AddBookParam(*fi, enc, |
| 639 | title, contents, index, start, fsys.GetPath()); |
| 640 | delete fi; |
| 641 | return rtval; |
| 642 | } |
| 643 | } |
| 644 | |
| 645 | wxString wxHtmlHelpData::FindPageByName(const wxString& x) |
| 646 | { |
| 647 | int cnt; |
| 648 | int i; |
| 649 | wxFileSystem fsys; |
| 650 | wxFSFile *f; |
| 651 | wxString url(wxEmptyString); |
| 652 | |
| 653 | /* 1. try to open given file: */ |
| 654 | |
| 655 | cnt = m_BookRecords.GetCount(); |
| 656 | for (i = 0; i < cnt; i++) |
| 657 | { |
| 658 | f = fsys.OpenFile(m_BookRecords[i].GetFullPath(x)); |
| 659 | if (f) |
| 660 | { |
| 661 | url = m_BookRecords[i].GetFullPath(x); |
| 662 | delete f; |
| 663 | return url; |
| 664 | } |
| 665 | } |
| 666 | |
| 667 | |
| 668 | /* 2. try to find a book: */ |
| 669 | |
| 670 | for (i = 0; i < cnt; i++) |
| 671 | { |
| 672 | if (m_BookRecords[i].GetTitle() == x) |
| 673 | { |
| 674 | url = m_BookRecords[i].GetFullPath(m_BookRecords[i].GetStart()); |
| 675 | return url; |
| 676 | } |
| 677 | } |
| 678 | |
| 679 | /* 3. try to find in contents: */ |
| 680 | |
| 681 | cnt = m_ContentsCnt; |
| 682 | for (i = 0; i < cnt; i++) |
| 683 | { |
| 684 | if (wxStrcmp(m_Contents[i].m_Name, x) == 0) |
| 685 | { |
| 686 | url = m_Contents[i].GetFullPath(); |
| 687 | return url; |
| 688 | } |
| 689 | } |
| 690 | |
| 691 | |
| 692 | /* 4. try to find in index: */ |
| 693 | |
| 694 | cnt = m_IndexCnt; |
| 695 | for (i = 0; i < cnt; i++) |
| 696 | { |
| 697 | if (wxStrcmp(m_Index[i].m_Name, x) == 0) |
| 698 | { |
| 699 | url = m_Index[i].GetFullPath(); |
| 700 | return url; |
| 701 | } |
| 702 | } |
| 703 | |
| 704 | return url; |
| 705 | } |
| 706 | |
| 707 | wxString wxHtmlHelpData::FindPageById(int id) |
| 708 | { |
| 709 | int i; |
| 710 | wxString url(wxEmptyString); |
| 711 | |
| 712 | for (i = 0; i < m_ContentsCnt; i++) |
| 713 | { |
| 714 | if (m_Contents[i].m_ID == id) |
| 715 | { |
| 716 | url = m_Contents[i].GetFullPath(); |
| 717 | return url; |
| 718 | } |
| 719 | } |
| 720 | |
| 721 | return url; |
| 722 | } |
| 723 | |
| 724 | //---------------------------------------------------------------------------------- |
| 725 | // wxHtmlSearchStatus functions |
| 726 | //---------------------------------------------------------------------------------- |
| 727 | |
| 728 | wxHtmlSearchStatus::wxHtmlSearchStatus(wxHtmlHelpData* data, const wxString& keyword, |
| 729 | bool case_sensitive, bool whole_words_only, |
| 730 | const wxString& book) |
| 731 | { |
| 732 | m_Data = data; |
| 733 | m_Keyword = keyword; |
| 734 | wxHtmlBookRecord* bookr = NULL; |
| 735 | if (book != wxEmptyString) |
| 736 | { |
| 737 | // we have to search in a specific book. Find it first |
| 738 | int i, cnt = data->m_BookRecords.GetCount(); |
| 739 | for (i = 0; i < cnt; i++) |
| 740 | if (data->m_BookRecords[i].GetTitle() == book) |
| 741 | { |
| 742 | bookr = &(data->m_BookRecords[i]); |
| 743 | m_CurIndex = bookr->GetContentsStart(); |
| 744 | m_MaxIndex = bookr->GetContentsEnd(); |
| 745 | break; |
| 746 | } |
| 747 | // check; we won't crash if the book doesn't exist, but it's Bad Anyway. |
| 748 | wxASSERT(bookr); |
| 749 | } |
| 750 | if (! bookr) |
| 751 | { |
| 752 | // no book specified; search all books |
| 753 | m_CurIndex = 0; |
| 754 | m_MaxIndex = m_Data->m_ContentsCnt; |
| 755 | } |
| 756 | m_Engine.LookFor(keyword, case_sensitive, whole_words_only); |
| 757 | m_Active = (m_CurIndex < m_MaxIndex); |
| 758 | m_LastPage = NULL; |
| 759 | } |
| 760 | |
| 761 | bool wxHtmlSearchStatus::Search() |
| 762 | { |
| 763 | wxFSFile *file; |
| 764 | int i = m_CurIndex; // shortcut |
| 765 | bool found = FALSE; |
| 766 | wxChar *thepage; |
| 767 | |
| 768 | if (!m_Active) |
| 769 | { |
| 770 | // sanity check. Illegal use, but we'll try to prevent a crash anyway |
| 771 | wxASSERT(m_Active); |
| 772 | return FALSE; |
| 773 | } |
| 774 | |
| 775 | m_Name = wxEmptyString; |
| 776 | m_ContentsItem = NULL; |
| 777 | thepage = m_Data->m_Contents[i].m_Page; |
| 778 | |
| 779 | m_Active = (++m_CurIndex < m_MaxIndex); |
| 780 | // check if it is same page with different anchor: |
| 781 | if (m_LastPage != NULL) |
| 782 | { |
| 783 | wxChar *p1, *p2; |
| 784 | for (p1 = thepage, p2 = m_LastPage; |
| 785 | *p1 != 0 && *p1 != _T('#') && *p1 == *p2; p1++, p2++) {} |
| 786 | |
| 787 | m_LastPage = thepage; |
| 788 | |
| 789 | if (*p1 == 0 || *p1 == _T('#')) |
| 790 | return FALSE; |
| 791 | } |
| 792 | else m_LastPage = thepage; |
| 793 | |
| 794 | wxFileSystem fsys; |
| 795 | file = fsys.OpenFile(m_Data->m_Contents[i].m_Book->GetFullPath(thepage)); |
| 796 | if (file) |
| 797 | { |
| 798 | if (m_Engine.Scan(*file)) |
| 799 | { |
| 800 | m_Name = m_Data->m_Contents[i].m_Name; |
| 801 | m_ContentsItem = m_Data->m_Contents + i; |
| 802 | found = TRUE; |
| 803 | } |
| 804 | delete file; |
| 805 | } |
| 806 | return found; |
| 807 | } |
| 808 | |
| 809 | |
| 810 | |
| 811 | |
| 812 | |
| 813 | |
| 814 | |
| 815 | |
| 816 | //-------------------------------------------------------------------------------- |
| 817 | // wxHtmlSearchEngine |
| 818 | //-------------------------------------------------------------------------------- |
| 819 | |
| 820 | void wxHtmlSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only) |
| 821 | { |
| 822 | m_CaseSensitive = case_sensitive; |
| 823 | m_WholeWords = whole_words_only; |
| 824 | if (m_Keyword) delete[] m_Keyword; |
| 825 | m_Keyword = new wxChar[keyword.Length() + 1]; |
| 826 | wxStrcpy(m_Keyword, keyword.c_str()); |
| 827 | |
| 828 | if (!m_CaseSensitive) |
| 829 | { |
| 830 | for (int i = wxStrlen(m_Keyword) - 1; i >= 0; i--) |
| 831 | { |
| 832 | if ((m_Keyword[i] >= wxT('A')) && (m_Keyword[i] <= wxT('Z'))) |
| 833 | m_Keyword[i] += wxT('a') - wxT('A'); |
| 834 | } |
| 835 | } |
| 836 | } |
| 837 | |
| 838 | |
| 839 | static inline bool WHITESPACE(wxChar c) |
| 840 | { |
| 841 | return c == _T(' ') || c == _T('\n') || c == _T('\r') || c == _T('\t'); |
| 842 | } |
| 843 | |
| 844 | bool wxHtmlSearchEngine::Scan(const wxFSFile& file) |
| 845 | { |
| 846 | wxASSERT_MSG(m_Keyword != NULL, wxT("wxHtmlSearchEngine::LookFor must be called before scanning!")); |
| 847 | |
| 848 | int i, j; |
| 849 | int wrd = wxStrlen(m_Keyword); |
| 850 | bool found = FALSE; |
| 851 | wxHtmlFilterHTML filter; |
| 852 | wxString tmp = filter.ReadFile(file); |
| 853 | int lng = tmp.length(); |
| 854 | const wxChar *buf = tmp.c_str(); |
| 855 | |
| 856 | if (!m_CaseSensitive) |
| 857 | for (i = 0; i < lng; i++) |
| 858 | tmp[(size_t)i] = (wxChar)wxTolower(tmp[(size_t)i]); |
| 859 | |
| 860 | if (m_WholeWords) |
| 861 | { |
| 862 | for (i = 0; i < lng - wrd; i++) |
| 863 | { |
| 864 | if (WHITESPACE(buf[i])) continue; |
| 865 | j = 0; |
| 866 | while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++; |
| 867 | if (j == wrd && WHITESPACE(buf[i + j])) { found = TRUE; break; } |
| 868 | } |
| 869 | } |
| 870 | |
| 871 | else |
| 872 | { |
| 873 | for (i = 0; i < lng - wrd; i++) |
| 874 | { |
| 875 | j = 0; |
| 876 | while ((j < wrd) && (buf[i + j] == m_Keyword[j])) j++; |
| 877 | if (j == wrd) { found = TRUE; break; } |
| 878 | } |
| 879 | } |
| 880 | |
| 881 | return found; |
| 882 | } |
| 883 | |
| 884 | |
| 885 | |
| 886 | #endif |