-/*-*- 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
-#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
+#ifndef WX_PRECOMP
+ #include "wx/setup.h"
+ #include "wx/string.h"
+ #include "wx/utils.h"
+ #include "wx/list.h"
+ #include "wx/intl.h"
+#endif
-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; }
-};
+#include "wx/helpbase.h"
+#include "wx/generic/helpext.h"
+#include <stdio.h>
+#include <ctype.h>
+#include <sys/stat.h>
-struct wxBusyCursor
-{
- wxBusyCursor() { wxBeginBusyCursor(); }
- ~wxBusyCursor() { wxEndBusyCursor(); }
-};
+#ifndef __WINDOWS__
+ #include <unistd.h>
+#endif
-IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
+IMPLEMENT_CLASS(wxExtHelpController, wxHTMLHelpControllerBase)
/**
This class implements help via an external browser.
wxExtHelpController::wxExtHelpController(void)
{
- m_MapList = NULL;
m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
}
}
-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)
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
-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
- if(! ifile.IsEmpty())
- {
- file = ifile;
- if(! wxIsAbsolutePath(file))
- {
- file = wxGetWorkingDirectory();
- 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
+#ifdef __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]); 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++;
- }
- else
- perror("");
- }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;
+#else
+ // assume UNIX
wxString command;
if(m_BrowserIsNetscape) // try re-loading first
{
wxString lockfile;
wxGetHomeDir(&lockfile);
- lockfile << WXEXTHELP_SEPARATOR << ".netscape/lock";
+ lockfile << WXEXTHELP_SEPARATOR << _T(".netscape/lock");
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))
{
long success;
- command << m_BrowserName << " -remote openURL("
- << "file://" << m_MapFile
- << WXEXTHELP_SEPARATOR << relativeURL << ")";
+ command << m_BrowserName << _T(" -remote openURL(")
+ << _T("file://") << m_MapFile
+ << WXEXTHELP_SEPARATOR << relativeURL << _T(")");
success = wxExecute(command);
if(success != 0 ) // returns PID on success
- return true;
+ return TRUE;
}
}
command = m_BrowserName;
- command << " file://"
+ command << _T(" file://")
<< m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
return wxExecute(command) != 0;
+#endif
}
-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;
-}
-
-void
-wxExtHelpController::OnQuit(void)
-{
-}
projects / wxWidgets.git / blobdiff