# pragma interface "wxexthlp.h"
#endif
-#include "wx/helpbase.h"
+#include "wx/generic/helphtml.h"
-/// Name for map file.
-#define WXEXTHELP_MAPFILE "wxhelp.map"
-/// Path separator.
-#define WXEXTHELP_SEPARATOR '/'
#ifndef WXEXTHELP_DEFAULTBROWSER
/// Default browser name.
# define WXEXTHELP_DEFAULTBROWSER "netscape"
#define WXEXTHELP_ENVVAR_BROWSER "WX_HELPBROWSER"
/// Is browser a netscape browser?
#define WXEXTHELP_ENVVAR_BROWSERISNETSCAPE "WX_HELPBROWSER_NS"
-/// Maximum line length in map file.
-#define WXEXTHELP_BUFLEN 512
-/// Character introducing comments/documentation field in map file.
-#define WXEXTHELP_COMMENTCHAR ';'
-
-class wxExtHelpMapList;
/**
Lines starting with ';' will be ignored.
*/
-class wxExtHelpController : public wxHelpControllerBase
+class wxExtHelpController : public wxHTMLHelpControllerBase
{
DECLARE_CLASS(wxExtHelpController)
public:
wxExtHelpController(void);
- virtual ~wxExtHelpController(void);
-
- /** 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
- */
- virtual bool Initialize(const wxString& file, int WXUNUSED(server))
- { return Initialize(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
- */
- virtual bool Initialize(const wxString& file);
-
- /** If file is "", reloads file given in Initialize.
- @file Name of help directory.
- @return true on success
- */
- virtual bool LoadFile(const wxString& file = "");
-
- /** Display list of all help entries.
- @return true on success
- */
- virtual bool DisplayContents(void);
- /** Display help for id sectionNo.
- @return true on success
- */
- virtual bool DisplaySection(int sectionNo);
- /** Display help for id sectionNo -- identical with DisplaySection().
- @return true on success
- */
- virtual bool DisplayBlock(long blockNo);
- /** Search comment/documentation fields in map file and present a
- list to chose from.
- @key k string to search for, empty string will list all entries
- @return true on success
- */
- virtual bool KeywordSearch(const wxString& k);
-
- /// does nothing
- virtual bool Quit(void);
- /// does nothing
- virtual void OnQuit(void);
/** Tell it which browser to use.
The Netscape support will check whether Netscape is already
void SetBrowser(wxString const & browsername = WXEXTHELP_DEFAULTBROWSER,
bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
private:
- /// Filename of currently active map file.
- wxString m_MapFile;
- /// How many entries do we have in the map file?
- int m_NumOfEntries;
- /// A list containing all id,url,documentation triples.
- wxList *m_MapList;
/// How to call the html viewer.
wxString m_BrowserName;
/// Is the viewer a variant of netscape?
bool m_BrowserIsNetscape;
/// Call the browser using a relative URL.
- bool CallBrowser(wxString const &);
- /// Deletes the list and all objects.
- void DeleteList(void);
+ bool DisplayHelp(wxString const &);
};
#endif
--- /dev/null
+/*-*- c++ -*-********************************************************
+ * helphtml.h - base class for html based help controllers *
+ * *
+ * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
+ * *
+ * $Id$
+ *******************************************************************/
+#ifndef WXXHELPHTML_H
+#define WXXHELPHTML_H
+
+#if wxUSE_HELP
+
+#ifdef __GNUG__
+# pragma interface "helphtml.h"
+#endif
+
+#include "wx/helpbase.h"
+
+/// Name for map file.
+#define WXEXTHELP_MAPFILE "wxhelp.map"
+/// Path separator.
+#define WXEXTHELP_SEPARATOR '/'
+/// Maximum line length in map file.
+#define WXEXTHELP_BUFLEN 512
+/// Character introducing comments/documentation field in map file.
+#define WXEXTHELP_COMMENTCHAR ';'
+
+class wxExtHelpMapList;
+
+
+/**
+ This class is the base class for all html help implementations.
+ It requires the name of a directory containing the documentation
+ and a file mapping numerical Section numbers to relative URLS.
+
+ The map file contains two or three fields per line:
+ numeric_id relative_URL [; comment/documentation]
+
+ The numeric_id is the id used to look up the entry in
+ DisplaySection()/DisplayBlock(). The relative_URL is a filename of
+ an html file, relative to the help directory. The optional
+ comment/documentation field (after a ';') is used for keyword
+ searches, so some meaningful text here does not hurt.
+ If the documentation itself contains a ';', only the part before
+ that will be displayed in the listbox, but all of it used for search.
+
+ Lines starting with ';' will be ignored.
+*/
+
+class wxHTMLHelpControllerBase : public wxHelpControllerBase
+{
+DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase)
+ public:
+ wxHTMLHelpControllerBase(void);
+ virtual ~wxHTMLHelpControllerBase(void);
+
+ /** This must be called to tell the controller where to find the
+ documentation.
+ 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.
+
+ @param file - NOT a filename, but a directory name.
+ @return true on success
+ */
+ virtual bool Initialize(const wxString& dir, int WXUNUSED(server))
+ { return Initialize(dir); }
+
+ /** This must be called to tell the controller where to find the
+ documentation.
+ 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.
+ @param dir - directory name where to fine the help files
+ @return true on success
+ */
+ virtual bool Initialize(const wxString& dir);
+
+ /** If file is "", reloads file given in Initialize.
+ @file Name of help directory.
+ @return true on success
+ */
+ virtual bool LoadFile(const wxString& file = "");
+
+ /** Display list of all help entries.
+ @return true on success
+ */
+ virtual bool DisplayContents(void);
+ /** Display help for id sectionNo.
+ @return true on success
+ */
+ virtual bool DisplaySection(int sectionNo);
+ /** Display help for id sectionNo -- identical with DisplaySection().
+ @return true on success
+ */
+ virtual bool DisplayBlock(long blockNo);
+ /** Search comment/documentation fields in map file and present a
+ list to chose from.
+ @key k string to search for, empty string will list all entries
+ @return true on success
+ */
+ virtual bool KeywordSearch(const wxString& k);
+
+ /// does nothing
+ virtual bool Quit(void);
+ /// does nothing
+ virtual void OnQuit(void);
+
+ /// Call the browser using a relative URL.
+ virtual bool DisplayHelp(wxString const &) = 0;
+
+ protected:
+ /// Filename of currently active map file.
+ wxString m_MapFile;
+ /// How many entries do we have in the map file?
+ int m_NumOfEntries;
+ /// A list containing all id,url,documentation triples.
+ wxList *m_MapList;
+ /// Deletes the list and all objects.
+ void DeleteList(void);
+};
+
+#endif
+#endif
const char *GetString(const char *szOrigString,
const char *szDomain = (const char *) NULL) const;
-private:
+ // Returns the current short name for the locale
+ wxString const &GetName() const { return m_strShort; }
+ private:
// find catalog by name in a linked list, return NULL if !found
wxMsgCatalog *FindCatalog(const char *szDomain) const;
/*-*- c++ -*-********************************************************
- * wxexthlp.cpp - an external help controller for wxWindows *
+ * helpext.cpp - an external help controller for wxWindows *
* *
- * (C) 1998 by Karsten Ballüder (Ballueder@usa.net) *
+ * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
* *
* $Id$
*******************************************************************/
#include <unistd.h>
-
-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; }
-};
-
-
struct wxBusyCursor
{
wxBusyCursor() { wxBeginBusyCursor(); }
~wxBusyCursor() { wxEndBusyCursor(); }
};
-IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
+IMPLEMENT_CLASS(wxExtHelpController, wxHTMLHelpControllerBase)
/**
This class implements help via an external browser.
wxExtHelpController::wxExtHelpController(void)
{
- m_MapList = (wxList*) NULL;
m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
- m_NumOfEntries = 0;
char *browser = getenv(WXEXTHELP_ENVVAR_BROWSER);
if(browser)
}
}
-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 = (wxList*) 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)
-{
- return LoadFile(file);
-}
-
-
bool
-wxExtHelpController::LoadFile(const wxString& ifile)
-{
- 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))
- {
- 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(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)
+wxExtHelpController::DisplayHelp(wxString const &relativeURL)
{
wxBusyCursor b; // display a busy cursor
wxString command;
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;
-}
-
-void
-wxExtHelpController::OnQuit(void)
-{
-}
--- /dev/null
+/*-*- c++ -*-********************************************************
+ * helphtml.cpp - base class for html help systems *
+ * *
+ * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
+ * *
+ * $Id$
+ *******************************************************************/
+#ifdef __GNUG__
+# pragma implementation "helphtml.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 "wx/intl.h"
+#include <stdio.h>
+#include <ctype.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+
+
+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; }
+};
+
+
+struct wxBusyCursor
+{
+ wxBusyCursor() { wxBeginBusyCursor(); }
+ ~wxBusyCursor() { wxEndBusyCursor(); }
+};
+
+IMPLEMENT_ABSTRACT_CLASS(wxHTMLHelpControllerBase, wxHelpControllerBase)
+
+/**
+ 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.
+*/
+
+wxHTMLHelpControllerBase::wxHTMLHelpControllerBase(void)
+{
+ m_MapList = (wxList*) NULL;
+ m_NumOfEntries = 0;
+}
+
+void
+wxHTMLHelpControllerBase::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 = (wxList*) NULL;
+ }
+}
+
+wxHTMLHelpControllerBase::~wxHTMLHelpControllerBase(void)
+{
+ DeleteList();
+}
+
+/** 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
+wxHTMLHelpControllerBase::Initialize(const wxString& file)
+{
+ return LoadFile(file);
+}
+
+
+// ifile is the name of the base help directory
+bool
+wxHTMLHelpControllerBase::LoadFile(const wxString& ifile)
+{
+ 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))
+ {
+ char* f = wxGetWorkingDirectory();
+ file = f;
+ delete[] f; // wxGetWorkingDirectory returns new memory
+ file << WXEXTHELP_SEPARATOR << ifile;
+ }
+ else
+ file = ifile;
+
+ // 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().IsEmpty())
+ {
+ wxString newfile;
+ newfile << WXEXTHELP_SEPARATOR << wxGetLocale()->GetName();
+ if(wxDirExists(newfile))
+ file = newfile;
+ }
+
+ 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(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
+wxHTMLHelpControllerBase::DisplayContents(void)
+{
+ if(! m_NumOfEntries)
+ return FALSE;
+ wxBusyCursor b; // display a busy cursor
+ return KeywordSearch("");
+}
+
+bool
+wxHTMLHelpControllerBase::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 DisplayHelp(entry->url);
+ node = node->Next();
+ }
+ return FALSE;
+}
+
+bool
+wxHTMLHelpControllerBase::DisplayBlock(long blockNo)
+{
+ return DisplaySection((int)blockNo);
+}
+
+bool
+wxHTMLHelpControllerBase::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 = 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;
+}
+
+
+bool
+wxHTMLHelpControllerBase::Quit(void)
+{
+ return TRUE;
+}
+
+void
+wxHTMLHelpControllerBase::OnQuit(void)
+{
+}
+
generic/tabg.cpp \
generic/textdlgg.cpp \
generic/treectrl.cpp \
- generic/helpext.cpp
+ generic/helpext.cpp \
+ generic/helphtml.cpp
LIB_C_SRC=\
common/extended.c \
generic/fontdlgg.cpp \
generic/gridg.cpp \
generic/helpext.cpp \
+ generic/helphtml.cpp \
generic/imaglist.cpp \
generic/listctrl.cpp \
generic/laywin.cpp \
\
motif/xmcombo/xmcombo.c \
\
- common/extended.c
\ No newline at end of file
+ common/extended.c
projects / wxWidgets.git / commitdiff
