wxMaximaFrame.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2004-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2012 Doug Ilijev <doug.ilijev@gmail.com>
//            (C) 2014-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 WXMAXIMAFRAME_H
#define WXMAXIMAFRAME_H
 
#include "precomp.h"
#include <array>
#include <wx/wx.h>
#include "EventIDs.h"
#include <wx/dirctrl.h>
#include <wx/filehistory.h>
#include <wx/listbox.h>
#include <wx/bmpbuttn.h>
#include <wx/arrstr.h>
#include <wx/aui/aui.h>
#include <wx/notifmsg.h>
#include <wx/wrapsizer.h>
#include "sidebars/TableOfContents.h"
#include "sidebars/DrawSidebar.h"
 
#include "wizards/ScrollingGenWizPanel.h"
#include "Worksheet.h"
#include "sidebars/SymbolsSidebar.h"
#include "sidebars/HelpBrowser.h"
#include "RecentDocuments.h"
#include "BuildConfig.h"
#include "MainMenuBar.h"
#include "sidebars/History.h"
#include "sidebars/XmlInspector.h"
#include "sidebars/PerformanceSidebar.h"
#include "StatusBar.h"
#include "sidebars/ButtonWrapSizer.h"
#include <list>
 
 
class wxMaximaFrame : public wxFrame
{
public:
  wxMaximaFrame(wxWindow *parent, int id, const wxString &title,
                const wxPoint &pos = wxDefaultPosition,
                const wxSize &size = wxDefaultSize,
                long style = wxDEFAULT_FRAME_STYLE | wxSYSTEM_MENU | wxCAPTION);
 
  virtual ~wxMaximaFrame();
 
  void ShowToolBar(bool show);
  static std::size_t CountWindows();
 
  void UpdateRecentDocuments();
 
  void PopulateRecentDocumentsMenu(wxMenu *menu, int firstEntry, const std::list<wxString> &items);
  void PopulateRecentPackagesMenu(wxMenu *menu, int firstEntry, const std::list<wxString> &items);
 
  bool IsPaneDisplayed(int id);
 
  void ShowPane(int id, bool show = true);
  bool IsXMLInspectorShown(){return m_manager.GetPane(wxS("XmlInspector")).IsShown();}
  bool IsPerformanceMonitorShown(){return m_manager.GetPane(wxS("performance")).IsShown();}
  void ToggleXMLInspector()
    {
      m_manager.GetPane(wxS("XmlInspector")).Show(!IsXMLInspectorShown());
      AuiManagerUpdate();
    }
  void ToggleLogPane()
    {
      m_manager.GetPane(wxS("log"))
        .Show(!m_manager.GetPane(wxS("log")).IsShown());
      AuiManagerUpdate();
    }
  void ShowWizardPane(wxString title)
    {
      m_manager.GetPane("wizard").Show(true).Caption(title);
      AuiManagerUpdate();
    }
  void HideWizardPane()
    {
        m_manager.GetPane("wizard").Show(false);
        AuiManagerUpdate();
    }
  void TogglePaneVisibility(int id);
 
  void AddToHistory(const wxString &cmd)
    { m_history->AddToHistory(cmd); }
 
  void EvaluationQueueLength(int length, int numberOfCommands = -1);
 
  void AuiManagerUpdate();
 
  void StatusMaximaBusy(StatusBar::MaximaStatus status){m_StatusMaximaBusy_next = status;}
  StatusBar::MaximaStatus StatusMaximaBusy() const {return m_StatusMaximaBusy;}
  void UpdateStatusMaximaBusy();
 
  bool HasPendingStatusText() const {return m_newStatusText;}
  void ClearPendingStatusText() {m_newStatusText = false;}
  const wxString &GetLeftStatusText() const {return m_leftStatusText;}
 
  void StatusSaveStart();
 
  void StatusSaveFinished();
 
  void StatusSaveFailed();
 
  void StatusExportStart();
 
  void StatusExportFinished();
 
  void StatusExportFailed();
 
