MaximaManual.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2009-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//  Copyright (C) 2015 Gunter Königsmann     <wxMaxima@physikbuch.de>
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef MAXIMAMANUAL_H
#define MAXIMAMANUAL_H
 
#include <atomic>
#include <thread>
#include <mutex>
#include <memory>
#include <vector>
#include <wx/dir.h>
#include <wx/wx.h>
#include <wx/arrstr.h>
#include <wx/regex.h>
#include <wx/xml/xml.h>
#include <wx/filename.h>
#include "precomp.h"
#include "Configuration.h"
#include "Compat.h"
#include <unordered_map>
 
/* The autocompletion logic
 
   The wordlists for autocompletion for keywords come from several sources:
 
   - wxMaxima::ReadLoadSymbols receive the contents of maxima's variables
   "values" and "functions" after a package is loaded.
   - all words that appear in the worksheet
   - and a list of maxima's builtin commands.
*/
class MaximaManual
{
public:
  explicit MaximaManual(Configuration *configuration);
  using HelpFileAnchors = std::unordered_map<wxString, wxString, wxStringHash>;
  HelpFileAnchors GetHelpfileAnchors();
  void FindMaximaHtmlDir(const wxString &docDir);
  wxString GetHelpfileAnchorName(const wxString& keyword);
  wxString GetHelpfileUrl_Singlepage(const wxString &keyword);
  wxString GetHelpfileUrl_FilePerChapter(const wxString &keyword);
  wxString GetHelpfileURL(const wxString &keyword);
  void LoadHelpFileAnchors(const wxString &docdir, const wxString &maximaVersion);
  void CompileHelpFileAnchors(const stop_token& stopToken,
                              const wxString &maximaHtmlDir,
                              const wxString &maximaShareDir,
                              const wxString &maximaVersion,
                              const wxString &saveName);
  bool LoadManualAnchorsFromCache();
  bool LoadManualAnchorsFromXML(const wxXmlDocument &xmlDocument, bool checkManualVersion = true);
  bool LoadBuiltInManualAnchors();
  void SaveManualAnchorsToCache(const wxString &maximaHtmlDir,
                                const wxString &maximaVersion,
                                const wxString &saveName);
  virtual ~MaximaManual();
private:
  static void AnchorAliasses(HelpFileAnchors &anchors);
  class GetHTMLFiles : public wxDirTraverser
  {
  public:
    explicit GetHTMLFiles(std::vector<wxString>& files,
                          stop_token stopToken = {},
                          const wxString &prefix = wxEmptyString) :
      m_files(files), m_stopToken(std::move(stopToken)), m_prefix(prefix) { }
    wxDirTraverseResult OnFile(const wxString& filename) override;
    wxDirTraverseResult OnDir(const wxString& dirname) override;
    std::vector<wxString>& GetResult() const {return m_files;}
  protected:
    std::vector<wxString>& m_files;
    stop_token m_stopToken;
    wxString m_prefix;
  };
  class GetHTMLFiles_Recursive : public wxDirTraverser
  {
  public:
    explicit GetHTMLFiles_Recursive(std::vector<wxString>& files,
                                    stop_token stopToken = {},
                                    const wxString &prefix = wxEmptyString) :
      m_files(files), m_stopToken(std::move(stopToken)), m_prefix(prefix) { }
    wxDirTraverseResult OnFile(const wxString& filename) override;
    wxDirTraverseResult OnDir(const wxString& dirname) override;
    std::vector<wxString>& GetResult() const {return m_files;}
  protected:
    std::vector<wxString>& m_files;
    stop_token m_stopToken;
    wxString m_prefix;
  };
 
  //    m_configuration.MaximaShareDir(dir);
 
  jthread m_helpfileanchorsThread;
  std::atomic<bool> m_anchorsCompileInFlight{false};
    std::mutex m_helpFileAnchorsLock;
  Configuration *m_configuration = nullptr;
 
  HelpFileAnchors m_helpFileURLs_singlePage;
  HelpFileAnchors m_helpFileURLs_filePerChapter;
  HelpFileAnchors m_helpFileAnchors;
  wxString m_maximaHtmlDir;
  wxString m_maximaVersion;
};
 
#endif // MAXIMAMANUAL_H