-/////////////////////////////////////////////////////////////////////////////
-// Name: helphtml.cpp
-// Purpose: base class for html help systems
-// Author: Karsten Ballueder
-// Modified by:
-// Created: 04/01/98
-// RCS-ID: $Id$
-// Copyright: (c) Karsten Ballueder
-// Licence: wxWindows licence
-/////////////////////////////////////////////////////////////////////////////
-
-#ifdef __GNUG__
-# pragma implementation "helphtml.h"
-#endif
-
-#include "wx/wxprec.h"
-
-#ifdef __BORLANDC__
- #pragma hdrstop
-#endif
-
-#if wxUSE_HELP
-
-#ifndef WX_PRECOMP
- #include "wx/setup.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"
-#endif
-
-#include "wx/helpbase.h"
-#include "wx/generic/helpext.h"
-
-#include <stdio.h>
-#include <ctype.h>
-#ifndef __MWERKS__
-#include <sys/stat.h>
-#endif
-
-#if !defined(__WINDOWS__) && !defined(__OS2__)
- #include <unistd.h>
-#endif
-
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-/// 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 ';'
-
-#define CONTENTS_ID 0
-
-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; }
-};
-
-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()
-{
- m_MapList = (wxList*) NULL;
- m_NumOfEntries = 0;
-}
-
-void
-wxHTMLHelpControllerBase::DeleteList()
-{
- if(m_MapList)
- {
- wxNode *node = m_MapList->GetFirst();
- while (node)
- {
- delete (wxExtHelpMapEntry *)node->GetData();
- delete node;
- node = m_MapList->GetFirst();
- }
- delete m_MapList;
- m_MapList = (wxList*) NULL;
- }
-}
-
-wxHTMLHelpControllerBase::~wxHTMLHelpControllerBase()
-{
- 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))
- {
- wxChar* f = wxGetWorkingDirectory();
- file = f;
- delete[] f; // wxGetWorkingDirectory returns new memory
-#ifdef __WXMAC__
- file << ifile;
-#else
- file << WXEXTHELP_SEPARATOR << ifile;
-#endif
- }
- else
- file = ifile;
-
-#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().IsEmpty())
- {
- 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 = wxT("");
- while(buffer[i] && ! isspace(buffer[i]) && buffer[i] !=
- WXEXTHELP_COMMENTCHAR)
- url << (wxChar) buffer[i++];
- while(buffer[i] && buffer[i] != WXEXTHELP_COMMENTCHAR)
- i++;
- doc = wxT("");
- 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;
-}
-
-
-bool
-wxHTMLHelpControllerBase::DisplayContents()
-{
- if(! m_NumOfEntries)
- return FALSE;
-
- wxString contents;
- wxNode *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_MapFile << WXEXTHELP_SEPARATOR << 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(wxT(""));
-}
-
-bool
-wxHTMLHelpControllerBase::DisplaySection(int sectionNo)
-{
- if(! m_NumOfEntries)
- return FALSE;
-
- wxBusyCursor b; // display a busy cursor
- wxNode *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;
-}
-
-bool wxHTMLHelpControllerBase::DisplaySection(const wxString& section)
-{
- bool isFilename = (section.Find(wxT(".htm")) != -1);
-
- if (isFilename)
- return DisplayHelp(section);
- else
- return KeywordSearch(section);
-}
-
-bool
-wxHTMLHelpControllerBase::DisplayBlock(long blockNo)
-{
- return DisplaySection((int)blockNo);
-}
-
-bool
-wxHTMLHelpControllerBase::KeywordSearch(const wxString& k)
-{
- if(! m_NumOfEntries)
- return FALSE;
-
- 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->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.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] = wxT("");
- 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;
-}
-
-
-bool
-wxHTMLHelpControllerBase::Quit()
-{
- return TRUE;
-}
-
-void
-wxHTMLHelpControllerBase::OnQuit()
-{
-}
-
-#endif // wxUSE_HELP
projects / wxWidgets.git / commitdiff
