X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a85a25c7d87236d3bd43d045138b41001a88738b..07aaf32633ecf18ec3edfbb41793a112914792d0:/src/generic/helpext.cpp diff --git a/src/generic/helpext.cpp b/src/generic/helpext.cpp index 452af67289..d43331fbc6 100644 --- a/src/generic/helpext.cpp +++ b/src/generic/helpext.cpp @@ -15,12 +15,12 @@ #pragma hdrstop #endif -#if wxUSE_HELP && !defined(__WXWINCE__) && (!defined(__WXMAC__) || defined(__WXMAC_OSX__)) +#if wxUSE_HELP && !defined(__WXWINCE__) #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" @@ -52,65 +52,62 @@ // constants // ---------------------------------------------------------------------------- -/// Name for map file. -#define WXEXTHELP_MAPFILE _T("wxhelp.map") +// Name for map file. +#define WXEXTHELP_MAPFILE wxT("wxhelp.map") -/// Character introducing comments/documentation field in map file. -#define WXEXTHELP_COMMENTCHAR ';' +// Character introducing comments/documentation field in map file. +#define WXEXTHELP_COMMENTCHAR ';' -#define CONTENTS_ID 0 +// The ID of the Contents section +#define WXEXTHELP_CONTENTS_ID 0 -IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase) +// Name of environment variable to set help browser. +#define WXEXTHELP_ENVVAR_BROWSER wxT("WX_HELPBROWSER") -/// Name of environment variable to set help browser. -#define WXEXTHELP_ENVVAR_BROWSER wxT("WX_HELPBROWSER") -/// Is browser a netscape browser? -#define WXEXTHELP_ENVVAR_BROWSERISNETSCAPE wxT("WX_HELPBROWSER_NS") +// Is browser a netscape browser? +#define WXEXTHELP_ENVVAR_BROWSERISNETSCAPE wxT("WX_HELPBROWSER_NS") -/** - This class implements help via an external browser. - It requires the name of a directory containing the documentation - and a file mapping numerical Section numbers to relative URLS. -*/ +IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase) wxExtHelpController::wxExtHelpController(wxWindow* parentWindow) : wxHelpControllerBase(parentWindow) { - m_MapList = NULL; - m_NumOfEntries = 0; - m_BrowserIsNetscape = false; + m_MapList = NULL; + m_NumOfEntries = 0; + m_BrowserIsNetscape = false; - wxChar *browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSER); - if(browser) - { - m_BrowserName = browser; - browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE); - m_BrowserIsNetscape = browser && (wxAtoi(browser) != 0); - } + wxChar *browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSER); + if (browser) + { + m_BrowserName = browser; + browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE); + m_BrowserIsNetscape = browser && (wxAtoi(browser) != 0); + } } wxExtHelpController::~wxExtHelpController() { - DeleteList(); + DeleteList(); } +#if WXWIN_COMPATIBILITY_2_8 void wxExtHelpController::SetBrowser(const wxString& browsername, bool isNetscape) { - m_BrowserName = browsername; - m_BrowserIsNetscape = isNetscape; + m_BrowserName = browsername; + m_BrowserIsNetscape = isNetscape; } +#endif -// Set viewer: new, generic name for SetBrowser void wxExtHelpController::SetViewer(const wxString& viewer, long flags) { - SetBrowser(viewer, (flags & wxHELP_NETSCAPE) != 0); + m_BrowserName = viewer; + m_BrowserIsNetscape = (flags & wxHELP_NETSCAPE) != 0; } -bool -wxExtHelpController::DisplayHelp(const wxString &relativeURL) +bool wxExtHelpController::DisplayHelp(const wxString &relativeURL) { // construct hte URL to open -- it's just a file - wxString url(_T("file://") + m_helpDir); + wxString url(wxT("file://") + m_helpDir); url << wxFILE_SEP_PATH << relativeURL; // use the explicit browser program if specified @@ -125,7 +122,7 @@ wxExtHelpController::DisplayHelp(const wxString &relativeURL) return true; } - if ( wxExecute(m_BrowserName + _T(' ') + url, wxEXEC_SYNC) != -1 ) + if ( wxExecute(m_BrowserName + wxT(' ') + url, wxEXEC_SYNC) != -1 ) return true; } //else: either no browser explicitly specified or we failed to open it @@ -137,51 +134,48 @@ wxExtHelpController::DisplayHelp(const wxString &relativeURL) class wxExtHelpMapEntry : public wxObject { public: - int id; - wxString url; - wxString doc; - wxExtHelpMapEntry(int iid, wxString const &iurl, wxString const &idoc) - { id = iid; url = iurl; doc = idoc; } + int entryid; + wxString url; + wxString doc; + + wxExtHelpMapEntry(int iid, wxString const &iurl, wxString const &idoc) + { entryid = iid; url = iurl; doc = idoc; } }; void wxExtHelpController::DeleteList() { - if(m_MapList) - { - wxList::compatibility_iterator node = m_MapList->GetFirst(); - while (node) - { - delete (wxExtHelpMapEntry *)node->GetData(); - m_MapList->Erase(node); - node = m_MapList->GetFirst(); - } - delete m_MapList; - m_MapList = (wxList*) NULL; - } + if (m_MapList) + { + wxList::compatibility_iterator node = m_MapList->GetFirst(); + while (node) + { + delete (wxExtHelpMapEntry *)node->GetData(); + m_MapList->Erase(node); + node = m_MapList->GetFirst(); + } + + wxDELETE(m_MapList); + } } -/** 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); + return LoadFile(file); } - bool wxExtHelpController::ParseMapFileLine(const wxString& line) { const wxChar *p = line.c_str(); // skip whitespace - while ( isascii(*p) && isspace(*p) ) + while ( isascii(*p) && wxIsspace(*p) ) p++; // skip empty lines and comments - if ( *p == _T('\0') || *p == WXEXTHELP_COMMENTCHAR ) + if ( *p == wxT('\0') || *p == WXEXTHELP_COMMENTCHAR ) return true; // the line is of the form "num url" so we must have an integer now @@ -192,16 +186,16 @@ bool wxExtHelpController::ParseMapFileLine(const wxString& line) return false; p = end; - while ( isascii(*p) && isspace(*p) ) + while ( isascii(*p) && wxIsspace(*p) ) p++; // next should be the URL wxString url; url.reserve(line.length()); - while ( isascii(*p) && !isspace(*p) ) + while ( isascii(*p) && !wxIsspace(*p) ) url += *p++; - while ( isascii(*p) && isspace(*p) ) + while ( isascii(*p) && wxIsspace(*p) ) p++; // and finally the optional description of the entry after comment @@ -209,7 +203,7 @@ bool wxExtHelpController::ParseMapFileLine(const wxString& line) if ( *p == WXEXTHELP_COMMENTCHAR ) { p++; - while ( isascii(*p) && isspace(*p) ) + while ( isascii(*p) && wxIsspace(*p) ) p++; doc = p; } @@ -244,10 +238,10 @@ 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('.')); + const wxString locNameWithoutEncoding = locName.BeforeLast(wxT('.')); if ( !locNameWithoutEncoding.empty() ) { helpDirLoc = helpDir; @@ -259,7 +253,7 @@ bool wxExtHelpController::LoadFile(const wxString& file) if ( !dirExists ) { // try without country part - wxString locNameWithoutCountry = locName.BeforeLast(_T('_')); + wxString locNameWithoutCountry = locName.BeforeLast(wxT('_')); if ( !locNameWithoutCountry.empty() ) { helpDirLoc = helpDir; @@ -273,7 +267,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()); @@ -281,7 +275,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()); @@ -320,55 +314,55 @@ bool wxExtHelpController::LoadFile(const wxString& file) } -bool -wxExtHelpController::DisplayContents() +bool wxExtHelpController::DisplayContents() { - if(! m_NumOfEntries) - return false; + if (! m_NumOfEntries) + return false; - wxString contents; - wxList::compatibility_iterator node = m_MapList->GetFirst(); - wxExtHelpMapEntry *entry; - while(node) - { - entry = (wxExtHelpMapEntry *)node->GetData(); - 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('#'))) - file = file.BeforeLast(wxT('#')); - if(contents.length() && wxFileExists(file)) - rc = DisplaySection(CONTENTS_ID); - - // if not found, open homemade toc: - return rc ? true : KeywordSearch(wxEmptyString); + wxString contents; + wxList::compatibility_iterator node = m_MapList->GetFirst(); + wxExtHelpMapEntry *entry; + while (node) + { + entry = (wxExtHelpMapEntry *)node->GetData(); + if (entry->entryid == WXEXTHELP_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('#'))) + file = file.BeforeLast(wxT('#')); + if ( wxFileExists(file) ) + rc = DisplaySection(WXEXTHELP_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) - return false; + if (! m_NumOfEntries) + return false; - wxBusyCursor b; // display a busy cursor - wxList::compatibility_iterator node = m_MapList->GetFirst(); - wxExtHelpMapEntry *entry; - while(node) - { - entry = (wxExtHelpMapEntry *)node->GetData(); - if(entry->id == sectionNo) - return DisplayHelp(entry->url); - node = node->GetNext(); - } - return false; + wxBusyCursor b; // display a busy cursor + wxList::compatibility_iterator node = m_MapList->GetFirst(); + wxExtHelpMapEntry *entry; + while (node) + { + entry = (wxExtHelpMapEntry *)node->GetData(); + if (entry->entryid == sectionNo) + return DisplayHelp(entry->url); + node = node->GetNext(); + } + + return false; } bool wxExtHelpController::DisplaySection(const wxString& section) @@ -381,74 +375,104 @@ bool wxExtHelpController::DisplaySection(const wxString& section) return KeywordSearch(section); } -bool -wxExtHelpController::DisplayBlock(long blockNo) +bool wxExtHelpController::DisplayBlock(long blockNo) { - return DisplaySection((int)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(); - } - } - - 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; - - return rc; + // display a busy cursor + wxBusyCursor b; + wxString compA, compB; + wxExtHelpMapEntry *entry; + + // we compare case insensitive + if (! showAll) + { + compA = k; + compA.LowerCase(); + } + + while (node) + { + entry = (wxExtHelpMapEntry *)node->GetData(); + compB = entry->doc; + + 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: + if (showAll) + idx = wxGetSingleChoiceIndex(_("Help Index"), + _("Help Index"), + idx, choices); + else + idx = wxGetSingleChoiceIndex(_("Relevant entries:"), + _("Entries found"), + idx, choices); + + if (idx >= 0) + rc = DisplayHelp(urls[idx]); + break; + } + + delete [] urls; + delete [] choices; + + return rc; } @@ -461,5 +485,4 @@ void wxExtHelpController::OnQuit() { } - #endif // wxUSE_HELP