undostack.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_EDITOR_UNDOSTACK_H
#define LIBREPCB_EDITOR_UNDOSTACK_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
namespace editor {
 
class UndoCommand;
class UndoCommandGroup;
class UndoStack;
 
/*******************************************************************************
 *  Class UndoStackTransaction
 ******************************************************************************/
 
class UndoStackTransaction final {
public:
  // Constructors / Destructor
  UndoStackTransaction() = delete;
  UndoStackTransaction(const UndoStackTransaction& other) = delete;
  UndoStackTransaction(UndoStack& stack, const QString& text);
  ~UndoStackTransaction() noexcept;
 
  // General Methods
  void append(UndoCommand* cmd);
  void abort();
  bool commit();
 
  // Operator Overloadings
  UndoStackTransaction& operator=(const UndoStackTransaction& rhs) = delete;
 
private:
  UndoStack& mStack;
  bool mCmdActive;
};
 
/*******************************************************************************
 *  Class UndoStack
 ******************************************************************************/
 
class UndoStack final : public QObject {
  Q_OBJECT
 
public:
  // Constructors / Destructor
  UndoStack(const UndoStack& other) = delete;
  UndoStack& operator=(const UndoStack& rhs) = delete;
 
  UndoStack() noexcept;
 
  ~UndoStack() noexcept;
 
  // Getters
 
  QString getUndoText() const noexcept;
 
  QString getRedoText() const noexcept;
 
  bool canUndo() const noexcept;
 
  bool canRedo() const noexcept;
 
  uint getUniqueStateId() const noexcept;
 
  bool isClean() const noexcept;
 
  bool isCommandGroupActive() const noexcept;
 
  // Setters
 
  void setClean() noexcept;
 
  // General Methods
 
  bool execCmd(UndoCommand* cmd, bool forceKeepCmd = false);
 
  void beginCmdGroup(const QString& text);
 
  bool appendToCmdGroup(UndoCommand* cmd);
 
  bool commitCmdGroup();
 
  void abortCmdGroup();
 
  void undo();
 
  void redo();
 
  void clear() noexcept;
 
signals:
  void undoTextChanged(const QString& text);
  void redoTextChanged(const QString& text);
  void canUndoChanged(bool canUndo);
  void canRedoChanged(bool canRedo);
  void cleanChanged(bool clean);
  void commandGroupEnded();
  void commandGroupAborted();
  void stateModified();
 
private:
  QList<UndoCommand*> mCommands;
 
  int mCurrentIndex;
 
  int mCleanIndex;
 
  UndoCommandGroup* mActiveCommandGroup;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif