]>
Commit | Line | Data |
---|---|---|
8ec2b484 | 1 | ///////////////////////////////////////////////////////////////////////////// |
93763ad5 | 2 | // Name: src/html/helpdata.cpp |
8ec2b484 | 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 | 8 | // Copyright: (c) Harm van der Heijden and Vaclav Slavik |
65571936 | 9 | // Licence: wxWindows licence |
8ec2b484 HH |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
8ec2b484 HH |
12 | // For compilers that support precompilation, includes "wx.h". |
13 | #include "wx/wxprec.h" | |
14 | ||
15 | #ifdef __BORLANDC__ | |
93763ad5 | 16 | #pragma hdrstop |
8ec2b484 HH |
17 | #endif |
18 | ||
f6bcfd97 | 19 | #if wxUSE_HTML && wxUSE_STREAMS |
8ec2b484 | 20 | |
b4f4d3dd | 21 | #ifndef WX_PRECOMP |
04dbb646 VZ |
22 | #include "wx/intl.h" |
23 | #include "wx/log.h" | |
8ec2b484 HH |
24 | #endif |
25 | ||
401eb3de RR |
26 | #include <ctype.h> |
27 | ||
8ec2b484 HH |
28 | #include "wx/html/helpdata.h" |
29 | #include "wx/tokenzr.h" | |
30 | #include "wx/wfstream.h" | |
31 | #include "wx/busyinfo.h" | |
f890e2d4 VS |
32 | #include "wx/encconv.h" |
33 | #include "wx/fontmap.h" | |
69941f05 | 34 | #include "wx/html/htmlpars.h" |
8ec2b484 | 35 | #include "wx/html/htmldefs.h" |
2b5f62a0 | 36 | #include "wx/html/htmlfilt.h" |
057b55b0 | 37 | #include "wx/filename.h" |
8ec2b484 HH |
38 | |
39 | #include "wx/arrimpl.cpp" | |
40 | WX_DEFINE_OBJARRAY(wxHtmlBookRecArray) | |
91fa114d | 41 | WX_DEFINE_OBJARRAY(wxHtmlHelpDataItems) |
8ec2b484 HH |
42 | |
43 | //----------------------------------------------------------------------------- | |
44 | // static helper functions | |
45 | //----------------------------------------------------------------------------- | |
46 | ||
47 | // Reads one line, stores it into buf and returns pointer to new line or NULL. | |
1a1dac18 | 48 | static const wxChar* ReadLine(const wxChar *line, wxChar *buf, size_t bufsize) |
8ec2b484 | 49 | { |
1a1dac18 MB |
50 | wxChar *writeptr = buf; |
51 | wxChar *endptr = buf + bufsize - 1; | |
52 | const wxChar *readptr = line; | |
8ec2b484 | 53 | |
9a83f860 | 54 | while (*readptr != 0 && *readptr != wxT('\r') && *readptr != wxT('\n') && |
d1da8872 | 55 | writeptr != endptr) |
3dde6c72 | 56 | *(writeptr++) = *(readptr++); |
8ec2b484 | 57 | *writeptr = 0; |
9a83f860 | 58 | while (*readptr == wxT('\r') || *readptr == wxT('\n')) |
3dde6c72 VS |
59 | readptr++; |
60 | if (*readptr == 0) | |
61 | return NULL; | |
d1da8872 | 62 | else |
3dde6c72 | 63 | return readptr; |
8ec2b484 HH |
64 | } |
65 | ||
66 | ||
8ec2b484 | 67 | |
91fa114d VS |
68 | static int |
69 | wxHtmlHelpIndexCompareFunc(wxHtmlHelpDataItem **a, wxHtmlHelpDataItem **b) | |
8ec2b484 | 70 | { |
91fa114d VS |
71 | wxHtmlHelpDataItem *ia = *a; |
72 | wxHtmlHelpDataItem *ib = *b; | |
3912b3f8 | 73 | |
7fbe5489 VS |
74 | if (ia == NULL) |
75 | return -1; | |
76 | if (ib == NULL) | |
77 | return 1; | |
42841dfc | 78 | |
91fa114d VS |
79 | if (ia->parent == ib->parent) |
80 | { | |
81 | return ia->name.CmpNoCase(ib->name); | |
82 | } | |
83 | else if (ia->level == ib->level) | |
84 | { | |
85 | return wxHtmlHelpIndexCompareFunc(&ia->parent, &ib->parent); | |
86 | } | |
87 | else | |
88 | { | |
89 | wxHtmlHelpDataItem *ia2 = ia; | |
90 | wxHtmlHelpDataItem *ib2 = ib; | |
d1da8872 | 91 | |
91fa114d VS |
92 | while (ia2->level > ib2->level) |
93 | { | |
94 | ia2 = ia2->parent; | |
95 | } | |
96 | while (ib2->level > ia2->level) | |
97 | { | |
98 | ib2 = ib2->parent; | |
99 | } | |
d1da8872 | 100 | |
91fa114d VS |
101 | wxASSERT(ia2); |
102 | wxASSERT(ib2); | |
103 | int res = wxHtmlHelpIndexCompareFunc(&ia2, &ib2); | |
104 | if (res != 0) | |
105 | return res; | |
106 | else if (ia->level > ib->level) | |
107 | return 1; | |
108 | else | |
109 | return -1; | |
110 | } | |
8ec2b484 HH |
111 | } |
112 | ||
8ec2b484 HH |
113 | //----------------------------------------------------------------------------- |
114 | // HP_Parser | |
115 | //----------------------------------------------------------------------------- | |
116 | ||
117 | class HP_Parser : public wxHtmlParser | |
118 | { | |
211dfedd | 119 | public: |
67c276bd VS |
120 | HP_Parser() |
121 | { | |
122 | GetEntitiesParser()->SetEncoding(wxFONTENCODING_ISO8859_1); | |
123 | } | |
fc7a2a60 | 124 | |
211dfedd | 125 | wxObject* GetProduct() { return NULL; } |
fc7a2a60 | 126 | |
211dfedd | 127 | protected: |
5bce3e6f | 128 | virtual void AddText(const wxString& WXUNUSED(txt)) {} |
fc7a2a60 | 129 | |
c0c133e1 | 130 | wxDECLARE_NO_COPY_CLASS(HP_Parser); |
8ec2b484 HH |
131 | }; |
132 | ||
133 | ||
134 | //----------------------------------------------------------------------------- | |
135 | // HP_TagHandler | |
136 | //----------------------------------------------------------------------------- | |
137 | ||
138 | class HP_TagHandler : public wxHtmlTagHandler | |
139 | { | |
140 | private: | |
91fa114d VS |
141 | wxString m_name, m_page; |
142 | int m_level; | |
143 | int m_id; | |
144 | int m_index; | |
145 | int m_count; | |
146 | wxHtmlHelpDataItem *m_parentItem; | |
147 | wxHtmlBookRecord *m_book; | |
d1da8872 | 148 | |
91fa114d | 149 | wxHtmlHelpDataItems *m_data; |
8ec2b484 HH |
150 | |
151 | public: | |
04dbb646 | 152 | HP_TagHandler(wxHtmlBookRecord *b) : wxHtmlTagHandler() |
91fa114d VS |
153 | { |
154 | m_data = NULL; | |
155 | m_book = b; | |
156 | m_name = m_page = wxEmptyString; | |
157 | m_level = 0; | |
d1da8872 | 158 | m_id = wxID_ANY; |
91fa114d VS |
159 | m_count = 0; |
160 | m_parentItem = NULL; | |
161 | } | |
66a77a74 | 162 | wxString GetSupportedTags() { return wxT("UL,OBJECT,PARAM"); } |
8ec2b484 | 163 | bool HandleTag(const wxHtmlTag& tag); |
91fa114d VS |
164 | |
165 | void Reset(wxHtmlHelpDataItems& data) | |
166 | { | |
167 | m_data = &data; | |
168 | m_count = 0; | |
169 | m_level = 0; | |
170 | m_parentItem = NULL; | |
171 | } | |
22f3361e | 172 | |
c0c133e1 | 173 | wxDECLARE_NO_COPY_CLASS(HP_TagHandler); |
8ec2b484 HH |
174 | }; |
175 | ||
176 | ||
177 | bool HP_TagHandler::HandleTag(const wxHtmlTag& tag) | |
178 | { | |
04dbb646 | 179 | if (tag.GetName() == wxT("UL")) |
4f9297b0 | 180 | { |
91fa114d VS |
181 | wxHtmlHelpDataItem *oldparent = m_parentItem; |
182 | m_level++; | |
183 | m_parentItem = (m_count > 0) ? &(*m_data)[m_data->size()-1] : NULL; | |
8ec2b484 | 184 | ParseInner(tag); |
91fa114d VS |
185 | m_level--; |
186 | m_parentItem = oldparent; | |
187 | return true; | |
8ec2b484 | 188 | } |
04dbb646 | 189 | else if (tag.GetName() == wxT("OBJECT")) |
4f9297b0 | 190 | { |
91fa114d | 191 | m_name = m_page = wxEmptyString; |
8ec2b484 | 192 | ParseInner(tag); |
50494a55 | 193 | |
daa084c2 | 194 | #if 0 |
91fa114d | 195 | if (!page.IsEmpty()) |
7df9fbc3 | 196 | /* Valid HHW's file may contain only two object tags: |
04dbb646 | 197 | |
4157f43f VS |
198 | <OBJECT type="text/site properties"> |
199 | <param name="ImageType" value="Folder"> | |
200 | </OBJECT> | |
04dbb646 | 201 | |
4157f43f | 202 | or |
04dbb646 VZ |
203 | |
204 | <OBJECT type="text/sitemap"> | |
205 | <param name="Name" value="main page"> | |
206 | <param name="Local" value="another.htm"> | |
207 | </OBJECT> | |
208 | ||
91fa114d | 209 | We're interested in the latter. !page.IsEmpty() is valid |
4157f43f VS |
210 | condition because text/site properties does not contain Local param |
211 | */ | |
daa084c2 VS |
212 | #endif |
213 | if (tag.GetParam(wxT("TYPE")) == wxT("text/sitemap")) | |
4157f43f | 214 | { |
91fa114d VS |
215 | wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem(); |
216 | item->parent = m_parentItem; | |
217 | item->level = m_level; | |
218 | item->id = m_id; | |
219 | item->page = m_page; | |
220 | item->name = m_name; | |
d1da8872 | 221 | |
91fa114d VS |
222 | item->book = m_book; |
223 | m_data->Add(item); | |
224 | m_count++; | |
4157f43f | 225 | } |
50494a55 | 226 | |
91fa114d | 227 | return true; |
8ec2b484 | 228 | } |
04dbb646 | 229 | else |
4f9297b0 | 230 | { // "PARAM" |
91fa114d VS |
231 | if (m_name.empty() && tag.GetParam(wxT("NAME")) == wxT("Name")) |
232 | m_name = tag.GetParam(wxT("VALUE")); | |
04dbb646 | 233 | if (tag.GetParam(wxT("NAME")) == wxT("Local")) |
91fa114d | 234 | m_page = tag.GetParam(wxT("VALUE")); |
04dbb646 | 235 | if (tag.GetParam(wxT("NAME")) == wxT("ID")) |
91fa114d VS |
236 | tag.GetParamAsInt(wxT("VALUE"), &m_id); |
237 | return false; | |
8ec2b484 HH |
238 | } |
239 | } | |
240 | ||
241 | ||
8ec2b484 HH |
242 | //----------------------------------------------------------------------------- |
243 | // wxHtmlHelpData | |
244 | //----------------------------------------------------------------------------- | |
245 | ||
468ae730 VS |
246 | wxString wxHtmlBookRecord::GetFullPath(const wxString &page) const |
247 | { | |
248 | if (wxIsAbsolutePath(page)) | |
249 | return page; | |
250 | else | |
251 | return m_BasePath + page; | |
252 | } | |
253 | ||
91fa114d VS |
254 | wxString wxHtmlHelpDataItem::GetIndentedName() const |
255 | { | |
256 | wxString s; | |
257 | for (int i = 1; i < level; i++) | |
9a83f860 | 258 | s << wxT(" "); |
91fa114d VS |
259 | s << name; |
260 | return s; | |
261 | } | |
468ae730 VS |
262 | |
263 | ||
8ec2b484 HH |
264 | IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpData, wxObject) |
265 | ||
f42b1601 | 266 | wxHtmlHelpData::wxHtmlHelpData() |
8ec2b484 | 267 | { |
8ec2b484 HH |
268 | } |
269 | ||
270 | wxHtmlHelpData::~wxHtmlHelpData() | |
271 | { | |
8ec2b484 HH |
272 | } |
273 | ||
67c276bd VS |
274 | bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, |
275 | const wxString& indexfile, | |
276 | const wxString& contentsfile) | |
8ec2b484 HH |
277 | { |
278 | wxFSFile *f; | |
2b5f62a0 | 279 | wxHtmlFilterHTML filter; |
eb37e1d2 | 280 | wxString buf; |
8ec2b484 | 281 | wxString string; |
f42b1601 | 282 | |
8ec2b484 HH |
283 | HP_Parser parser; |
284 | HP_TagHandler *handler = new HP_TagHandler(book); | |
285 | parser.AddTagHandler(handler); | |
286 | ||
d3b9f782 | 287 | f = ( contentsfile.empty() ? NULL : fsys.OpenFile(contentsfile) ); |
04dbb646 | 288 | if (f) |
4f9297b0 | 289 | { |
eb37e1d2 | 290 | buf.clear(); |
2b5f62a0 | 291 | buf = filter.ReadFile(*f); |
8ec2b484 | 292 | delete f; |
91fa114d | 293 | handler->Reset(m_contents); |
8ec2b484 | 294 | parser.Parse(buf); |
8ec2b484 | 295 | } |
f3c82859 | 296 | else |
2b5f62a0 | 297 | { |
f6bcfd97 | 298 | wxLogError(_("Cannot open contents file: %s"), contentsfile.c_str()); |
2b5f62a0 | 299 | } |
8ec2b484 | 300 | |
d3b9f782 | 301 | f = ( indexfile.empty() ? NULL : fsys.OpenFile(indexfile) ); |
04dbb646 | 302 | if (f) |
4f9297b0 | 303 | { |
eb37e1d2 | 304 | buf.clear(); |
2b5f62a0 | 305 | buf = filter.ReadFile(*f); |
8ec2b484 | 306 | delete f; |
91fa114d | 307 | handler->Reset(m_index); |
8ec2b484 | 308 | parser.Parse(buf); |
8ec2b484 | 309 | } |
93763ad5 | 310 | else if (!indexfile.empty()) |
2b5f62a0 | 311 | { |
f6bcfd97 | 312 | wxLogError(_("Cannot open index file: %s"), indexfile.c_str()); |
2b5f62a0 | 313 | } |
d1da8872 | 314 | return true; |
8ec2b484 HH |
315 | } |
316 | ||
4fd5055c VS |
317 | inline static void CacheWriteInt32(wxOutputStream *f, wxInt32 value) |
318 | { | |
319 | wxInt32 x = wxINT32_SWAP_ON_BE(value); | |
320 | f->Write(&x, sizeof(x)); | |
321 | } | |
f35822af | 322 | |
4fd5055c VS |
323 | inline static wxInt32 CacheReadInt32(wxInputStream *f) |
324 | { | |
325 | wxInt32 x; | |
326 | f->Read(&x, sizeof(x)); | |
327 | return wxINT32_SWAP_ON_BE(x); | |
328 | } | |
f35822af | 329 | |
3912b3f8 | 330 | inline static void CacheWriteString(wxOutputStream *f, const wxString& str) |
d1da8872 | 331 | { |
3912b3f8 VS |
332 | const wxWX2MBbuf mbstr = str.mb_str(wxConvUTF8); |
333 | size_t len = strlen((const char*)mbstr)+1; | |
4fd5055c | 334 | CacheWriteInt32(f, len); |
3912b3f8 | 335 | f->Write((const char*)mbstr, len); |
4fd5055c | 336 | } |
f35822af | 337 | |
3912b3f8 | 338 | inline static wxString CacheReadString(wxInputStream *f) |
4fd5055c | 339 | { |
4fd5055c | 340 | size_t len = (size_t)CacheReadInt32(f); |
3912b3f8 VS |
341 | wxCharBuffer str(len-1); |
342 | f->Read(str.data(), len); | |
343 | return wxString(str, wxConvUTF8); | |
4fd5055c | 344 | } |
f35822af | 345 | |
91fa114d | 346 | #define CURRENT_CACHED_BOOK_VERSION 5 |
d1a9c82b VS |
347 | |
348 | // Additional flags to detect incompatibilities of the runtime environment: | |
349 | #define CACHED_BOOK_FORMAT_FLAGS \ | |
350 | (wxUSE_UNICODE << 0) | |
351 | ||
f35822af | 352 | |
8ec2b484 HH |
353 | bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f) |
354 | { | |
91fa114d | 355 | int i, st, newsize; |
f35822af VS |
356 | wxInt32 version; |
357 | ||
358 | /* load header - version info : */ | |
4fd5055c | 359 | version = CacheReadInt32(f); |
d1da8872 | 360 | |
04dbb646 | 361 | if (version != CURRENT_CACHED_BOOK_VERSION) |
f3c82859 | 362 | { |
d1da8872 | 363 | // NB: We can just silently return false here and don't worry about |
4fd5055c | 364 | // it anymore, because AddBookParam will load the MS project in |
d1da8872 | 365 | // absence of (properly versioned) .cached file and automatically |
4fd5055c | 366 | // create new .cached file immediately afterward. |
91fa114d | 367 | return false; |
f3c82859 | 368 | } |
04dbb646 | 369 | |
d1a9c82b | 370 | if (CacheReadInt32(f) != CACHED_BOOK_FORMAT_FLAGS) |
91fa114d | 371 | return false; |
d1a9c82b | 372 | |
8ec2b484 | 373 | /* load contents : */ |
91fa114d VS |
374 | st = m_contents.size(); |
375 | newsize = st + CacheReadInt32(f); | |
376 | m_contents.Alloc(newsize); | |
377 | for (i = st; i < newsize; i++) | |
4f9297b0 | 378 | { |
91fa114d VS |
379 | wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem; |
380 | item->level = CacheReadInt32(f); | |
381 | item->id = CacheReadInt32(f); | |
382 | item->name = CacheReadString(f); | |
383 | item->page = CacheReadString(f); | |
384 | item->book = book; | |
385 | m_contents.Add(item); | |
8ec2b484 HH |
386 | } |
387 | ||
388 | /* load index : */ | |
91fa114d VS |
389 | st = m_index.size(); |
390 | newsize = st + CacheReadInt32(f); | |
391 | m_index.Alloc(newsize); | |
392 | for (i = st; i < newsize; i++) | |
4f9297b0 | 393 | { |
91fa114d VS |
394 | wxHtmlHelpDataItem *item = new wxHtmlHelpDataItem; |
395 | item->name = CacheReadString(f); | |
396 | item->page = CacheReadString(f); | |
397 | item->level = CacheReadInt32(f); | |
398 | item->book = book; | |
399 | int parentShift = CacheReadInt32(f); | |
400 | if (parentShift != 0) | |
401 | item->parent = &m_index[m_index.size() - parentShift]; | |
402 | m_index.Add(item); | |
8ec2b484 | 403 | } |
91fa114d | 404 | return true; |
8ec2b484 HH |
405 | } |
406 | ||
407 | ||
408 | bool wxHtmlHelpData::SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f) | |
409 | { | |
410 | int i; | |
4fd5055c | 411 | wxInt32 cnt; |
f35822af VS |
412 | |
413 | /* save header - version info : */ | |
4fd5055c | 414 | CacheWriteInt32(f, CURRENT_CACHED_BOOK_VERSION); |
d1a9c82b | 415 | CacheWriteInt32(f, CACHED_BOOK_FORMAT_FLAGS); |
8ec2b484 HH |
416 | |
417 | /* save contents : */ | |
91fa114d | 418 | int len = m_contents.size(); |
d1da8872 | 419 | for (cnt = 0, i = 0; i < len; i++) |
91fa114d | 420 | if (m_contents[i].book == book && m_contents[i].level > 0) |
4fd5055c VS |
421 | cnt++; |
422 | CacheWriteInt32(f, cnt); | |
8ec2b484 | 423 | |
91fa114d | 424 | for (i = 0; i < len; i++) |
4f9297b0 | 425 | { |
d1da8872 | 426 | if (m_contents[i].book != book || m_contents[i].level == 0) |
4fd5055c | 427 | continue; |
91fa114d VS |
428 | CacheWriteInt32(f, m_contents[i].level); |
429 | CacheWriteInt32(f, m_contents[i].id); | |
430 | CacheWriteString(f, m_contents[i].name); | |
431 | CacheWriteString(f, m_contents[i].page); | |
8ec2b484 HH |
432 | } |
433 | ||
434 | /* save index : */ | |
91fa114d | 435 | len = m_index.size(); |
d1da8872 WS |
436 | for (cnt = 0, i = 0; i < len; i++) |
437 | if (m_index[i].book == book && m_index[i].level > 0) | |
4fd5055c VS |
438 | cnt++; |
439 | CacheWriteInt32(f, cnt); | |
8ec2b484 | 440 | |
91fa114d | 441 | for (i = 0; i < len; i++) |
4f9297b0 | 442 | { |
d1da8872 | 443 | if (m_index[i].book != book || m_index[i].level == 0) |
4fd5055c | 444 | continue; |
91fa114d VS |
445 | CacheWriteString(f, m_index[i].name); |
446 | CacheWriteString(f, m_index[i].page); | |
447 | CacheWriteInt32(f, m_index[i].level); | |
448 | // save distance to parent item, if any: | |
449 | if (m_index[i].parent == NULL) | |
450 | { | |
451 | CacheWriteInt32(f, 0); | |
452 | } | |
453 | else | |
454 | { | |
17a1ebd1 | 455 | int cnt2 = 0; |
91fa114d VS |
456 | wxHtmlHelpDataItem *parent = m_index[i].parent; |
457 | for (int j = i-1; j >= 0; j--) | |
458 | { | |
459 | if (m_index[j].book == book && m_index[j].level > 0) | |
17a1ebd1 | 460 | cnt2++; |
91fa114d VS |
461 | if (&m_index[j] == parent) |
462 | break; | |
463 | } | |
17a1ebd1 VZ |
464 | wxASSERT(cnt2 > 0); |
465 | CacheWriteInt32(f, cnt2); | |
91fa114d | 466 | } |
8ec2b484 | 467 | } |
91fa114d | 468 | return true; |
8ec2b484 HH |
469 | } |
470 | ||
471 | ||
472 | void wxHtmlHelpData::SetTempDir(const wxString& path) | |
473 | { | |
91fa114d VS |
474 | if (path.empty()) |
475 | m_tempPath = path; | |
04dbb646 | 476 | else |
4f9297b0 | 477 | { |
ec2c85bf VZ |
478 | wxFileName fn(path); |
479 | fn.MakeAbsolute(); | |
8ec2b484 | 480 | |
ec2c85bf | 481 | m_tempPath = fn.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR); |
8ec2b484 HH |
482 | } |
483 | } | |
484 | ||
485 | ||
29e60597 VS |
486 | |
487 | static wxString SafeFileName(const wxString& s) | |
488 | { | |
489 | wxString res(s); | |
490 | res.Replace(wxT("#"), wxT("_")); | |
491 | res.Replace(wxT(":"), wxT("_")); | |
492 | res.Replace(wxT("\\"), wxT("_")); | |
493 | res.Replace(wxT("/"), wxT("_")); | |
494 | return res; | |
495 | } | |
496 | ||
f35822af | 497 | bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile, |
f890e2d4 | 498 | wxFontEncoding encoding, |
f35822af | 499 | const wxString& title, const wxString& contfile, |
d5bb85a0 VS |
500 | const wxString& indexfile, const wxString& deftopic, |
501 | const wxString& path) | |
8ec2b484 HH |
502 | { |
503 | wxFileSystem fsys; | |
504 | wxFSFile *fi; | |
505 | wxHtmlBookRecord *bookr; | |
04dbb646 | 506 | |
91fa114d VS |
507 | int IndexOld = m_index.size(), |
508 | ContentsOld = m_contents.size(); | |
f42b1601 | 509 | |
93763ad5 | 510 | if (!path.empty()) |
d1da8872 | 511 | fsys.ChangePathTo(path, true); |
8ec2b484 | 512 | |
91fa114d | 513 | size_t booksCnt = m_bookRecords.GetCount(); |
5ecdcaa7 VS |
514 | for (size_t i = 0; i < booksCnt; i++) |
515 | { | |
91fa114d VS |
516 | if ( m_bookRecords[i].GetBookFile() == bookfile.GetLocation() ) |
517 | return true; // book is (was) loaded | |
5ecdcaa7 VS |
518 | } |
519 | ||
520 | bookr = new wxHtmlBookRecord(bookfile.GetLocation(), fsys.GetPath(), title, deftopic); | |
d1da8872 | 521 | |
91fa114d VS |
522 | wxHtmlHelpDataItem *bookitem = new wxHtmlHelpDataItem; |
523 | bookitem->level = 0; | |
524 | bookitem->id = 0; | |
525 | bookitem->page = deftopic; | |
526 | bookitem->name = title; | |
527 | bookitem->book = bookr; | |
8ec2b484 HH |
528 | |
529 | // store the contents index for later | |
91fa114d VS |
530 | int cont_start = m_contents.size(); |
531 | ||
532 | m_contents.Add(bookitem); | |
8ec2b484 HH |
533 | |
534 | // Try to find cached binary versions: | |
f35822af VS |
535 | // 1. save file as book, but with .hhp.cached extension |
536 | // 2. same as 1. but in temp path | |
537 | // 3. otherwise or if cache load failed, load it from MS. | |
04dbb646 | 538 | |
f35822af | 539 | fi = fsys.OpenFile(bookfile.GetLocation() + wxT(".cached")); |
04dbb646 VZ |
540 | |
541 | if (fi == NULL || | |
e2b87f38 | 542 | #if wxUSE_DATETIME |
04dbb646 | 543 | fi->GetModificationTime() < bookfile.GetModificationTime() || |
e2b87f38 | 544 | #endif // wxUSE_DATETIME |
4f9297b0 | 545 | !LoadCachedBook(bookr, fi->GetStream())) |
f35822af VS |
546 | { |
547 | if (fi != NULL) delete fi; | |
91fa114d VS |
548 | fi = fsys.OpenFile(m_tempPath + wxFileNameFromPath(bookfile.GetLocation()) + wxT(".cached")); |
549 | if (m_tempPath.empty() || fi == NULL || | |
e2b87f38 | 550 | #if wxUSE_DATETIME |
04dbb646 | 551 | fi->GetModificationTime() < bookfile.GetModificationTime() || |
e2b87f38 | 552 | #endif // wxUSE_DATETIME |
4f9297b0 | 553 | !LoadCachedBook(bookr, fi->GetStream())) |
f35822af VS |
554 | { |
555 | LoadMSProject(bookr, fsys, indexfile, contfile); | |
91fa114d | 556 | if (!m_tempPath.empty()) |
f35822af | 557 | { |
91fa114d | 558 | wxFileOutputStream *outs = new wxFileOutputStream(m_tempPath + |
29e60597 | 559 | SafeFileName(wxFileNameFromPath(bookfile.GetLocation())) + wxT(".cached")); |
f35822af VS |
560 | SaveCachedBook(bookr, outs); |
561 | delete outs; | |
562 | } | |
d5bb85a0 | 563 | } |
8ec2b484 | 564 | } |
04dbb646 | 565 | |
f35822af | 566 | if (fi != NULL) delete fi; |
8ec2b484 HH |
567 | |
568 | // Now store the contents range | |
91fa114d | 569 | bookr->SetContentsRange(cont_start, m_contents.size()); |
04dbb646 | 570 | |
3912b3f8 VS |
571 | // MS HTML Help files [written by MS HTML Help Workshop] are broken |
572 | // in that the data are iso-8859-1 (including HTML entities), but must | |
573 | // be interpreted as being in language's windows charset. Correct the | |
574 | // differences here and also convert to wxConvLocal in ANSI build | |
67c276bd | 575 | if (encoding != wxFONTENCODING_SYSTEM) |
3912b3f8 VS |
576 | { |
577 | #if wxUSE_UNICODE | |
578 | #define CORRECT_STR(str, conv) \ | |
579 | str = wxString((str).mb_str(wxConvISO8859_1), conv) | |
580 | #else | |
581 | #define CORRECT_STR(str, conv) \ | |
582 | str = wxString((str).wc_str(conv), wxConvLocal) | |
583 | #endif | |
67c276bd | 584 | wxCSConv conv(encoding); |
91fa114d VS |
585 | size_t IndexCnt = m_index.size(); |
586 | size_t ContentsCnt = m_contents.size(); | |
587 | size_t i; | |
588 | for (i = IndexOld; i < IndexCnt; i++) | |
f890e2d4 | 589 | { |
91fa114d | 590 | CORRECT_STR(m_index[i].name, conv); |
f890e2d4 | 591 | } |
91fa114d | 592 | for (i = ContentsOld; i < ContentsCnt; i++) |
3912b3f8 | 593 | { |
91fa114d | 594 | CORRECT_STR(m_contents[i].name, conv); |
3912b3f8 VS |
595 | } |
596 | #undef CORRECT_STR | |
f890e2d4 | 597 | } |
8ec2b484 | 598 | |
91fa114d VS |
599 | m_bookRecords.Add(bookr); |
600 | if (!m_index.empty()) | |
601 | { | |
602 | m_index.Sort(wxHtmlHelpIndexCompareFunc); | |
603 | } | |
f42b1601 | 604 | |
91fa114d | 605 | return true; |
8ec2b484 HH |
606 | } |
607 | ||
608 | ||
609 | bool wxHtmlHelpData::AddBook(const wxString& book) | |
610 | { | |
3527f29c VS |
611 | wxString extension(book.Right(4).Lower()); |
612 | if (extension == wxT(".zip") || | |
613 | #if wxUSE_LIBMSPACK | |
614 | extension == wxT(".chm") /*compressed html help book*/ || | |
615 | #endif | |
616 | extension == wxT(".htb") /*html book*/) | |
68364659 VS |
617 | { |
618 | wxFileSystem fsys; | |
619 | wxString s; | |
d1da8872 | 620 | bool rt = false; |
68364659 | 621 | |
3527f29c VS |
622 | #if wxUSE_LIBMSPACK |
623 | if (extension == wxT(".chm")) | |
624 | s = fsys.FindFirst(book + wxT("#chm:*.hhp"), wxFILE); | |
625 | else | |
626 | #endif | |
627 | s = fsys.FindFirst(book + wxT("#zip:*.hhp"), wxFILE); | |
628 | ||
93763ad5 | 629 | while (!s.empty()) |
68364659 | 630 | { |
d1da8872 | 631 | if (AddBook(s)) rt = true; |
68364659 VS |
632 | s = fsys.FindNext(); |
633 | } | |
04dbb646 | 634 | |
68364659 VS |
635 | return rt; |
636 | } | |
68364659 | 637 | |
a509f830 VZ |
638 | wxFSFile *fi; |
639 | wxFileSystem fsys; | |
3dde6c72 | 640 | |
a509f830 VZ |
641 | wxString title = _("noname"), |
642 | safetitle, | |
643 | start = wxEmptyString, | |
644 | contents = wxEmptyString, | |
645 | index = wxEmptyString, | |
646 | charset = wxEmptyString; | |
68364659 | 647 | |
a509f830 VZ |
648 | fi = fsys.OpenFile(book); |
649 | if (fi == NULL) | |
650 | { | |
651 | wxLogError(_("Cannot open HTML help book: %s"), book.c_str()); | |
d1da8872 | 652 | return false; |
68364659 | 653 | } |
a509f830 VZ |
654 | fsys.ChangePathTo(book); |
655 | ||
656 | const wxChar *lineptr; | |
657 | wxChar linebuf[300]; | |
658 | wxString tmp; | |
659 | wxHtmlFilterPlainText filter; | |
660 | tmp = filter.ReadFile(*fi); | |
661 | lineptr = tmp.c_str(); | |
662 | ||
d1da8872 | 663 | do |
a509f830 VZ |
664 | { |
665 | lineptr = ReadLine(lineptr, linebuf, 300); | |
d1da8872 | 666 | |
a509f830 | 667 | for (wxChar *ch = linebuf; *ch != wxT('\0') && *ch != wxT('='); ch++) |
42841dfc | 668 | *ch = (wxChar)wxTolower(*ch); |
a509f830 | 669 | |
9a83f860 VZ |
670 | if (wxStrstr(linebuf, wxT("title=")) == linebuf) |
671 | title = linebuf + wxStrlen(wxT("title=")); | |
672 | if (wxStrstr(linebuf, wxT("default topic=")) == linebuf) | |
673 | start = linebuf + wxStrlen(wxT("default topic=")); | |
674 | if (wxStrstr(linebuf, wxT("index file=")) == linebuf) | |
675 | index = linebuf + wxStrlen(wxT("index file=")); | |
676 | if (wxStrstr(linebuf, wxT("contents file=")) == linebuf) | |
677 | contents = linebuf + wxStrlen(wxT("contents file=")); | |
678 | if (wxStrstr(linebuf, wxT("charset=")) == linebuf) | |
679 | charset = linebuf + wxStrlen(wxT("charset=")); | |
a509f830 | 680 | } while (lineptr != NULL); |
d1da8872 | 681 | |
5a969262 RR |
682 | wxFontEncoding enc = wxFONTENCODING_SYSTEM; |
683 | #if wxUSE_FONTMAP | |
684 | if (charset != wxEmptyString) | |
685 | enc = wxFontMapper::Get()->CharsetToEncoding(charset); | |
686 | #endif | |
a509f830 | 687 | |
94323b60 JS |
688 | // No conversion was done on the title yet; at least |
689 | // test for a common case. | |
690 | if (charset == wxT("utf-8") && !title.IsEmpty()) | |
691 | { | |
692 | char *buf = new char[title.Length()+1]; | |
693 | size_t i; | |
694 | for (i = 0; i < title.Length(); i++) | |
695 | buf[i] = (char) title[i]; | |
696 | buf[i] = 0; | |
697 | title = wxString::FromUTF8(buf); | |
698 | delete[] buf; | |
699 | } | |
700 | ||
67c276bd | 701 | bool rtval = AddBookParam(*fi, enc, |
a509f830 VZ |
702 | title, contents, index, start, fsys.GetPath()); |
703 | delete fi; | |
91fa114d | 704 | |
a509f830 | 705 | return rtval; |
8ec2b484 HH |
706 | } |
707 | ||
708 | wxString wxHtmlHelpData::FindPageByName(const wxString& x) | |
709 | { | |
8ec2b484 | 710 | int i; |
8ec2b484 | 711 | |
8680ee06 RR |
712 | bool has_non_ascii = false; |
713 | wxString::const_iterator it; | |
714 | for (it = x.begin(); it != x.end(); ++it) | |
715 | { | |
716 | wxUniChar ch = *it; | |
717 | if (!ch.IsAscii()) | |
718 | { | |
719 | has_non_ascii = true; | |
720 | break; | |
721 | } | |
722 | } | |
03647350 | 723 | |
8680ee06 | 724 | int cnt = m_bookRecords.GetCount(); |
03647350 | 725 | |
8680ee06 | 726 | if (!has_non_ascii) |
4f9297b0 | 727 | { |
8680ee06 RR |
728 | wxFileSystem fsys; |
729 | wxFSFile *f; | |
730 | // 1. try to open given file: | |
731 | for (i = 0; i < cnt; i++) | |
732 | { | |
91fa114d | 733 | f = fsys.OpenFile(m_bookRecords[i].GetFullPath(x)); |
04dbb646 VZ |
734 | if (f) |
735 | { | |
91fa114d | 736 | wxString url = m_bookRecords[i].GetFullPath(x); |
8ec2b484 HH |
737 | delete f; |
738 | return url; | |
739 | } | |
8680ee06 | 740 | } |
8ec2b484 HH |
741 | } |
742 | ||
743 | ||
735a74df | 744 | // 2. try to find a book: |
04dbb646 | 745 | for (i = 0; i < cnt; i++) |
4f9297b0 | 746 | { |
91fa114d VS |
747 | if (m_bookRecords[i].GetTitle() == x) |
748 | return m_bookRecords[i].GetFullPath(m_bookRecords[i].GetStart()); | |
8ec2b484 HH |
749 | } |
750 | ||
735a74df | 751 | // 3. try to find in contents: |
91fa114d | 752 | cnt = m_contents.size(); |
04dbb646 | 753 | for (i = 0; i < cnt; i++) |
4f9297b0 | 754 | { |
91fa114d VS |
755 | if (m_contents[i].name == x) |
756 | return m_contents[i].GetFullPath(); | |
8ec2b484 HH |
757 | } |
758 | ||
759 | ||
735a74df | 760 | // 4. try to find in index: |
91fa114d | 761 | cnt = m_index.size(); |
04dbb646 | 762 | for (i = 0; i < cnt; i++) |
4f9297b0 | 763 | { |
91fa114d VS |
764 | if (m_index[i].name == x) |
765 | return m_index[i].GetFullPath(); | |
8ec2b484 HH |
766 | } |
767 | ||
735a74df VZ |
768 | // 4b. if still not found, try case-insensitive comparison |
769 | for (i = 0; i < cnt; i++) | |
770 | { | |
771 | if (m_index[i].name.CmpNoCase(x) == 0) | |
772 | return m_index[i].GetFullPath(); | |
773 | } | |
774 | ||
91fa114d | 775 | return wxEmptyString; |
8ec2b484 HH |
776 | } |
777 | ||
778 | wxString wxHtmlHelpData::FindPageById(int id) | |
f42b1601 | 779 | { |
91fa114d VS |
780 | size_t cnt = m_contents.size(); |
781 | for (size_t i = 0; i < cnt; i++) | |
4f9297b0 | 782 | { |
91fa114d | 783 | if (m_contents[i].id == id) |
04dbb646 | 784 | { |
91fa114d | 785 | return m_contents[i].GetFullPath(); |
8ec2b484 HH |
786 | } |
787 | } | |
788 | ||
91fa114d VS |
789 | return wxEmptyString; |
790 | } | |
791 | ||
91fa114d | 792 | |
8ec2b484 HH |
793 | //---------------------------------------------------------------------------------- |
794 | // wxHtmlSearchStatus functions | |
795 | //---------------------------------------------------------------------------------- | |
796 | ||
797 | wxHtmlSearchStatus::wxHtmlSearchStatus(wxHtmlHelpData* data, const wxString& keyword, | |
c4971147 | 798 | bool case_sensitive, bool whole_words_only, |
d5bb85a0 | 799 | const wxString& book) |
8ec2b484 HH |
800 | { |
801 | m_Data = data; | |
802 | m_Keyword = keyword; | |
803 | wxHtmlBookRecord* bookr = NULL; | |
04dbb646 | 804 | if (book != wxEmptyString) |
4f9297b0 | 805 | { |
d5bb85a0 | 806 | // we have to search in a specific book. Find it first |
91fa114d | 807 | int i, cnt = data->m_bookRecords.GetCount(); |
d5bb85a0 | 808 | for (i = 0; i < cnt; i++) |
91fa114d | 809 | if (data->m_bookRecords[i].GetTitle() == book) |
04dbb646 | 810 | { |
91fa114d | 811 | bookr = &(data->m_bookRecords[i]); |
d5bb85a0 VS |
812 | m_CurIndex = bookr->GetContentsStart(); |
813 | m_MaxIndex = bookr->GetContentsEnd(); | |
814 | break; | |
815 | } | |
816 | // check; we won't crash if the book doesn't exist, but it's Bad Anyway. | |
817 | wxASSERT(bookr); | |
8ec2b484 | 818 | } |
04dbb646 | 819 | if (! bookr) |
4f9297b0 | 820 | { |
d5bb85a0 VS |
821 | // no book specified; search all books |
822 | m_CurIndex = 0; | |
91fa114d | 823 | m_MaxIndex = m_Data->m_contents.size(); |
8ec2b484 | 824 | } |
c4971147 | 825 | m_Engine.LookFor(keyword, case_sensitive, whole_words_only); |
8ec2b484 | 826 | m_Active = (m_CurIndex < m_MaxIndex); |
8ec2b484 HH |
827 | } |
828 | ||
829 | bool wxHtmlSearchStatus::Search() | |
830 | { | |
8ec2b484 | 831 | wxFSFile *file; |
d5bb85a0 | 832 | int i = m_CurIndex; // shortcut |
91fa114d | 833 | bool found = false; |
3912b3f8 | 834 | wxString thepage; |
8ec2b484 | 835 | |
04dbb646 | 836 | if (!m_Active) |
4f9297b0 | 837 | { |
f35822af | 838 | // sanity check. Illegal use, but we'll try to prevent a crash anyway |
50494a55 | 839 | wxASSERT(m_Active); |
91fa114d | 840 | return false; |
8ec2b484 HH |
841 | } |
842 | ||
8ec2b484 | 843 | m_Name = wxEmptyString; |
91fa114d VS |
844 | m_CurItem = NULL; |
845 | thepage = m_Data->m_contents[i].page; | |
8ec2b484 | 846 | |
b5a7b000 VS |
847 | m_Active = (++m_CurIndex < m_MaxIndex); |
848 | // check if it is same page with different anchor: | |
3912b3f8 | 849 | if (!m_LastPage.empty()) |
b5a7b000 | 850 | { |
3912b3f8 VS |
851 | const wxChar *p1, *p2; |
852 | for (p1 = thepage.c_str(), p2 = m_LastPage.c_str(); | |
9a83f860 | 853 | *p1 != 0 && *p1 != wxT('#') && *p1 == *p2; p1++, p2++) {} |
b5a7b000 VS |
854 | |
855 | m_LastPage = thepage; | |
856 | ||
9a83f860 | 857 | if (*p1 == 0 || *p1 == wxT('#')) |
3912b3f8 | 858 | return false; |
b5a7b000 VS |
859 | } |
860 | else m_LastPage = thepage; | |
04dbb646 | 861 | |
f35822af | 862 | wxFileSystem fsys; |
91fa114d | 863 | file = fsys.OpenFile(m_Data->m_contents[i].book->GetFullPath(thepage)); |
04dbb646 | 864 | if (file) |
b5a7b000 | 865 | { |
2b5f62a0 | 866 | if (m_Engine.Scan(*file)) |
468ae730 | 867 | { |
91fa114d VS |
868 | m_Name = m_Data->m_contents[i].name; |
869 | m_CurItem = &m_Data->m_contents[i]; | |
870 | found = true; | |
d5bb85a0 VS |
871 | } |
872 | delete file; | |
8ec2b484 | 873 | } |
8ec2b484 HH |
874 | return found; |
875 | } | |
876 | ||
d5bb85a0 VS |
877 | |
878 | ||
879 | ||
880 | ||
881 | ||
882 | ||
883 | ||
884 | //-------------------------------------------------------------------------------- | |
2b5f62a0 | 885 | // wxHtmlSearchEngine |
d5bb85a0 VS |
886 | //-------------------------------------------------------------------------------- |
887 | ||
2b5f62a0 | 888 | void wxHtmlSearchEngine::LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only) |
d5bb85a0 | 889 | { |
c4971147 VS |
890 | m_CaseSensitive = case_sensitive; |
891 | m_WholeWords = whole_words_only; | |
3912b3f8 | 892 | m_Keyword = keyword; |
04dbb646 | 893 | |
3444e4a8 | 894 | if (!m_CaseSensitive) |
3912b3f8 | 895 | m_Keyword.LowerCase(); |
d5bb85a0 VS |
896 | } |
897 | ||
898 | ||
1a1dac18 MB |
899 | static inline bool WHITESPACE(wxChar c) |
900 | { | |
9a83f860 | 901 | return c == wxT(' ') || c == wxT('\n') || c == wxT('\r') || c == wxT('\t'); |
1a1dac18 | 902 | } |
c4971147 | 903 | |
21dc4638 VZ |
904 | // replace continuous spaces by one single space |
905 | static inline wxString CompressSpaces(const wxString & str) | |
906 | { | |
907 | wxString buf; | |
908 | buf.reserve( str.size() ); | |
909 | ||
910 | bool space_counted = false; | |
911 | for( const wxChar * pstr = str.c_str(); *pstr; ++pstr ) | |
912 | { | |
913 | wxChar ch = *pstr; | |
914 | if( WHITESPACE( ch ) ) | |
915 | { | |
916 | if( space_counted ) | |
917 | { | |
918 | continue; | |
919 | } | |
9a83f860 | 920 | ch = wxT(' '); |
21dc4638 VZ |
921 | space_counted = true; |
922 | } | |
923 | else | |
924 | { | |
925 | space_counted = false; | |
926 | } | |
927 | buf += ch; | |
928 | } | |
929 | ||
930 | return buf; | |
931 | } | |
932 | ||
2b5f62a0 | 933 | bool wxHtmlSearchEngine::Scan(const wxFSFile& file) |
d5bb85a0 | 934 | { |
3912b3f8 | 935 | wxASSERT_MSG(!m_Keyword.empty(), wxT("wxHtmlSearchEngine::LookFor must be called before scanning!")); |
d5bb85a0 | 936 | |
2b5f62a0 | 937 | wxHtmlFilterHTML filter; |
21dc4638 | 938 | wxString bufStr = filter.ReadFile(file); |
d5bb85a0 | 939 | |
c4971147 | 940 | if (!m_CaseSensitive) |
21dc4638 | 941 | bufStr.LowerCase(); |
d5bb85a0 | 942 | |
21dc4638 VZ |
943 | { // remove html tags |
944 | wxString bufStrCopy; | |
945 | bufStrCopy.reserve( bufStr.size() ); | |
946 | bool insideTag = false; | |
947 | for (const wxChar * pBufStr = bufStr.c_str(); *pBufStr; ++pBufStr) | |
04dbb646 | 948 | { |
21dc4638 VZ |
949 | wxChar c = *pBufStr; |
950 | if (insideTag) | |
951 | { | |
9a83f860 | 952 | if (c == wxT('>')) |
21dc4638 VZ |
953 | { |
954 | insideTag = false; | |
955 | // replace the tag by an empty space | |
9a83f860 | 956 | c = wxT(' '); |
21dc4638 VZ |
957 | } |
958 | else | |
959 | continue; | |
960 | } | |
9a83f860 | 961 | else if (c == wxT('<')) |
21dc4638 VZ |
962 | { |
963 | wxChar nextCh = *(pBufStr + 1); | |
9a83f860 | 964 | if (nextCh == wxT('/') || !WHITESPACE(nextCh)) |
21dc4638 VZ |
965 | { |
966 | insideTag = true; | |
967 | continue; | |
968 | } | |
969 | } | |
970 | bufStrCopy += c; | |
c4971147 | 971 | } |
21dc4638 | 972 | bufStr.swap( bufStrCopy ); |
c4971147 | 973 | } |
04dbb646 | 974 | |
21dc4638 VZ |
975 | wxString keyword = m_Keyword; |
976 | ||
977 | if (m_WholeWords) | |
c4971147 | 978 | { |
21dc4638 | 979 | // insert ' ' at the beginning and at the end |
9a83f860 VZ |
980 | keyword.insert( 0, wxT(" ") ); |
981 | keyword.append( wxT(" ") ); | |
982 | bufStr.insert( 0, wxT(" ") ); | |
983 | bufStr.append( wxT(" ") ); | |
d5bb85a0 VS |
984 | } |
985 | ||
21dc4638 VZ |
986 | // remove continuous spaces |
987 | keyword = CompressSpaces( keyword ); | |
988 | bufStr = CompressSpaces( bufStr ); | |
d5bb85a0 | 989 | |
21dc4638 VZ |
990 | // finally do the search |
991 | return bufStr.find( keyword ) != wxString::npos; | |
992 | } | |
d5bb85a0 | 993 | |
8ec2b484 | 994 | #endif |