WorksheetDocument.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 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 WORKSHEETDOCUMENT_H
#define WORKSHEETDOCUMENT_H
 
#include "CellPointers.h"
#include "EvaluationQueue.h"
#include "TreeUndoManager.h"
#include "WorksheetCursor.h"
#include "cells/CellPtr.h"
#include "cells/GroupCell.h"
#include <memory>
#include <vector>
#include <wx/string.h>
 
class WorksheetDocumentView;
 
class WorksheetDocument {
public:
  EvaluationQueue &GetEvaluationQueue() { return m_evaluationQueue; }
  const EvaluationQueue &GetEvaluationQueue() const { return m_evaluationQueue; }
 
  TreeUndoManager &GetTreeUndo() { return m_treeUndo; }
  const TreeUndoManager &GetTreeUndo() const { return m_treeUndo; }
 
  WorksheetCursor &GetCursor() { return m_hCaret; }
  const WorksheetCursor &GetCursor() const { return m_hCaret; }
 
  GroupCell *GetTree() const { return m_tree.get(); }
  std::unique_ptr<GroupCell> &TreeOwner() { return m_tree; }
  CellPtr<GroupCell> &LastCache() const { return m_last; }
 
  void SetDocumentView(WorksheetDocumentView *view) { m_view = view; }
 
  bool CanApplyTreeAction(const UndoActions &actions) const;
 
  enum class TextUndoResult {
    CellGone,
    NoOpSkipped,
    Applied
  };
 
  TextUndoResult UndoTextChange(const TreeUndoAction &action,
                                UndoActions *undoForThisOperation);
 
  GroupCell *GetLastCell() const;
 
  void NumberSections() const;
 
  GroupCell *Fold(GroupCell *which);
  GroupCell *Unfold(GroupCell *which);
  GroupCell *ToggleFold(GroupCell *which);
  GroupCell *ToggleFoldAll(GroupCell *which);
  void FoldAll();
  void UnfoldAll();
 
  bool CanEdit() const;
  bool CanDeleteSelection() const;
  bool CanMergeSelection() const;
  bool IsSelected(CellType type) const;
  bool IsSelectionInWorkingGroup() const;
  bool CanUndoInsideCell() const;
  bool CanRedoInsideCell() const;
 
  GroupCell *InsertCells(std::unique_ptr<GroupCell> &&cells, GroupCell *where);
 
  bool CanRemoveCells(GroupCell *start, const GroupCell *end) const;
 
  std::unique_ptr<GroupCell> RemoveCells(GroupCell *start, GroupCell *end);
 
  const wxString &GetCurrentFile() const { return m_currentFile; }
  void SetCurrentFile(const wxString &file) { m_currentFile = file; }
 
  const wxString &GetLastQuestion() const { return m_lastQuestion; }
  void SetLastQuestion(const wxString &lastQuestion) {
    m_lastQuestion = lastQuestion;
  }
 
  bool QuestionPending() const { return m_questionPrompt; }
  void SetQuestionPending(bool pending) { m_questionPrompt = pending; }
 
  DocumentCellPointers &GetCellPointers() { return m_cellPointers; }
  const DocumentCellPointers &GetCellPointers() const { return m_cellPointers; }
 
  bool IsSaved() const { return m_saved; }
  void SetSaved(bool saved);
  void OutputChanged() {
    if (m_currentFile.EndsWith(wxS(".wxmx")))
      m_saved = false;
  }
 
private:
  void RecordFoldUndo(const std::vector<GroupCell *> &affected,
                      TreeUndoAction::FoldDirection direction);
 
  EvaluationQueue m_evaluationQueue;
  TreeUndoManager m_treeUndo;
  WorksheetCursor m_hCaret;
  std::unique_ptr<GroupCell> m_tree;
  mutable CellPtr<GroupCell> m_last;
  WorksheetDocumentView *m_view = nullptr;
  wxString m_currentFile;
  wxString m_lastQuestion;
  bool m_questionPrompt = false;
  bool m_saved = true;
  DocumentCellPointers m_cellPointers;
};
 
#endif // WORKSHEETDOCUMENT_H