X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2364556be3ab7c26cc23a74a67aeb1c7019a51f5..daebb84bff054d3833baca58a5dc506de56c64a1:/src/generic/helpext.cpp?ds=sidebyside diff --git a/src/generic/helpext.cpp b/src/generic/helpext.cpp index 27da957978..7a8135133d 100644 --- a/src/generic/helpext.cpp +++ b/src/generic/helpext.cpp @@ -18,9 +18,9 @@ #if wxUSE_HELP && !defined(__WXWINCE__) && (!defined(__WXMAC__) || defined(__WXMAC_OSX__)) #ifndef WX_PRECOMP + #include "wx/list.h" #include "wx/string.h" #include "wx/utils.h" - #include "wx/list.h" #include "wx/intl.h" #include "wx/msgdlg.h" #include "wx/choicdlg.h" @@ -73,16 +73,15 @@ IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase) and a file mapping numerical Section numbers to relative URLS. */ -wxExtHelpController::wxExtHelpController(wxWindow* parentWindow): - wxHelpControllerBase(parentWindow) +wxExtHelpController::wxExtHelpController(wxWindow* parentWindow) + : wxHelpControllerBase(parentWindow) { - m_MapList = (wxList*) NULL; + m_MapList = NULL; m_NumOfEntries = 0; - m_BrowserName = WXEXTHELP_DEFAULTBROWSER; - m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE; + m_BrowserIsNetscape = false; wxChar *browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSER); - if(browser) + if (browser) { m_BrowserName = browser; browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE); @@ -104,85 +103,34 @@ void wxExtHelpController::SetBrowser(const wxString& browsername, bool isNetscap // Set viewer: new, generic name for SetBrowser void wxExtHelpController::SetViewer(const wxString& viewer, long flags) { - SetBrowser(viewer, ((flags & wxHELP_NETSCAPE) == wxHELP_NETSCAPE)); + SetBrowser(viewer, (flags & wxHELP_NETSCAPE) != 0); } -bool -wxExtHelpController::DisplayHelp(const wxString &relativeURL) +bool wxExtHelpController::DisplayHelp(const wxString &relativeURL) { - wxBusyCursor b; // display a busy cursor - - -#if defined(__WXMSW__) - wxString url; - url << m_helpDir << '\\' << relativeURL.BeforeFirst('#'); - bool bOk = (int)ShellExecute(NULL, wxT("open"), url.c_str(), - NULL, NULL, SW_SHOWNORMAL ) > 32; - if ( !bOk ) - { - wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str()); - return false; - } + // construct hte URL to open -- it's just a file + wxString url(_T("file://") + m_helpDir); + url << wxFILE_SEP_PATH << relativeURL; - return true; -#elif defined(__OS2__) + // use the explicit browser program if specified + if ( !m_BrowserName.empty() ) + { + if ( m_BrowserIsNetscape ) + { + wxString command; + command << m_BrowserName + << wxT(" -remote openURL(") << url << wxT(')'); + if ( wxExecute(command, wxEXEC_SYNC) != -1 ) + return true; + } - wxString url; - url << m_helpDir << '\\' << relativeURL.BeforeFirst('#'); -// will have to fix for OS/2, later.....DW -// bool bOk = (int)ShellExecute(NULL, "open", url, -// NULL, NULL, SW_SHOWNORMAL ) > 32; -// if ( !bOk ) -// { -// wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str()); -// return false; -// } -// else - return true; - -#elif defined(__DOS__) - - wxString command; - command = m_BrowserName; - command << wxT(" file://") - << m_helpDir << wxFILE_SEP_PATH << relativeURL; - return wxExecute(command) != 0; - -#else // UNIX - wxString command; - -#ifndef __EMX__ - if(m_BrowserIsNetscape) // try re-loading first - { - wxString lockfile; - wxGetHomeDir(&lockfile); -#ifdef __VMS__ - lockfile << wxFILE_SEP_PATH << wxT(".netscape]lock."); - struct stat statbuf; - if(stat(lockfile.fn_str(), &statbuf) == 0) -#else - lockfile << wxFILE_SEP_PATH << wxT(".netscape/lock"); - struct stat statbuf; - if(lstat(lockfile.fn_str(), &statbuf) == 0) - // cannot use wxFileExists, because it's a link pointing to a - // non-existing location if(wxFileExists(lockfile)) -#endif - { - long success; - command << m_BrowserName << wxT(" -remote openURL(") - << wxT("file://") << m_helpDir - << wxFILE_SEP_PATH << relativeURL << wxT(")"); - success = wxExecute(command); - if(success != 0 ) // returns PID on success + if ( wxExecute(m_BrowserName + _T(' ') + url, wxEXEC_SYNC) != -1 ) return true; - } - } -#endif - command = m_BrowserName; - command << wxT(" file://") - << m_helpDir << wxFILE_SEP_PATH << relativeURL; - return wxExecute(command) != 0; -#endif + } + //else: either no browser explicitly specified or we failed to open it + + // just use default browser + return wxLaunchDefaultBrowser(url); } class wxExtHelpMapEntry : public wxObject @@ -197,7 +145,7 @@ public: void wxExtHelpController::DeleteList() { - if(m_MapList) + if (m_MapList) { wxList::compatibility_iterator node = m_MapList->GetFirst(); while (node) @@ -206,23 +154,20 @@ void wxExtHelpController::DeleteList() m_MapList->Erase(node); node = m_MapList->GetFirst(); } + delete m_MapList; m_MapList = (wxList*) NULL; } } -/** This must be called to tell the controller where to find the - documentation. - @param file - NOT a filename, but a directory name. - @return true on success -*/ -bool -wxExtHelpController::Initialize(const wxString& file) +// This must be called to tell the controller where to find the documentation. +// @param file - NOT a filename, but a directory name. +// @return true on success +bool wxExtHelpController::Initialize(const wxString& file) { return LoadFile(file); } - bool wxExtHelpController::ParseMapFileLine(const wxString& line) { const wxChar *p = line.c_str(); @@ -295,7 +240,7 @@ bool wxExtHelpController::LoadFile(const wxString& file) helpDirLoc.AppendDir(locName); dirExists = helpDirLoc.DirExists(); - if ( !dirExists ) + if ( ! dirExists ) { // try without encoding const wxString locNameWithoutEncoding = locName.BeforeLast(_T('.')); @@ -324,7 +269,7 @@ bool wxExtHelpController::LoadFile(const wxString& file) } #endif // wxUSE_INTL - if ( !dirExists && !helpDir.DirExists() ) + if ( ! dirExists && !helpDir.DirExists() ) { wxLogError(_("Help directory \"%s\" not found."), helpDir.GetFullPath().c_str()); @@ -332,7 +277,7 @@ bool wxExtHelpController::LoadFile(const wxString& file) } const wxFileName mapFile(helpDir.GetFullPath(), WXEXTHELP_MAPFILE); - if ( !mapFile.FileExists() ) + if ( ! mapFile.FileExists() ) { wxLogError(_("Help file \"%s\" not found."), mapFile.GetFullPath().c_str()); @@ -371,54 +316,54 @@ bool wxExtHelpController::LoadFile(const wxString& file) } -bool -wxExtHelpController::DisplayContents() +bool wxExtHelpController::DisplayContents() { - if(! m_NumOfEntries) + if (! m_NumOfEntries) return false; wxString contents; wxList::compatibility_iterator node = m_MapList->GetFirst(); wxExtHelpMapEntry *entry; - while(node) + while (node) { entry = (wxExtHelpMapEntry *)node->GetData(); - if(entry->id == CONTENTS_ID) + if (entry->id == CONTENTS_ID) { contents = entry->url; break; } + node = node->GetNext(); } bool rc = false; wxString file; file << m_helpDir << wxFILE_SEP_PATH << contents; - if(file.Contains(wxT('#'))) + if (file.Contains(wxT('#'))) file = file.BeforeLast(wxT('#')); - if(contents.length() && wxFileExists(file)) + if (contents.length() && wxFileExists(file)) rc = DisplaySection(CONTENTS_ID); // if not found, open homemade toc: return rc ? true : KeywordSearch(wxEmptyString); } -bool -wxExtHelpController::DisplaySection(int sectionNo) +bool wxExtHelpController::DisplaySection(int sectionNo) { - if(! m_NumOfEntries) + if (! m_NumOfEntries) return false; wxBusyCursor b; // display a busy cursor wxList::compatibility_iterator node = m_MapList->GetFirst(); wxExtHelpMapEntry *entry; - while(node) + while (node) { entry = (wxExtHelpMapEntry *)node->GetData(); - if(entry->id == sectionNo) + if (entry->id == sectionNo) return DisplayHelp(entry->url); node = node->GetNext(); } + return false; } @@ -432,74 +377,99 @@ bool wxExtHelpController::DisplaySection(const wxString& section) return KeywordSearch(section); } -bool -wxExtHelpController::DisplayBlock(long blockNo) +bool wxExtHelpController::DisplayBlock(long blockNo) { return DisplaySection((int)blockNo); } -bool -wxExtHelpController::KeywordSearch(const wxString& k, +bool wxExtHelpController::KeywordSearch(const wxString& k, wxHelpSearchMode WXUNUSED(mode)) { - if(! m_NumOfEntries) + if (! m_NumOfEntries) return false; - wxString *choices = new wxString[m_NumOfEntries]; - wxString *urls = new wxString[m_NumOfEntries]; - wxString compA, compB; + wxString *choices = new wxString[m_NumOfEntries]; + wxString *urls = new wxString[m_NumOfEntries]; - int idx = 0, j; - bool rc; + int idx = 0; + bool rc = false; bool showAll = k.empty(); + wxList::compatibility_iterator node = m_MapList->GetFirst(); - wxExtHelpMapEntry *entry; { - wxBusyCursor b; // display a busy cursor - compA = k; compA.LowerCase(); // we compare case insensitive - while(node) - { - entry = (wxExtHelpMapEntry *)node->GetData(); - compB = entry->doc; compB.LowerCase(); - if((showAll || compB.Contains(k)) && ! compB.empty()) - { - urls[idx] = entry->url; - // doesn't work: - // choices[idx] = (**i).doc.Contains((**i).doc.Before(WXEXTHELP_COMMENTCHAR)); - //if(choices[idx].empty()) // didn't contain the ';' - // choices[idx] = (**i).doc; - choices[idx] = wxEmptyString; - for(j=0;entry->doc.c_str()[j] - && entry->doc.c_str()[j] != WXEXTHELP_COMMENTCHAR; j++) - choices[idx] << entry->doc.c_str()[j]; - idx++; - } - node = node->GetNext(); - } - } + // display a busy cursor + wxBusyCursor b; + wxString compA, compB; + wxExtHelpMapEntry *entry; - if(idx == 1) - rc = DisplayHelp(urls[0]); - else if(idx == 0) - { - wxMessageBox(_("No entries found.")); - rc = false; - } - else - { - idx = wxGetSingleChoiceIndex(showAll ? _("Help Index") : _("Relevant entries:"), - showAll ? _("Help Index") : _("Entries found"), - idx,choices); - if(idx != -1) - rc = DisplayHelp(urls[idx]); - else - rc = false; - } - delete[] urls; - delete[] choices; + // we compare case insensitive + if (! showAll) + { + compA = k; + compA.LowerCase(); + } + + while (node) + { + entry = (wxExtHelpMapEntry *)node->GetData(); + compB = entry->doc; - return rc; + bool testTarget = ! compB.empty(); + if (testTarget && ! showAll) + { + compB.LowerCase(); + testTarget = compB.Contains(compA); + } + + if (testTarget) + { + urls[idx] = entry->url; + // doesn't work: + // choices[idx] = (**i).doc.Contains((**i).doc.Before(WXEXTHELP_COMMENTCHAR)); + //if (choices[idx].empty()) // didn't contain the ';' + // choices[idx] = (**i).doc; + choices[idx] = wxEmptyString; + for (int j=0; ; j++) + { + wxChar targetChar = entry->doc.c_str()[j]; + if ((targetChar == 0) || (targetChar == WXEXTHELP_COMMENTCHAR)) + break; + + choices[idx] << targetChar; + } + + idx++; + } + + node = node->GetNext(); + } + } + + switch (idx) + { + case 0: + wxMessageBox(_("No entries found.")); + break; + + case 1: + rc = DisplayHelp(urls[0]); + break; + + default: + idx = wxGetSingleChoiceIndex( + showAll ? _("Help Index") : _("Relevant entries:"), + showAll ? _("Help Index") : _("Entries found"), + idx, choices); + if (idx >= 0) + rc = DisplayHelp(urls[idx]); + break; + } + + delete [] urls; + delete [] choices; + + return rc; } @@ -512,5 +482,4 @@ void wxExtHelpController::OnQuit() { } - #endif // wxUSE_HELP