X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9b5f1895643cf94b38ac19a4c1151e259310852e..f1f5f16f780bb41aa2ea24ccbf728f14c86cc475:/src/generic/helpext.cpp?ds=inline

diff --git a/src/generic/helpext.cpp b/src/generic/helpext.cpp
index 1bf7d2b43d..7a8135133d 100644
--- a/src/generic/helpext.cpp
+++ b/src/generic/helpext.cpp
@@ -18,16 +18,17 @@
 #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"
     #include "wx/log.h"
 #endif
 
-#include "wx/helpbase.h"
+#include "wx/filename.h"
+#include "wx/textfile.h"
 #include "wx/generic/helpext.h"
 
 #include <stdio.h>
@@ -53,8 +54,7 @@
 
 /// Name for map file.
 #define WXEXTHELP_MAPFILE   _T("wxhelp.map")
-/// Maximum line length in map file.
-#define WXEXTHELP_BUFLEN 512
+
 /// Character introducing comments/documentation field in map file.
 #define WXEXTHELP_COMMENTCHAR   ';'
 
@@ -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_MapFile << '\\' << 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;
-   }
-
-   return true;
-#elif  defined(__OS2__)
-
-   wxString url;
-   url << m_MapFile << '\\' << 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_MapFile << WXEXTHELP_SEPARATOR << 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 << WXEXTHELP_SEPARATOR << wxT(".netscape]lock.");
-      struct stat statbuf;
-      if(stat(lockfile.fn_str(), &statbuf) == 0)
-#else
-      lockfile << WXEXTHELP_SEPARATOR << 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_MapFile
-                 << WXEXTHELP_SEPARATOR << relativeURL << wxT(")");
-         success = wxExecute(command);
-         if(success != 0 ) // returns PID on success
+    // construct hte URL to open -- it's just a file
+    wxString url(_T("file://") + m_helpDir);
+    url << wxFILE_SEP_PATH << relativeURL;
+
+    // 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;
+        }
+
+        if ( wxExecute(m_BrowserName + _T(' ') + url, wxEXEC_SYNC) != -1 )
             return true;
-      }
-   }
-#endif
-   command = m_BrowserName;
-   command << wxT(" file://")
-           << m_MapFile << WXEXTHELP_SEPARATOR << 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,168 +154,216 @@ 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);
 }
 
-
-// ifile is the name of the base help directory
-bool wxExtHelpController::LoadFile(const wxString& ifile)
+bool wxExtHelpController::ParseMapFileLine(const wxString& line)
 {
-   wxString mapFile, file, url, doc;
-   int id,i,len;
-   char buffer[WXEXTHELP_BUFLEN];
+    const wxChar *p = line.c_str();
+
+    // skip whitespace
+    while ( isascii(*p) && isspace(*p) )
+        p++;
+
+    // skip empty lines and comments
+    if ( *p == _T('\0') || *p == WXEXTHELP_COMMENTCHAR )
+        return true;
+
+    // the line is of the form "num url" so we must have an integer now
+    wxChar *end;
+    const unsigned long id = wxStrtoul(p, &end, 0);
+
+    if ( end == p )
+        return false;
+
+    p = end;
+    while ( isascii(*p) && isspace(*p) )
+        p++;
+
+    // next should be the URL
+    wxString url;
+    url.reserve(line.length());
+    while ( isascii(*p) && !isspace(*p) )
+        url += *p++;
+
+    while ( isascii(*p) && isspace(*p) )
+        p++;
+
+    // and finally the optional description of the entry after comment
+    wxString doc;
+    if ( *p == WXEXTHELP_COMMENTCHAR )
+    {
+        p++;
+        while ( isascii(*p) && isspace(*p) )
+            p++;
+        doc = p;
+    }
+
+    m_MapList->Append(new wxExtHelpMapEntry(id, url, doc));
+    m_NumOfEntries++;
+
+    return true;
+}
 
