src/generic/helpext.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpext.cpp
   3 // Purpose:     an external help controller for wxWidgets
   4 // Author:      Karsten Ballueder
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Karsten Ballueder
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #   pragma implementation "wxexthlp.h"
  14 #endif
  15
  16 #include "wx/wxprec.h"
  17
  18 #ifdef __BORLANDC__
  19     #pragma hdrstop
  20 #endif
  21
  22 #if wxUSE_HELP && !defined(__WXWINCE__) && (!defined(__WXMAC__) || defined(__WXMAC_OSX__))
  23
  24 #ifndef WX_PRECOMP
  25     #include "wx/setup.h"
  26     #include "wx/string.h"
  27     #include "wx/utils.h"
  28     #include "wx/list.h"
  29     #include "wx/intl.h"
  30     #include "wx/msgdlg.h"
  31     #include "wx/choicdlg.h"
  32     #include "wx/log.h"
  33 #endif
  34
  35 #include "wx/helpbase.h"
  36 #include "wx/generic/helpext.h"
  37
  38 #include <stdio.h>
  39 #include <ctype.h>
  40 #include <sys/stat.h>
  41
  42 #if !defined(__WINDOWS__) && !defined(__OS2__)
  43     #include   <unistd.h>
  44 #endif
  45
  46 #ifdef __WXMSW__
  47 #include <windows.h>
  48 #include "wx/msw/winundef.h"
  49 #endif
  50
  51 // ----------------------------------------------------------------------------
  52 // constants
  53 // ----------------------------------------------------------------------------
  54
  55 /// Name for map file.
  56 #define WXEXTHELP_MAPFILE   _T("wxhelp.map")
  57 /// Maximum line length in map file.
  58 #define WXEXTHELP_BUFLEN 512
  59 /// Character introducing comments/documentation field in map file.
  60 #define WXEXTHELP_COMMENTCHAR   ';'
  61
  62 #define CONTENTS_ID   0
  63
  64 IMPLEMENT_CLASS(wxExtHelpController, wxHelpControllerBase)
  65
  66 /// Name of environment variable to set help browser.
  67 #define   WXEXTHELP_ENVVAR_BROWSER   wxT("WX_HELPBROWSER")
  68 /// Is browser a netscape browser?
  69 #define   WXEXTHELP_ENVVAR_BROWSERISNETSCAPE wxT("WX_HELPBROWSER_NS")
  70
  71 /**
  72    This class implements help via an external browser.
  73    It requires the name of a directory containing the documentation
  74    and a file mapping numerical Section numbers to relative URLS.
  75 */
  76
  77 wxExtHelpController::wxExtHelpController()
  78 {
  79    m_MapList = (wxList*) NULL;
  80    m_NumOfEntries = 0;
  81    m_BrowserName = WXEXTHELP_DEFAULTBROWSER;
  82    m_BrowserIsNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE;
  83
  84    wxChar *browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSER);
  85    if(browser)
  86    {
  87       m_BrowserName = browser;
  88       browser = wxGetenv(WXEXTHELP_ENVVAR_BROWSERISNETSCAPE);
  89       m_BrowserIsNetscape = browser && (wxAtoi(browser) != 0);
  90    }
  91 }
  92
  93 wxExtHelpController::~wxExtHelpController()
  94 {
  95    DeleteList();
  96 }
  97
  98 void wxExtHelpController::SetBrowser(const wxString& browsername, bool isNetscape)
  99 {
 100    m_BrowserName = browsername;
 101    m_BrowserIsNetscape = isNetscape;
 102 }
 103
 104 // Set viewer: new, generic name for SetBrowser
 105 void wxExtHelpController::SetViewer(const wxString& viewer, long flags)
 106 {
 107     SetBrowser(viewer, ((flags & wxHELP_NETSCAPE) == wxHELP_NETSCAPE));
 108 }
 109
 110 bool
 111 wxExtHelpController::DisplayHelp(const wxString &relativeURL)
 112 {
 113    wxBusyCursor b; // display a busy cursor
 114
 115
 116 #if defined(__WXMSW__)
 117    wxString url;
 118    url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
 119    bool bOk = (int)ShellExecute(NULL, wxT("open"), url.c_str(),
 120                                 NULL, NULL, SW_SHOWNORMAL ) > 32;
 121    if ( !bOk )
 122    {
 123       wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
 124       return false;
 125    }
 126
 127    return true;
 128 #elif  defined(__WXPM__)
 129
 130    wxString url;
 131    url << m_MapFile << '\\' << relativeURL.BeforeFirst('#');
 132 //   will have to fix for OS/2, later.....DW
 133 //   bool bOk = (int)ShellExecute(NULL, "open", url,
 134 //                                NULL, NULL, SW_SHOWNORMAL ) > 32;
 135 //   if ( !bOk )
 136 //   {
 137 //      wxLogSysError(_("Cannot open URL '%s'"), relativeURL.c_str());
 138 //      return false;
 139 //   }
 140 //   else
 141       return true;
 142
 143 #elif defined(__DOS__)
 144
 145    wxString command;
 146    command = m_BrowserName;
 147    command << wxT(" file://")
 148            << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
 149    return wxExecute(command) != 0;
 150
 151 #else // UNIX
 152    wxString command;
 153
 154 #ifndef __EMX__
 155    if(m_BrowserIsNetscape) // try re-loading first
 156    {
 157       wxString lockfile;
 158       wxGetHomeDir(&lockfile);
 159 #ifdef __VMS__
 160       lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape]lock.");
 161       struct stat statbuf;
 162       if(stat(lockfile.fn_str(), &statbuf) == 0)
 163 #else
 164       lockfile << WXEXTHELP_SEPARATOR << wxT(".netscape/lock");
 165       struct stat statbuf;
 166       if(lstat(lockfile.fn_str(), &statbuf) == 0)
 167       // cannot use wxFileExists, because it's a link pointing to a
 168       // non-existing location      if(wxFileExists(lockfile))
 169 #endif
 170       {
 171          long success;
 172          command << m_BrowserName << wxT(" -remote openURL(")
 173                  << wxT("file://") << m_MapFile
 174                  << WXEXTHELP_SEPARATOR << relativeURL << wxT(")");
 175          success = wxExecute(command);
 176          if(success != 0 ) // returns PID on success
 177             return true;
 178       }
 179    }
 180 #endif
 181    command = m_BrowserName;
 182    command << wxT(" file://")
 183            << m_MapFile << WXEXTHELP_SEPARATOR << relativeURL;
 184    return wxExecute(command) != 0;
 185 #endif
 186 }
 187
 188 class wxExtHelpMapEntry : public wxObject
 189 {
 190 public:
 191    int      id;
 192    wxString url;
 193    wxString doc;
 194    wxExtHelpMapEntry(int iid, wxString const &iurl, wxString const &idoc)
 195       { id = iid; url = iurl; doc = idoc; }
 196 };
 197
 198 void wxExtHelpController::DeleteList()
 199 {
 200    if(m_MapList)
 201    {
 202       wxList::compatibility_iterator node = m_MapList->GetFirst();
 203       while (node)
 204       {
 205          delete (wxExtHelpMapEntry *)node->GetData();
 206          m_MapList->Erase(node);
 207          node = m_MapList->GetFirst();
 208       }
 209       delete m_MapList;
 210       m_MapList = (wxList*) NULL;
 211    }
 212 }
 213
 214 /** This must be called to tell the controller where to find the
 215     documentation.
 216     @param file - NOT a filename, but a directory name.
 217     @return true on success
 218 */
 219 bool
 220 wxExtHelpController::Initialize(const wxString& file)
 221 {
 222    return LoadFile(file);
 223 }
 224
 225
 226 // ifile is the name of the base help directory
 227 bool wxExtHelpController::LoadFile(const wxString& ifile)
 228 {
 229    wxString mapFile, file, url, doc;
 230    int id,i,len;
 231    char buffer[WXEXTHELP_BUFLEN];
 232
 233    wxBusyCursor b; // display a busy cursor
 234
 235    if(! ifile.empty())
 236    {
 237       file = ifile;
 238       if(! wxIsAbsolutePath(file))
 239       {
 240          wxChar* f = wxGetWorkingDirectory();
 241          file = f;
 242          delete[] f; // wxGetWorkingDirectory returns new memory
 243 #ifdef __WXMAC__
 244          file << ifile;
 245 #else
 246          file << WXEXTHELP_SEPARATOR << ifile;
 247 #endif
 248       }
 249       else
 250          file = ifile;
 251
 252 #if wxUSE_INTL
 253       // If a locale is set, look in file/localename, i.e.
 254       // If passed "/usr/local/myapp/help" and the current wxLocale is
 255       // set to be "de", then look in "/usr/local/myapp/help/de/"
 256       // first and fall back to "/usr/local/myapp/help" if that
 257       // doesn't exist.
 258       if(wxGetLocale() && !wxGetLocale()->GetName().empty())
 259       {
 260          wxString newfile;
 261          newfile << WXEXTHELP_SEPARATOR << wxGetLocale()->GetName();
 262          if(wxPathExists(newfile))
 263             file = newfile;
 264          else
 265          {
 266             newfile = WXEXTHELP_SEPARATOR;
 267             const wxChar *cptr = wxGetLocale()->GetName().c_str();
 268             while(*cptr && *cptr != wxT('_'))
 269                newfile << *(cptr++);
 270             if(wxPathExists(newfile))
 271                file = newfile;
 272          }
 273       }
 274 #endif
 275
 276       if(! wxPathExists(file))
 277          return false;
 278
 279       mapFile << file << WXEXTHELP_SEPARATOR << WXEXTHELP_MAPFILE;
 280    }
 281    else // try to reload old file
 282       mapFile = m_MapFile;
 283
 284    if(! wxFileExists(mapFile))
 285       return false;
 286
 287    DeleteList();
 288    m_MapList = new wxList;
 289    m_NumOfEntries = 0;
 290
 291    FILE *input = wxFopen(mapFile,wxT("rt"));
 292    if(! input)
 293       return false;
 294    do
 295    {
 296       if(fgets(buffer,WXEXTHELP_BUFLEN,input) && *buffer != WXEXTHELP_COMMENTCHAR)
 297       {
 298          len = strlen(buffer);
 299          if(buffer[len-1] == '\n')
 300             buffer[len-1] = '\0'; // cut of trailing newline
 301          if(sscanf(buffer,"%d", &id) != 1)
 302             break; // error
 303          for(i=0; isdigit(buffer[i])||isspace(buffer[i])||buffer[i]=='-'; i++)
 304             ; // find begin of URL
 305          url = wxEmptyString;
 306          while(buffer[i] && ! isspace(buffer[i]) && buffer[i] !=
 307                WXEXTHELP_COMMENTCHAR)
 308             url << (wxChar) buffer[i++];
 309          while(buffer[i] && buffer[i] != WXEXTHELP_COMMENTCHAR)
 310             i++;
 311          doc = wxEmptyString;
 312          if(buffer[i])
 313             doc = wxString::FromAscii( (buffer + i + 1) ); // skip the comment character
 314          m_MapList->Append(new wxExtHelpMapEntry(id,url,doc));
 315          m_NumOfEntries++;
 316       }
 317    }while(! feof(input));
 318    fclose(input);
 319
 320    m_MapFile = file; // now it's valid
 321    return true;
 322 }
 323
 324
 325 bool
 326 wxExtHelpController::DisplayContents()
 327 {
 328    if(! m_NumOfEntries)
 329       return false;
 330
 331    wxString contents;
 332    wxList::compatibility_iterator node = m_MapList->GetFirst();
 333    wxExtHelpMapEntry *entry;
 334    while(node)
 335    {
 336       entry = (wxExtHelpMapEntry *)node->GetData();
 337       if(entry->id == CONTENTS_ID)
 338       {
 339          contents = entry->url;
 340          break;
 341       }
 342       node = node->GetNext();
 343    }
 344
 345    bool rc = false;
 346    wxString file;
 347    file << m_MapFile << WXEXTHELP_SEPARATOR << contents;
 348    if(file.Contains(wxT('#')))
 349       file = file.BeforeLast(wxT('#'));
 350    if(contents.Length() && wxFileExists(file))
 351       rc = DisplaySection(CONTENTS_ID);
 352
 353    // if not found, open homemade toc:
 354    return rc ? true : KeywordSearch(wxEmptyString);
 355 }
 356
 357 bool
 358 wxExtHelpController::DisplaySection(int sectionNo)
 359 {
 360    if(! m_NumOfEntries)
 361       return false;
 362
 363    wxBusyCursor b; // display a busy cursor
 364    wxList::compatibility_iterator node = m_MapList->GetFirst();
 365    wxExtHelpMapEntry *entry;
 366    while(node)
 367    {
 368       entry = (wxExtHelpMapEntry *)node->GetData();
 369       if(entry->id == sectionNo)
 370          return DisplayHelp(entry->url);
 371       node = node->GetNext();
 372    }
 373    return false;
 374 }
 375
 376 bool wxExtHelpController::DisplaySection(const wxString& section)
 377 {
 378     bool isFilename = (section.Find(wxT(".htm")) != -1);
 379
 380     if (isFilename)
 381         return DisplayHelp(section);
 382     else
 383         return KeywordSearch(section);
 384 }
 385
 386 bool
 387 wxExtHelpController::DisplayBlock(long blockNo)
 388 {
 389    return DisplaySection((int)blockNo);
 390 }
 391
 392 bool
 393 wxExtHelpController::KeywordSearch(const wxString& k,
 394                                    wxHelpSearchMode WXUNUSED(mode))
 395 {
 396    if(! m_NumOfEntries)
 397       return false;
 398
 399    wxString     *choices = new wxString[m_NumOfEntries];
 400    wxString     *urls = new wxString[m_NumOfEntries];
 401    wxString compA, compB;
 402
 403    int          idx = 0, j;
 404    bool         rc;
 405    bool         showAll = k.empty();
 406    wxList::compatibility_iterator node = m_MapList->GetFirst();
 407    wxExtHelpMapEntry *entry;
 408
 409    {
 410       wxBusyCursor b; // display a busy cursor
 411       compA = k; compA.LowerCase(); // we compare case insensitive
 412       while(node)
 413       {
 414          entry = (wxExtHelpMapEntry *)node->GetData();
 415          compB = entry->doc; compB.LowerCase();
 416          if((showAll || compB.Contains(k)) && ! compB.empty())
 417          {
 418             urls[idx] = entry->url;
 419             // doesn't work:
 420             // choices[idx] = (**i).doc.Contains((**i).doc.Before(WXEXTHELP_COMMENTCHAR));
 421             //if(choices[idx].empty()) // didn't contain the ';'
 422             //   choices[idx] = (**i).doc;
 423             choices[idx] = wxEmptyString;
 424             for(j=0;entry->doc.c_str()[j]
 425                    && entry->doc.c_str()[j] != WXEXTHELP_COMMENTCHAR; j++)
 426                choices[idx] << entry->doc.c_str()[j];
 427             idx++;
 428          }
 429          node = node->GetNext();
 430       }
 431    }
 432
 433    if(idx == 1)
 434       rc = DisplayHelp(urls[0]);
 435    else if(idx == 0)
 436    {
 437       wxMessageBox(_("No entries found."));
 438       rc = false;
 439    }
 440    else
 441    {
 442       idx = wxGetSingleChoiceIndex(showAll ? _("Help Index") : _("Relevant entries:"),
 443                                    showAll ? _("Help Index") : _("Entries found"),
 444                                    idx,choices);
 445       if(idx != -1)
 446          rc = DisplayHelp(urls[idx]);
 447       else
 448          rc = false;
 449    }
 450    delete[] urls;
 451    delete[] choices;
 452
 453    return rc;
 454 }
 455
 456
 457 bool wxExtHelpController::Quit()
 458 {
 459    return true;
 460 }
 461
 462 void wxExtHelpController::OnQuit()
 463 {
 464 }
 465
 466
 467 #endif // wxUSE_HELP
 468