]> git.saurik.com Git - wxWidgets.git/blob - src/generic/helpext.cpp
(much) more efficient report mode redrawing
[wxWidgets.git] / src / generic / helpext.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: helpext.cpp
3 // Purpose: an external help controller for wxWindows
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 #ifdef __GNUG__
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
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 #endif
31
32 #include "wx/helpbase.h"
33 #include "wx/generic/helpext.h"
34
35 #include <stdio.h>
36 #include <ctype.h>
37 #include <sys/stat.h>
38
39 #if !defined(__WINDOWS__) && !defined(__OS2__)
40 #include <unistd.h>
41 #endif
42
43 #ifdef __WXMSW__
44 #include <windows.h>
45 #endif
46
47 IMPLEMENT_CLASS(wxExtHelpController, wxHTMLHelpControllerBase)
48
49 /**
50 This class implements help via an external browser.
51 It requires the name of a directory containing the documentation
52 and a file mapping numerical Section numbers to relative URLS.
53 */
54
55 wxExtHelpController::wxExtHelpController(void)
56 {
57 m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
58 m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
59
60 char *browser = getenv(WXEXTHELP_ENVVAR_BROWSER);
61 if(browser)
62 {
63 m_BrowserName = browser;
64 browser = getenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE);
65 m_BrowserIsNetscape = browser && (atoi(browser) != 0);
66 }
67 }
68
69
70 void
71 wxExtHelpController::SetBrowser(wxString const & browsername, bool isNetscape)
72 {
73 m_BrowserName = browsername;
74 m_BrowserIsNetscape = isNetscape;
75 }
76
77 // Set viewer: new, generic name for SetBrowser
78 void wxExtHelpController::SetViewer(const wxString& viewer, long flags)
79 {
80 SetBrowser(viewer, ((flags & wxHELP_NETSCAPE) == wxHELP_NETSCAPE));
81 }
82
83 bool
84 wxExtHelpController::DisplayHelp(const wxString &relativeURL)
85 {
86 wxBusyCursor b; // display a busy cursor
87
88
89 #if defined(__WXMSW__)
90 wxString url;
91 url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
92 bool bOk = (int)ShellExecute(NULL, wxT("open"), url.c_str(),
93 NULL, NULL, SW_SHOWNORMAL ) > 32;
94 if ( !bOk )
95 {
96 wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
97 return false;
98 }
99 else
100 return true;
101 #elif defined(__WXPM__)
102 wxString url;
103 url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
104 // will have to fix for OS/2, later.....DW
105 // bool bOk = (int)ShellExecute(NULL, "open", url,
106 // NULL, NULL, SW_SHOWNORMAL ) > 32;
107 // if ( !bOk )
108 // {
109 // wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
110 // return false;
111 // }
112 // else
113 return TRUE;
114 #else
115 // assume UNIX
116 wxString command;
117
118 if(m_BrowserIsNetscape) // try re-loading first
119 {
120 wxString lockfile;
121 wxGetHomeDir(&lockfile);
122 #ifdef __VMS__
123 lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape]lock.");
124 struct stat statbuf;
125 if(stat(lockfile.fn_str(), &statbuf) == 0)
126 #else
127 lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape/lock");
128 struct stat statbuf;
129 if(lstat(lockfile.fn_str(), &statbuf) == 0)
130 // cannot use wxFileExists, because it's a link pointing to a
131 // non-existing location if(wxFileExists(lockfile))
132 #endif
133 {
134 long success;
135 command << m_BrowserName << wxT(" -remote openURL(")
136 << wxT("file://") << m_MapFile
137 << WXEXTHELP_SEPARATOR << relativeURL << wxT(")");
138 success = wxExecute(command);
139 if(success != 0 ) // returns PID on success
140 return TRUE;
141 }
142 }
143 command = m_BrowserName;
144 command << wxT(" file://")
145 << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
146 return wxExecute(command) != 0;
147 #endif
148 }
149
150 #endif // wxUSE_HELP
151