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