X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cfad3750c3ecc821ffae8b9b3de852551270846d..4855a4773e9a49c6bb70f1adc3da7109e0b6ccf7:/src/generic/helphtml.cpp diff --git a/src/generic/helphtml.cpp b/src/generic/helphtml.cpp index 13ea6eeecf..8aa2840806 100644 --- a/src/generic/helphtml.cpp +++ b/src/generic/helphtml.cpp @@ -1,27 +1,61 @@ -/*-*- c++ -*-******************************************************** - * helphtml.cpp - base class for html help systems * - * * - * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) * - * * - * $Id$ - *******************************************************************/ +///////////////////////////////////////////////////////////////////////////// +// 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/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 -#include -#include -#include +#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 +#include +#ifndef __MWERKS__ +#include +#endif + +#if !defined(__WINDOWS__) && !defined(__OS2__) + #include +#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 { @@ -34,21 +68,21 @@ public: }; 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) +wxHTMLHelpControllerBase::wxHTMLHelpControllerBase() { m_MapList = (wxList*) NULL; m_NumOfEntries = 0; } void -wxHTMLHelpControllerBase::DeleteList(void) +wxHTMLHelpControllerBase::DeleteList() { if(m_MapList) { @@ -64,7 +98,7 @@ wxHTMLHelpControllerBase::DeleteList(void) } } -wxHTMLHelpControllerBase::~wxHTMLHelpControllerBase(void) +wxHTMLHelpControllerBase::~wxHTMLHelpControllerBase() { DeleteList(); } @@ -88,7 +122,7 @@ 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()) @@ -96,14 +130,19 @@ wxHTMLHelpControllerBase::LoadFile(const wxString& ifile) file = ifile; if(! wxIsAbsolutePath(file)) { - char* f = wxGetWorkingDirectory(); + 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/" @@ -118,17 +157,18 @@ wxHTMLHelpControllerBase::LoadFile(const wxString& ifile) else { newfile = WXEXTHELP_SEPARATOR; - const char *cptr = wxGetLocale()->GetName().c_str(); - while(*cptr && *cptr != '_') + 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 @@ -140,8 +180,8 @@ wxHTMLHelpControllerBase::LoadFile(const wxString& ifile) DeleteList(); m_MapList = new wxList; m_NumOfEntries = 0; - - FILE *input = fopen(mapFile.c_str(),"rt"); + + FILE *input = wxFopen(mapFile,wxT("rt")); if(! input) return FALSE; do @@ -169,21 +209,44 @@ wxHTMLHelpControllerBase::LoadFile(const wxString& ifile) } }while(! feof(input)); fclose(input); - + m_MapFile = file; // now it's valid return TRUE; } bool -wxHTMLHelpControllerBase::DisplayContents(void) +wxHTMLHelpControllerBase::DisplayContents() { if(! m_NumOfEntries) return FALSE; - wxBusyCursor b; // display a busy cursor - return KeywordSearch(""); + + wxString contents; + wxNode *node = m_MapList->First(); + wxExtHelpMapEntry *entry; + while(node) + { + entry = (wxExtHelpMapEntry *)node->Data(); + if(entry->id == CONTENTS_ID) + { + contents = entry->url; + break; + } + node = node->Next(); + } + + 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) { @@ -203,6 +266,16 @@ wxHTMLHelpControllerBase::DisplaySection(int sectionNo) 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) { @@ -215,36 +288,38 @@ 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()) + wxBusyCursor b; // display a busy cursor + compA = k; compA.LowerCase(); // we compare case insensitive + while(node) { - 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++; + 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(); } - node = node->Next(); } if(idx == 1) @@ -266,19 +341,20 @@ wxHTMLHelpControllerBase::KeywordSearch(const wxString& k) } delete[] urls; delete[] choices; - + return rc; } bool -wxHTMLHelpControllerBase::Quit(void) +wxHTMLHelpControllerBase::Quit() { return TRUE; } void -wxHTMLHelpControllerBase::OnQuit(void) +wxHTMLHelpControllerBase::OnQuit() { } +#endif // wxUSE_HELP