  Configuration &GetConfiguration() {return m_configuration;}
protected:
  Variablespane *m_variablesPane = NULL;
  TableOfContents *m_tableOfContents = NULL;
  Configuration m_configuration;
  std::size_t m_bytesFromMaxima = 0;
  long m_pid = -1;
  long m_maximaPid = -1;
  wxString m_tempfileName;
  void OnNotificationClose(wxCommandEvent WXUNUSED(&event));
  StatusBar *m_statusBar = NULL;
  MainMenuBar *m_MenuBar = NULL;
  wxMenu *m_demo_sub = NULL;
  std::vector<wxMenu *> m_demoSubs;
  wxMenu *m_viewMenu = NULL;
  wxMenu *m_gentranMenu = NULL;
  wxMenu *m_subst_Sub = NULL;
  wxMenu * m_logexpand_Sub = NULL;
  wxMenu *m_FileMenu = NULL;
  wxMenu *m_EditMenu = NULL;
  wxMenu *m_CellMenu = NULL;
  wxMenu *m_Edit_Zoom_Sub = NULL;
  wxMenu *m_Maxima_Panes_Sub = NULL;
  wxMenu *m_EquationsMenu = NULL;
  wxMenu *m_MaximaMenu = NULL;
  wxMenu *m_matrix_menu = NULL;
  wxMenu *m_SimplifyMenu = NULL;
  wxMenu *m_Simplify_Gamma_Sub = NULL;
  wxMenu *m_debugTypeMenu = NULL;
  wxMenu *m_Simplify_Trig_Sub = NULL;
  wxMenu *m_Simplify_Complex_Sub = NULL;
  wxMenu *m_CalculusMenu = NULL;
 
  wxMenu *m_PlotMenu = NULL;
  wxMenu *m_listMenu = NULL;
  wxMenu *m_NumericMenu = NULL;
  wxMenu *m_HelpMenu = NULL;
  void RemoveTempAutosavefile();
  void ReReadConfig();
  void ReadConfig();
  void RegisterAutoSaveFile();
  void DockAllSidebars(wxCommandEvent &ev);
  void HideAllSidebars(wxCommandEvent &ev);
 
  wxString wxMaximaManualLocation();
public:
  const std::unordered_map<int, wxString>  &GetSidebarNames() const {return m_sidebarNames;}
protected:
  Worksheet *GetWorksheet() const {return m_worksheet;}
private:
  std::unordered_map<int, wxString> m_sidebarNames;
  std::unordered_map<int, wxString> m_sidebarCaption;
  std::size_t m_bytesFromMaxima_last = 0;
  wxTimer m_bytesReadDisplayTimer;
  bool m_StatusSaving = false;
  StatusBar::MaximaStatus m_StatusMaximaBusy = StatusBar::wait_for_start;
  StatusBar::MaximaStatus m_StatusMaximaBusy_next = StatusBar::wait_for_start;
  bool m_newStatusText = false;
  wxString m_leftStatusText;
  bool m_forceStatusbarUpdate = false;
 
  void SetupToolBar();
 
  void SetupMenu();
  void SetupFileMenu();
  void SetupEditMenu();
  void SetupViewMenu();
  void SetupCellMenu();
  void SetupMaximaMenu();
  void SetupEquationsMenu();
  void SetupMatrixMenu();
  void SetupCalculusMenu();
  void SetupSimplifyMenu();
  void SetupListMenu();
  void SetupPlotMenu();
  void SetupNumericMenu();
  void SetupHelpMenu();
 
public:
  void StatusText(const wxString &text, bool saveInLog = true);
protected:
  ScrollingGenWizPanel *m_wizard = NULL;
  long m_drawDimensions_last = -1;
  virtual wxSize DoGetBestClientSize() const;
  DrawSidebar *m_drawPane = NULL;
#ifdef USE_WEBVIEW
  HelpBrowser *m_helpPane = NULL;
#endif
 
  wxString GetDemoFile(wxWindowID id) const;
protected:
  std::array<wxString, 10> m_statusTextHistory;
  void OnMenuStatusText(wxMenuEvent &event);
  std::unordered_map<wxWindowID, wxString> m_demoFilesIDs;
 
  SymbolsSidebar *m_symbolsSidebar = NULL;
  int m_EvaluationQueueLength = 0;
  bool m_updateEvaluationQueueLengthDisplay = true;
  int m_commandsLeftInCurrentCell = 0;
 
  bool m_first = true;
 
  bool ToolbarIsShown();
protected:
  wxAuiManager m_manager;
  Worksheet * const m_worksheet = NULL;
  History * const m_history = NULL;
  XmlInspector *m_xmlInspector = NULL;
  PerformanceSidebar *m_performanceSidebar = NULL;
  RecentDocuments m_recentDocuments;
  RecentDocuments m_recentPackages;
  wxMenu *m_recentDocumentsMenu = NULL;
  wxMenu *m_unsavedDocumentsMenu = NULL;
  wxMenu *m_recentPackagesMenu = NULL;
  wxMenu *m_autoSubscriptMenu = NULL;
  wxMenu *m_equationTypeMenuMenu = NULL;
  wxMenu *m_roundedMatrixParensMenu = NULL;
};
 
#endif // WXMAXIMAFRAME_H