Autocomplete.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 AUTOCOMPLETE_H
#define AUTOCOMPLETE_H
 
#include <thread>
#include <algorithm>
#include <memory>
#include <mutex>
#include <atomic>
#include <wx/wx.h>
#include <wx/xml/xml.h>
#include <wx/event.h>
#include <wx/dir.h>
#include <vector>
#include <wx/object.h>
#include <wx/regex.h>
#include <wx/filename.h>
#include <wx/hashmap.h>
#include "Configuration.h"
#include "precomp.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 AutoComplete : public wxEvtHandler
{
  using WorksheetWords = std::unordered_map<wxString, int, wxStringHash>;
public:
  using WordList = std::vector<wxString>;
 
  enum autoCompletionType
  {
    command = 0, 
    tmplte,  
    loadfile,
    demofile,
    generalfile,
    esccommand, 
    unit,    
    numberOfTypes 
  };
  explicit AutoComplete(Configuration *configuration);
 
  ~AutoComplete() override;
 
  void LoadSymbols();
 
  void LoadBuiltinSymbols();
 
  void AddSymbol(wxString fun, autoCompletionType type = command);
  void AddSymbols(wxString xml);
  void AddSymbols(const wxXmlDocument& xml);
  void AddSymbols_Backgroundtask_string(const stop_token &stopToken, const wxString &xml);
  void AddSymbols_Backgroundtask(const stop_token& stopToken, const wxXmlDocument& xmldoc);
 
 
  void UpdateDemoFiles(wxString partial, const wxString &maximaDir);
  void UpdateLoadFiles(wxString partial, const wxString &maximaDir);
  void UpdateGeneralFiles(wxString partial, const wxString &maximaDir);
 
  static bool CompletesFiles(autoCompletionType type) {
    return (type == loadfile) || (type == demofile) || (type == generalfile);
  }
 
  void UpdateFiles(autoCompletionType type, const wxString &partial,
                   const wxString &maximaDir);
 
  void AddWorksheetWords(const WordList &words);
  void AddWorksheetWords(WordList::const_iterator begin, WordList::const_iterator end);
 
  void ClearWorksheetWords();
  void ClearDemofileList();
 
  std::vector<wxString> CompleteSymbol(wxString partial, autoCompletionType type = command);
  static bool IsEscHexCompletion(const wxString &completion);
  static wxString EscCompletionLabel(const wxString &completion);
  static wxString FixTemplate(wxString templ);
  std::vector<wxString> GetDemoFilesList();
  std::vector<wxString> GetSymbolList();
  bool HasDemofile(const wxString &commandname);
 
private:
  void WaitForSymbolTask();
  Configuration *m_configuration;
  void LoadableFiles_BackgroundTask(const stop_token& stopToken, const wxString& sharedir, const wxString& demodir);
  void BuiltinSymbols_BackgroundTask(const stop_token& stopToken);
 
  std::vector<wxString> m_builtInLoadFiles;
  std::vector<wxString> m_builtInDemoFiles;
  class GetGeneralFiles : public wxDirTraverser
  {
  public:
    explicit GetGeneralFiles(std::vector<wxString>& files,
                             std::mutex *lock,
                             stop_token stopToken = {},
                             const wxString &prefix = wxEmptyString) :
      m_files(files), m_lock(lock), m_stopToken(std::move(stopToken)), m_prefix(prefix) {
      for(const auto &i : m_files)
        m_filesHash[i];
    }
    wxDirTraverseResult OnFile(const wxString& filename) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        wxFileName newItemName(filename);
        wxString newItem = "\"" + m_prefix + newItemName.GetFullName() + "\"";
        newItem.Replace(wxFileName::GetPathSeparator(), "/");
        {
          const std::lock_guard<std::mutex> lock(*m_lock);
          if (!m_filesHash.contains(newItem))
          {
            m_files.push_back(newItem);
            m_filesHash[newItem];
          }
        }
        return wxDIR_CONTINUE;
      }
    wxDirTraverseResult OnDir(const wxString& dirname) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        wxFileName newItemName(dirname);
        wxString newItem = "\"" + m_prefix + newItemName.GetFullName() + "/\"";
        newItem.Replace(wxFileName::GetPathSeparator(), "/");
        {
          const std::lock_guard<std::mutex> lock(*m_lock);
          if (!m_filesHash.contains(newItem))
          {
            m_files.push_back(newItem);
            m_filesHash[newItem];
          }
        }
        return wxDIR_IGNORE;
      }
    std::vector<wxString> GetResult(){
      const std::lock_guard<std::mutex> lock(*m_lock);
      return m_files;
    }
  protected:
    std::vector<wxString>& m_files;
    std::unordered_map<wxString, wxEvtHandler*, wxStringHash> m_filesHash;
    std::mutex *m_lock;
    stop_token m_stopToken;
    wxString m_prefix;
  };
 
  class GetMacFiles_includingSubdirs : public wxDirTraverser
  {
  public:
    explicit GetMacFiles_includingSubdirs(std::vector<wxString>& files,
                                          std::mutex *lock,
                                          stop_token stopToken = {},
                                          const wxString &prefix = wxEmptyString) :
      m_files(files), m_lock(lock), m_stopToken(std::move(stopToken)), m_prefix(prefix)
      {
        for(const auto &i : m_files)
        m_filesHash[i];
      }
    wxDirTraverseResult OnFile(const wxString& filename) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        if(
          (filename.EndsWith(".mac"))||
          (filename.EndsWith(".lisp"))||
          (filename.EndsWith(".wxm"))
          )
        {
          wxFileName newItemName(filename);
          wxString newItem = "\"" + m_prefix + newItemName.GetName() + "\"";
          newItem.Replace(wxFileName::GetPathSeparator(), "/");
          {
            const std::lock_guard<std::mutex> lock(*m_lock);
            if (!m_filesHash.contains(newItem))
            {
              m_files.push_back(newItem);
              m_filesHash[newItem];
            }
          }
        }
        return wxDIR_CONTINUE;
      }
    wxDirTraverseResult OnDir(const wxString& dirname) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        if((dirname.EndsWith(".git")) ||
           (dirname.EndsWith("/share/share")) ||
           (dirname.EndsWith("/src/src")) ||
           (dirname.EndsWith("/doc/doc")) ||
           (dirname.EndsWith("/interfaces/interfaces"))
          )
          return wxDIR_STOP;
        else
          return wxDIR_CONTINUE;
      }
    std::vector<wxString> GetResult(){
      const std::lock_guard<std::mutex> lock(*m_lock);
      return m_files;
    }
  protected:
    std::vector<wxString>& m_files;
    std::unordered_map<wxString, wxEvtHandler*, wxStringHash> m_filesHash;
    std::mutex *m_lock;
    stop_token m_stopToken;
    wxString m_prefix;
  };
 
  class GetMacFiles : public GetMacFiles_includingSubdirs
  {
  public:
    explicit GetMacFiles(std::vector<wxString>& files,
                         std::mutex *lock,
                         stop_token stopToken = {},
                         const wxString &prefix = wxEmptyString) :
      GetMacFiles_includingSubdirs(files, lock, std::move(stopToken), prefix){ }
    wxDirTraverseResult OnDir(const wxString& dirname) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        wxFileName newItemName(dirname);
        wxString newItem = "\"" + m_prefix + newItemName.GetFullName() + "/\"";
        newItem.Replace(wxFileName::GetPathSeparator(), "/");
        {
          const std::lock_guard<std::mutex> lock(*m_lock);
          if (!m_filesHash.contains(newItem))
          {
            m_files.push_back(newItem);
            m_filesHash[newItem];
          }
        }
        return wxDIR_IGNORE;
      }
  };
 
  class GetDemoFiles_includingSubdirs : public wxDirTraverser
  {
  public:
    explicit GetDemoFiles_includingSubdirs(std::vector<wxString>& files,
                                           std::mutex *lock,
                                           stop_token stopToken = {},
                                           const wxString &prefix = wxEmptyString) :
      m_files(files), m_lock(lock), m_stopToken(std::move(stopToken)), m_prefix(prefix)
      {
        for(const auto &i : m_files)
        m_filesHash[i];
      }
    wxDirTraverseResult OnFile(const wxString& filename) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        if(filename.EndsWith(".dem"))
        {
          wxFileName newItemName(filename);
          wxString newItem = "\"" + m_prefix + newItemName.GetName() + "\"";
          newItem.Replace(wxFileName::GetPathSeparator(), "/");
          {
            const std::lock_guard<std::mutex> lock(*m_lock);
            if (!m_filesHash.contains(newItem))
            {
              m_files.push_back(newItem);
              m_filesHash[newItem];
            }
          }
        }
        return wxDIR_CONTINUE;
      }
    wxDirTraverseResult OnDir(const wxString& dirname) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        if((dirname.EndsWith(".git")) ||
           (dirname.EndsWith("/share/share")) ||
           (dirname.EndsWith("/src/src")) ||
           (dirname.EndsWith("/doc/doc")) ||
           (dirname.EndsWith("/interfaces/interfaces"))
          )
          return wxDIR_STOP;
        else
          return wxDIR_CONTINUE;
      }
    std::vector<wxString> GetResult(){
      const std::lock_guard<std::mutex> lock(*m_lock);
      return m_files;
    }
  protected:
    std::vector<wxString>& m_files;
    std::unordered_map<wxString, wxEvtHandler*, wxStringHash> m_filesHash;
    std::mutex *m_lock;
    stop_token m_stopToken;
    wxString m_prefix;
  };
 
  class GetDemoFiles : public GetDemoFiles_includingSubdirs
  {
  public:
    explicit GetDemoFiles(std::vector<wxString>& files,
                          std::mutex *lock,
                          stop_token stopToken = {},
                          const wxString &prefix = wxEmptyString) :
      GetDemoFiles_includingSubdirs(files, lock, std::move(stopToken), prefix){ }
    wxDirTraverseResult OnDir(const wxString& dirname) override
      {
        if (m_stopToken.stop_requested()) return wxDIR_STOP;
        wxFileName newItemName(dirname);
        wxString newItem = "\"" + m_prefix + newItemName.GetFullName() + "/\"";
        newItem.Replace(wxFileName::GetPathSeparator(), "/");
        {
          const std::lock_guard<std::mutex> lock(*m_lock);
          if (!m_filesHash.contains(newItem))
          {
            m_files.push_back(newItem);
            m_filesHash[newItem];
          }
        }
        return wxDIR_IGNORE;
      }
  };
 
  jthread m_addSymbols_backgroundThread;
  jthread m_addFiles_backgroundThread;
  std::mutex m_keywordsLock;
  std::vector<std::vector<wxString>> m_wordList;
  static wxRegEx m_args;
  WorksheetWords m_worksheetWords;
};
 
wxDECLARE_EVENT(NEW_DEMO_FILES_EVENT, wxCommandEvent);
 
#endif // AUTOCOMPLETE_H