src/generic/helpext.cpp

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