-   wxBusyCursor b; // display a busy cursor
+// file is a misnomer as it's the name of the base help directory
+bool wxExtHelpController::LoadFile(const wxString& file)
+{
+    wxFileName helpDir(wxFileName::DirName(file));
+    helpDir.MakeAbsolute();
 
-   if(! ifile.empty())
-   {
-      file = ifile;
-      if(! wxIsAbsolutePath(file))
-      {
-         file = wxGetCwd();
-#ifdef __WXMAC__
-         file << ifile;
-#else
-         file << WXEXTHELP_SEPARATOR << ifile;
-#endif
-      }
-      else
-         file = ifile;
+    bool dirExists = false;
 
 #if wxUSE_INTL
-      // If a locale is set, look in file/localename, i.e.
-      // If passed "/usr/local/myapp/help" and the current wxLocale is
-      // set to be "de", then look in "/usr/local/myapp/help/de/"
-      // first and fall back to "/usr/local/myapp/help" if that
-      // doesn't exist.
-      if(wxGetLocale() && !wxGetLocale()->GetName().empty())
-      {
-         wxString newfile;
-         newfile << WXEXTHELP_SEPARATOR << wxGetLocale()->GetName();
-         if(wxDirExists(newfile))
-            file = newfile;
-         else
-         {
-            newfile = WXEXTHELP_SEPARATOR;
-            const wxChar *cptr = wxGetLocale()->GetName().c_str();
-            while(*cptr && *cptr != wxT('_'))
-               newfile << *(cptr++);
-            if(wxDirExists(newfile))
-               file = newfile;
-         }
-      }
-#endif
-
-      if(! wxDirExists(file))
-         return false;
-
-      mapFile << file << WXEXTHELP_SEPARATOR << WXEXTHELP_MAPFILE;
-   }
-   else // try to reload old file
-      mapFile = m_MapFile;
-
-   if(! wxFileExists(mapFile))
-      return false;
-
-   DeleteList();
-   m_MapList = new wxList;
-   m_NumOfEntries = 0;
-
-   FILE *input = wxFopen(mapFile,wxT("rt"));
-   if(! input)
-      return false;
-   do
-   {
-      if(fgets(buffer,WXEXTHELP_BUFLEN,input) && *buffer != WXEXTHELP_COMMENTCHAR)
-      {
-         len = strlen(buffer);
-         if(buffer[len-1] == '\n')
-            buffer[len-1] = '\0'; // cut of trailing newline
-         if(sscanf(buffer,"%d", &id) != 1)
-            break; // error
-         for(i=0; isdigit(buffer[i])||isspace(buffer[i])||buffer[i]=='-'; i++)
-            ; // find begin of URL
-         url = wxEmptyString;
-         while(buffer[i] && ! isspace(buffer[i]) && buffer[i] !=
-               WXEXTHELP_COMMENTCHAR)
-            url << (wxChar) buffer[i++];
-         while(buffer[i] && buffer[i] != WXEXTHELP_COMMENTCHAR)
-            i++;
-         doc = wxEmptyString;
-         if(buffer[i])
-            doc = wxString::FromAscii( (buffer + i + 1) ); // skip the comment character
-         m_MapList->Append(new wxExtHelpMapEntry(id,url,doc));
-         m_NumOfEntries++;
-      }
-   }while(! feof(input));
-   fclose(input);
-
-   m_MapFile = file; // now it's valid
-   return true;
+    // If a locale is set, look in file/localename, i.e. If passed
+    // "/usr/local/myapp/help" and the current wxLocale is set to be "de", then
+    // look in "/usr/local/myapp/help/de/" first and fall back to
+    // "/usr/local/myapp/help" if that doesn't exist.
+    const wxLocale * const loc = wxGetLocale();
+    if ( loc )
+    {
+        wxString locName = loc->GetName();
+
+        // the locale is in general of the form xx_YY.zzzz, try the full firm
+        // first and then also more general ones
+        wxFileName helpDirLoc(helpDir);
+        helpDirLoc.AppendDir(locName);
+        dirExists = helpDirLoc.DirExists();
+
+        if ( ! dirExists )
+        {
+            // try without encoding
+            const wxString locNameWithoutEncoding = locName.BeforeLast(_T('.'));
+            if ( !locNameWithoutEncoding.empty() )
+            {
+                helpDirLoc = helpDir;
+                helpDirLoc.AppendDir(locNameWithoutEncoding);
+                dirExists = helpDirLoc.DirExists();
+            }
+        }
+
+        if ( !dirExists )
+        {
+            // try without country part
+            wxString locNameWithoutCountry = locName.BeforeLast(_T('_'));
+            if ( !locNameWithoutCountry.empty() )
+            {
+                helpDirLoc = helpDir;
+                helpDirLoc.AppendDir(locNameWithoutCountry);
+                dirExists = helpDirLoc.DirExists();
+            }
+        }
+
+        if ( dirExists )
+            helpDir = helpDirLoc;
+    }
+#endif // wxUSE_INTL
+
+    if ( ! dirExists && !helpDir.DirExists() )
+    {
+        wxLogError(_("Help directory \"%s\" not found."),
+                   helpDir.GetFullPath().c_str());
+        return false;
+    }
+
+    const wxFileName mapFile(helpDir.GetFullPath(), WXEXTHELP_MAPFILE);
+    if ( ! mapFile.FileExists() )
+    {
+        wxLogError(_("Help file \"%s\" not found."),
+                   mapFile.GetFullPath().c_str());
+        return false;
+    }
+
+    DeleteList();
+    m_MapList = new wxList;
+    m_NumOfEntries = 0;
+
+    wxTextFile input;
+    if ( !input.Open(mapFile.GetFullPath()) )
+        return false;
+
+    for ( wxString& line = input.GetFirstLine();
+          !input.Eof();
+          line = input.GetNextLine() )
+    {
+        if ( !ParseMapFileLine(line) )
+        {
+            wxLogWarning(_("Line %lu of map file \"%s\" has invalid syntax, skipped."),
+                         (unsigned long)input.GetCurrentLine(),
+                         mapFile.GetFullPath().c_str());
+        }
+    }
+
+    if ( !m_NumOfEntries )
+    {
+        wxLogError(_("No valid mappings found in the file \"%s\"."),
+                   mapFile.GetFullPath().c_str());
+        return false;
+    }
+
+    m_helpDir = helpDir.GetFullPath(); // now it's valid
+    return true;
 }
 
 
-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_MapFile << WXEXTHELP_SEPARATOR << contents;
-   if(file.Contains(wxT('#')))
+   file << m_helpDir << wxFILE_SEP_PATH << contents;
+   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;
 }
 
@@ -381,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();
-      }
-   }
+   wxList::compatibility_iterator node = m_MapList->GetFirst();
 
-   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:
+        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;
 }
 
 
@@ -461,5 +482,4 @@ void wxExtHelpController::OnQuit()
 {
 }
 
-
 #endif // wxUSE_HELP