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