TreeUndoAction.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) 2014-2018 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 TREEUNDOACTION_H
#define TREEUNDOACTION_H
 
#include "cells/CellPtr.h"
#include "cells/GroupCell.h"
#include <wx/string.h>
#include <list>
#include <memory>
#include <optional>
 
class TreeUndoAction
{
public:
  TreeUndoAction(GroupCell *start, const wxString &oldText,
                 long long oldSelStart = -1, long long oldSelEnd = -1) :
    m_start(start), m_oldText(oldText),
    m_oldSelStart(oldSelStart), m_oldSelEnd(oldSelEnd)
    {
      wxASSERT_MSG(start, _("Bug: Trying to record a cell contents change for undo without a cell."));
    }
  TreeUndoAction(GroupCell *start, GroupCell *end) :
    m_start(start), m_newCellsEnd(end)
    {
      wxASSERT_MSG(start, _("Bug: Trying to record a cell contents change for undo without a cell."));
    }
  TreeUndoAction(GroupCell *start, GroupCell *end, GroupCell *oldCells) :
    m_start(start), m_newCellsEnd(end), m_oldCells(oldCells)
    {
    }
 
  enum class FoldDirection {
    Folded,  
    Unfolded 
  };
 
  TreeUndoAction(GroupCell *start, FoldDirection direction) :
    m_start(start), m_fold(direction)
    {
      wxASSERT_MSG(start, _("Bug: Trying to record a fold/unfold for undo without a cell."));
    }
 
  bool m_partOfAtomicAction = false;
 
  CellPtr<GroupCell> m_start;
 
  const wxString m_oldText;
 
  const long long m_oldSelStart = -1;
  const long long m_oldSelEnd   = -1;
 
  CellPtr<GroupCell> m_newCellsEnd;
 
  std::unique_ptr<GroupCell> m_oldCells;
 
  const std::optional<FoldDirection> m_fold;
};
 
using UndoActions = std::list<TreeUndoAction>;
 
#endif // TREEUNDOACTION_H