]> git.saurik.com Git - wxWidgets.git/blob - src/generic/helpext.cpp
guard for 10.2
[wxWidgets.git] / src / generic / helpext.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: helpext.cpp
3 // Purpose: an external help controller for wxWidgets
4 // Author: Karsten Ballueder
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Karsten Ballueder
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 # pragma implementation "wxexthlp.h"
14 #endif
15
16 #include "wx/wxprec.h"
17
18 #ifdef __BORLANDC__
19 #pragma hdrstop
20 #endif
21
22 #if wxUSE_HELP && !defined(__WXWINCE__) && (!defined(__WXMAC__) || defined(__WXMAC_OSX__))
23
24 #ifndef WX_PRECOMP
25 #include "wx/setup.h"
26 #include "wx/string.h"
27 #include "wx/utils.h"
28 #include "wx/list.h"
29 #include "wx/intl.h"
30 #include "wx/msgdlg.h"
31 #include "wx/choicdlg.h"
32 #include "wx/log.h"
33 #endif
34
35 #include "wx/helpbase.h"
36 #include "wx/generic/helpext.h"
37
38 #include <stdio.h>
39 #include <ctype.h>
40 #include <sys/stat.h>
41
42 #if !defined(__WINDOWS__) && !defined(__OS2__)
43 #include <unistd.h>
44 #endif
45
46 #ifdef __WXMSW__
47 #include <windows.h>
48 #endif
49
50 // ----------------------------------------------------------------------------
51 // constants
52 // ----------------------------------------------------------------------------
53
54 /// Name for map file.
55 #define WXEXTHELP_MAPFILE _T("wxhelp.map")
56 /// Maximum line length in map file.
57 #define WXEXTHELP_BUFLEN 512
58 /// Character introducing comments/documentation field in map file.
59 #define WXEXTHELP_COMMENTCHAR ';'
60
61 #define CONTENTS_ID 0
62
63 IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
64
65 /// Name of environment variable to set help browser.
66 #define WXEXTHELP_ENVVAR_BROWSER wxT("WX_HELPBROWSER")
67 /// Is browser a netscape browser?
68 #define WXEXTHELP_ENVVAR_BROWSERISNETSCAPE wxT("WX_HELPBROWSER_NS")
69
70 /**
71 This class implements help via an external browser.
72 It requires the name of a directory containing the documentation
73 and a file mapping numerical Section numbers to relative URLS.
74 */
75
76 wxExtHelpController::wxExtHelpController()
77 {
78 m_MapList = (wxList*) NULL;
79 m_NumOfEntries = 0;
80 m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
81 m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
82
83 wxChar *browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSER);
84 if(browser)
85 {
86 m_BrowserName = browser;
87 browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE);
88 m_BrowserIsNetscape = browser && (wxAtoi(browser) != 0);
89 }
90 }
91
92 wxExtHelpController::~wxExtHelpController()
93 {
94 DeleteList();
95 }
96
97 void wxExtHelpController::SetBrowser(const wxString& browsername, bool isNetscape)
98 {
99 m_BrowserName = browsername;
100 m_BrowserIsNetscape = isNetscape;
101 }
102
103 // Set viewer: new, generic name for SetBrowser
104 void wxExtHelpController::SetViewer(const wxString& viewer, long flags)
105 {
106 SetBrowser(viewer, ((flags & wxHELP_NETSCAPE) == wxHELP_NETSCAPE));
107 }
108
109 bool
110 wxExtHelpController::DisplayHelp(const wxString &relativeURL)
111 {
112 wxBusyCursor b; // display a busy cursor
113
114
115 #if defined(__WXMSW__)
116 wxString url;
117 url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
118 bool bOk = (int)ShellExecute(NULL, wxT("open"), url.c_str(),
119 NULL, NULL, SW_SHOWNORMAL ) > 32;
120 if ( !bOk )
121 {
122 wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
123 return false;
124 }
125
126 return true;
127 #elif defined(__WXPM__)
128
129 wxString url;
130 url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
131 // will have to fix for OS/2, later.....DW
132 // bool bOk = (int)ShellExecute(NULL, "open", url,
133 // NULL, NULL, SW_SHOWNORMAL ) > 32;
134 // if ( !bOk )
135 // {
136 // wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
137 // return false;
138 // }
139 // else
140 return true;
141
142 #elif defined(__DOS__)
143
144 wxString command;
145 command = m_BrowserName;
146 command << wxT(" file://")
147 << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
148 return wxExecute(command) != 0;
149
150 #else // UNIX
151 wxString command;
152
153 #ifndef __EMX__
154 if(m_BrowserIsNetscape) // try re-loading first
155 {
156 wxString lockfile;
157 wxGetHomeDir(&lockfile);
158 #ifdef __VMS__
159 lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape]lock.");
160 struct stat statbuf;
161 if(stat(lockfile.fn_str(), &statbuf) == 0)
162 #else
163 lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape/lock");
164 struct stat statbuf;
165 if(lstat(lockfile.fn_str(), &statbuf) == 0)
166 // cannot use wxFileExists, because it's a link pointing to a
167 // non-existing location if(wxFileExists(lockfile))
168 #endif
169 {
170 long success;
171 command << m_BrowserName << wxT(" -remote openURL(")
172 << wxT("file://") << m_MapFile
173 << WXEXTHELP_SEPARATOR << relativeURL << wxT(")");
174 success = wxExecute(command);
175 if(success != 0 ) // returns PID on success
176 return true;
177 }
178 }
179 #endif
180 command = m_BrowserName;
181 command << wxT(" file://")
182 << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
183 return wxExecute(command) != 0;
184 #endif
185 }
186
187 class wxExtHelpMapEntry : public wxObject
188 {
189 public:
190 int id;
191 wxString url;
192 wxString doc;
193 wxExtHelpMapEntry(int iid, wxString const &iurl, wxString const &idoc)
194 { id = iid; url = iurl; doc = idoc; }
195 };
196
197 void wxExtHelpController::DeleteList()
198 {
199 if(m_MapList)
200 {
201 wxList::compatibility_iterator node = m_MapList->GetFirst();
202 while (node)
203 {
204 delete (wxExtHelpMapEntry *)node->GetData();
205 m_MapList->Erase(node);
206 node = m_MapList->GetFirst();
207 }
208 delete m_MapList;
209 m_MapList = (wxList*) NULL;
210 }
211 }
212
213 /** This must be called to tell the controller where to find the
214 documentation.
215 @param file - NOT a filename, but a directory name.
216 @return true on success
217 */
218 bool
219 wxExtHelpController::Initialize(const wxString& file)
220 {
221 return LoadFile(file);
222 }
223
224
225 // ifile is the name of the base help directory
226 bool wxExtHelpController::LoadFile(const wxString& ifile)
227 {
228 wxString mapFile, file, url, doc;
229 int id,i,len;
230 char buffer[WXEXTHELP_BUFLEN];
231
232 wxBusyCursor b; // display a busy cursor
233
234 if(! ifile.empty())
235 {
236 file = ifile;
237 if(! wxIsAbsolutePath(file))
238 {
239 wxChar* f = wxGetWorkingDirectory();
240 file = f;
241 delete[] f; // wxGetWorkingDirectory returns new memory
242 #ifdef __WXMAC__
243 file << ifile;
244 #else
245 file << WXEXTHELP_SEPARATOR << ifile;
246 #endif
247 }
248 else
249 file = ifile;
250
251 #if wxUSE_INTL
252 // If a locale is set, look in file/localename, i.e.
253 // If passed "/usr/local/myapp/help" and the current wxLocale is
254 // set to be "de", then look in "/usr/local/myapp/help/de/"
255 // first and fall back to "/usr/local/myapp/help" if that
256 // doesn't exist.
257 if(wxGetLocale() && !wxGetLocale()->GetName().empty())
258 {
259 wxString newfile;
260 newfile << WXEXTHELP_SEPARATOR << wxGetLocale()->GetName();
261 if(wxDirExists(newfile))
262 file = newfile;
263 else
264 {
265 newfile = WXEXTHELP_SEPARATOR;
266 const wxChar *cptr = wxGetLocale()->GetName().c_str();
267 while(*cptr && *cptr != wxT('_'))
268 newfile << *(cptr++);
269 if(wxDirExists(newfile))
270 file = newfile;
271 }
272 }
273 #endif
274
275 if(! wxDirExists(file))
276 return false;
277
278 mapFile << file << WXEXTHELP_SEPARATOR << WXEXTHELP_MAPFILE;
279 }
280 else // try to reload old file
281 mapFile = m_MapFile;
282
283 if(! wxFileExists(mapFile))
284 return false;
285
286 DeleteList();
287 m_MapList = new wxList;
288 m_NumOfEntries = 0;
289
290 FILE *input = wxFopen(mapFile,wxT("rt"));
291 if(! input)
292 return false;
293 do
294 {
295 if(fgets(buffer,WXEXTHELP_BUFLEN,input) && *buffer != WXEXTHELP_COMMENTCHAR)
296 {
297 len = strlen(buffer);
298 if(buffer[len-1] == '\n')
299 buffer[len-1] = '\0'; // cut of trailing newline
300 if(sscanf(buffer,"%d", &id) != 1)
301 break; // error
302 for(i=0; isdigit(buffer[i])||isspace(buffer[i])||buffer[i]=='-'; i++)
303 ; // find begin of URL
304 url = wxEmptyString;
305 while(buffer[i] && ! isspace(buffer[i]) && buffer[i] !=
306 WXEXTHELP_COMMENTCHAR)
307 url << (wxChar) buffer[i++];
308 while(buffer[i] && buffer[i] != WXEXTHELP_COMMENTCHAR)
309 i++;
310 doc = wxEmptyString;
311 if(buffer[i])
312 doc = wxString::FromAscii( (buffer + i + 1) ); // skip the comment character
313 m_MapList->Append(new wxExtHelpMapEntry(id,url,doc));
314 m_NumOfEntries++;
315 }
316 }while(! feof(input));
317 fclose(input);
318
319 m_MapFile = file; // now it's valid
320 return true;
321 }
322
323
324 bool
325 wxExtHelpController::DisplayContents()
326 {
327 if(! m_NumOfEntries)
328 return false;
329
330 wxString contents;
331 wxList::compatibility_iterator node = m_MapList->GetFirst();
332 wxExtHelpMapEntry *entry;
333 while(node)
334 {
335 entry = (wxExtHelpMapEntry *)node->GetData();
336 if(entry->id == CONTENTS_ID)
337 {
338 contents = entry->url;
339 break;
340 }
341 node = node->GetNext();
342 }
343
344 bool rc = false;
345 wxString file;
346 file << m_MapFile << WXEXTHELP_SEPARATOR << contents;
347 if(file.Contains(wxT('#')))
348 file = file.BeforeLast(wxT('#'));
349 if(contents.Length() && wxFileExists(file))
350 rc = DisplaySection(CONTENTS_ID);
351
352 // if not found, open homemade toc:
353 return rc ? true : KeywordSearch(wxEmptyString);
354 }
355
356 bool
357 wxExtHelpController::DisplaySection(int sectionNo)
358 {
359 if(! m_NumOfEntries)
360 return false;
361
362 wxBusyCursor b; // display a busy cursor
363 wxList::compatibility_iterator node = m_MapList->GetFirst();
364 wxExtHelpMapEntry *entry;
365 while(node)
366 {
367 entry = (wxExtHelpMapEntry *)node->GetData();
368 if(entry->id == sectionNo)
369 return DisplayHelp(entry->url);
370 node = node->GetNext();
371 }
372 return false;
373 }
374
375 bool wxExtHelpController::DisplaySection(const wxString& section)
376 {
377 bool isFilename = (section.Find(wxT(".htm")) != -1);
378
379 if (isFilename)
380 return DisplayHelp(section);
381 else
382 return KeywordSearch(section);
383 }
384
385 bool
386 wxExtHelpController::DisplayBlock(long blockNo)
387 {
388 return DisplaySection((int)blockNo);
389 }
390
391 bool
392 wxExtHelpController::KeywordSearch(const wxString& k,
393 wxHelpSearchMode WXUNUSED(mode))
394 {
395 if(! m_NumOfEntries)
396 return false;
397
398 wxString *choices = new wxString[m_NumOfEntries];
399 wxString *urls = new wxString[m_NumOfEntries];
400 wxString compA, compB;
401
402 int idx = 0, j;
403 bool rc;
404 bool showAll = k.empty();
405 wxList::compatibility_iterator node = m_MapList->GetFirst();
406 wxExtHelpMapEntry *entry;
407
408 {
409 wxBusyCursor b; // display a busy cursor
410 compA = k; compA.LowerCase(); // we compare case insensitive
411 while(node)
412 {
413 entry = (wxExtHelpMapEntry *)node->GetData();
414 compB = entry->doc; compB.LowerCase();
415 if((showAll || compB.Contains(k)) && ! compB.empty())
416 {
417 urls[idx] = entry->url;
418 // doesn't work:
419 // choices[idx] = (**i).doc.Contains((**i).doc.Before(WXEXTHELP_COMMENTCHAR));
420 //if(choices[idx].empty()) // didn't contain the ';'
421 // choices[idx] = (**i).doc;
422 choices[idx] = wxEmptyString;
423 for(j=0;entry->doc.c_str()[j]
424 && entry->doc.c_str()[j] != WXEXTHELP_COMMENTCHAR; j++)
425 choices[idx] << entry->doc.c_str()[j];
426 idx++;
427 }
428 node = node->GetNext();
429 }
430 }
431
432 if(idx == 1)
433 rc = DisplayHelp(urls[0]);
434 else if(idx == 0)
435 {
436 wxMessageBox(_("No entries found."));
437 rc = false;
438 }
439 else
440 {
441 idx = wxGetSingleChoiceIndex(showAll ? _("Help Index") : _("Relevant entries:"),
442 showAll ? _("Help Index") : _("Entries found"),
443 idx,choices);
444 if(idx != -1)
445 rc = DisplayHelp(urls[idx]);
446 else
447 rc = false;
448 }
449 delete[] urls;
450 delete[] choices;
451
452 return rc;
453 }
454
455
456 bool wxExtHelpController::Quit()
457 {
458 return true;
459 }
460
461 void wxExtHelpController::OnQuit()
462 {
463 }
464
465
466 #endif // wxUSE_HELP
467