merging in the toolbar changes

[wxWidgets.git] / src / generic / helpext.cpp

diff --git a/src/generic/helpext.cpp b/src/generic/helpext.cpp
index a785361d421b481afcd2cae3ded002e5b77ec33c..abac8364523d8a942edaa905b5eb64763da25e2c 100644 (file)
--- a/src/generic/helpext.cpp
+++ b/src/generic/helpext.cpp
@@ -1,46 +1,47 @@
-/*-*- c++ -*-********************************************************
- * wxexthlp.cpp - an external help controller for wxWindows         *
- *                                                                  *
- * (C) 1998 by Karsten Ballüder (Ballueder@usa.net)                 *
- *                                                                  *
- * $Id$
- *******************************************************************/
+/////////////////////////////////////////////////////////////////////////////
+// Name:        helpext.cpp
+// Purpose:     an external help controller for wxWindows
+// Author:      Karsten Ballueder
+// Modified by:
+// Created:     04/01/98
+// RCS-ID:      $Id$
+// Copyright:   (c) Karsten Ballueder
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+

 #ifdef __GNUG__
 #   pragma implementation "wxexthlp.h"
 #endif
 
 #ifdef __GNUG__
 #   pragma implementation "wxexthlp.h"
 #endif
 

-#include   "wx/setup.h"
-#include   "wx/helpbase.h"
-#include   "wx/generic/helpext.h"
-#include   "wx/string.h"
-#include   "wx/utils.h"
-#include   "wx/list.h"
-#include   <stdio.h>
-#include   <ctype.h>
-#include   <sys/stat.h>
-#include   <unistd.h>
+#include "wx/wxprec.h"

 
 

+#ifdef __BORLANDC__
+    #pragma hdrstop
+#endif

 
 

+#if wxUSE_HELP

 
 

-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; }
-};
+#ifndef WX_PRECOMP
+    #include "wx/setup.h"
+    #include "wx/string.h"
+    #include "wx/utils.h"
+    #include "wx/list.h"
+    #include "wx/intl.h"
+#endif

 
 

+#include "wx/helpbase.h"
+#include "wx/generic/helpext.h"

 
 

-struct wxBusyCursor
-{
-   wxBusyCursor() { wxBeginBusyCursor(); }
-   ~wxBusyCursor() { wxEndBusyCursor(); }
-};
+#include <stdio.h>
+#include <ctype.h>
+#include <sys/stat.h>
+
+#if !defined(__WINDOWS__) && !defined(__OS2__)
+    #include   <unistd.h>
+#endif
+
+IMPLEMENT_CLASS(wxExtHelpController, wxHTMLHelpControllerBase)

 
 

-IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
-   

 /**
    This class implements help via an external browser.
    It requires the name of a directory containing the documentation
 /**
    This class implements help via an external browser.
    It requires the name of a directory containing the documentation


@@ -49,10 +50,8 @@ IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
 
 wxExtHelpController::wxExtHelpController(void)
 {
 
 wxExtHelpController::wxExtHelpController(void)
 {

-   m_MapList = NULL;

    m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
    m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
    m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
    m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;

-   m_NumOfEntries = 0;

 
    char *browser = getenv(WXEXTHELP_ENVVAR_BROWSER);
    if(browser)
 
    char *browser = getenv(WXEXTHELP_ENVVAR_BROWSER);
    if(browser)


@@ -63,27 +62,6 @@ wxExtHelpController::wxExtHelpController(void)
    }
 }
 
    }
 }
 

-void
-wxExtHelpController::DeleteList(void)
-{
-   if(m_MapList)
-   {
-      wxNode *node = m_MapList->First();
-      while (node)
-      {
-         delete (wxExtHelpMapEntry *)node->Data();
-         delete node;
-         node = m_MapList->First();
-      }
-      delete m_MapList;
-      m_MapList = NULL;
-   }
-}
-
-wxExtHelpController::~wxExtHelpController(void)
-{
-   DeleteList();
-}

 
 void
 wxExtHelpController::SetBrowser(wxString const & browsername, bool isNetscape)
 
 void
 wxExtHelpController::SetBrowser(wxString const & browsername, bool isNetscape)


@@ -92,223 +70,78 @@ wxExtHelpController::SetBrowser(wxString const & browsername, bool isNetscape)
    m_BrowserIsNetscape = isNetscape;
 }
 
    m_BrowserIsNetscape = isNetscape;
 }
 

-/** 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)
+// Set viewer: new, generic name for SetBrowser
+void wxExtHelpController::SetViewer(const wxString& viewer, long flags)

 {
 {

-   return LoadFile(file);
+    SetBrowser(viewer, ((flags & wxHELP_NETSCAPE) == wxHELP_NETSCAPE));

 }
 
 }
 

-  

 bool
 bool

-wxExtHelpController::LoadFile(const wxString& ifile)
+wxExtHelpController::DisplayHelp(wxString const &relativeURL)

 {
 {

-   wxString mapFile, file, url, doc;
-   int id,i,len;
-   char buffer[WXEXTHELP_BUFLEN];
-   

    wxBusyCursor b; // display a busy cursor
 
    wxBusyCursor b; // display a busy cursor
 

-   if(! ifile.IsEmpty())
-   {
-      file = ifile;
-      if(! wxIsAbsolutePath(file))
-      {
-         char* f = wxGetWorkingDirectory();
-         file = f;
-         delete[] f; // wxGetWorkingDirectory returns new memory
-         file << WXEXTHELP_SEPARATOR << ifile;
-      }
-      else
-         file = ifile;
-   
-      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 = fopen(mapFile.c_str(),"rt");
-   if(! input)
-      return false;
-   do
+#if defined(__WXMSW__)
+   wxString url;
+   url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
+   bool bOk = (int)ShellExecute(NULL, "open", url,
+                                NULL, NULL, SW_SHOWNORMAL ) > 32;
+   if ( !bOk )

    {
    {

-      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 = "";
-         while(buffer[i] && ! isspace(buffer[i]) && buffer[i] !=
-               WXEXTHELP_COMMENTCHAR)
-            url << buffer[i++];
-         while(buffer[i] && buffer[i] != WXEXTHELP_COMMENTCHAR)
-            i++;
-         doc = "";
-         if(buffer[i])
-            doc = (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;
-}
-
-bool
-wxExtHelpController::CallBrowser(wxString const &relativeURL)
-{
-   wxBusyCursor b; // display a busy cursor
+      wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
+      return false;
+   }
+   else
+      return true;
+#elif  defined(__WXPM__)
+   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;
+#else
+   // assume UNIX

    wxString command;
 
    if(m_BrowserIsNetscape) // try re-loading first
    {
       wxString lockfile;
       wxGetHomeDir(&lockfile);
    wxString command;
 
    if(m_BrowserIsNetscape) // try re-loading first
    {
       wxString lockfile;
       wxGetHomeDir(&lockfile);

-      lockfile << WXEXTHELP_SEPARATOR << ".netscape/lock";
+#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;
       struct stat statbuf;

-      if(lstat(lockfile.c_str(), &statbuf) == 0)
+      if(lstat(lockfile.fn_str(), &statbuf) == 0)

       // cannot use wxFileExists, because it's a link pointing to a
       // non-existing location      if(wxFileExists(lockfile))
       // cannot use wxFileExists, because it's a link pointing to a
       // non-existing location      if(wxFileExists(lockfile))

-      {
+#endif
+       {

          long success;
          long success;

-         command << m_BrowserName << " -remote openURL("
-                 << "file://" << m_MapFile
-                 << WXEXTHELP_SEPARATOR << relativeURL << ")"; 
+         command << m_BrowserName << wxT(" -remote openURL(")
+                 << wxT("file://") << m_MapFile
+                 << WXEXTHELP_SEPARATOR << relativeURL << wxT(")");

          success = wxExecute(command);
          if(success != 0 ) // returns PID on success
          success = wxExecute(command);
          if(success != 0 ) // returns PID on success

-            return true;
+            return TRUE;

       }
    }
    command = m_BrowserName;
       }
    }
    command = m_BrowserName;

-   command << " file://"
-           << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL; 
-   return wxExecute(command) != 0; 
-}
-
-bool
-wxExtHelpController::DisplayContents(void)
-{
-   if(! m_NumOfEntries)
-      return false;
-   wxBusyCursor b; // display a busy cursor
-   return KeywordSearch("");
-}
-      
-bool
-wxExtHelpController::DisplaySection(int sectionNo)
-{
-   if(! m_NumOfEntries)
-      return false;
-
-   wxBusyCursor b; // display a busy cursor
-   wxNode *node = m_MapList->First();
-   wxExtHelpMapEntry *entry;
-   while(node)
-   {
-      entry = (wxExtHelpMapEntry *)node->Data();
-      if(entry->id == sectionNo)
-         return CallBrowser(entry->url);
-      node = node->Next();
-   }
-   return false;
-}
-
-bool
-wxExtHelpController::DisplayBlock(long blockNo)
-{
-   return DisplaySection((int)blockNo);
-}
-
-bool
-wxExtHelpController::KeywordSearch(const wxString& k)
-{
-   if(! m_NumOfEntries)
-      return false;
-
-   wxBusyCursor b; // display a busy cursor
-   wxString     *choices = new wxString[m_NumOfEntries];
-   wxString     *urls = new wxString[m_NumOfEntries];
-   wxString compA, compB;
-   
-   int          idx = 0, j;
-   bool         rc;
-   bool         showAll = k.IsEmpty();
-   wxNode       *node = m_MapList->First();
-   wxExtHelpMapEntry *entry;
-   
-   compA = k; compA.LowerCase(); // we compare case insensitive
-   while(node)
-   {
-      entry = (wxExtHelpMapEntry *)node->Data();
-      compB = entry->doc; compB.LowerCase();
-      if((showAll || compB.Contains(k)) && ! compB.IsEmpty()) 
-      {
-         urls[idx] = entry->url;
-         // doesn't work:
-         // choices[idx] = (**i).doc.Contains((**i).doc.Before(WXEXTHELP_COMMENTCHAR));
-         //if(choices[idx].IsEmpty()) // didn't contain the ';'
-         //   choices[idx] = (**i).doc;
-         choices[idx] = "";
-         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->Next();
-   }
-
-   if(idx == 1)
-      rc = CallBrowser(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 = CallBrowser(urls[idx]);
-      else
-         rc = false;
-   }
-   delete[] urls;
-   delete[] choices;
-   
-   return rc;
-}
-
-
-bool
-wxExtHelpController::Quit(void)
-{
-   return true;
+   command << wxT(" file://")
+           << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
+   return wxExecute(command) != 0;
+#endif

 }
 
 }
 

-void
-wxExtHelpController::OnQuit(void)
-{
-}
+#endif // wxUSE_HELP