UndoRedoManager.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2017.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWCOMMAND_UNDOREDOMANAGER_HPP__
#define __FWCOMMAND_UNDOREDOMANAGER_HPP__

#include "fwCommand/config.hpp"
#include "fwCommand/ICommand.hpp"

#include <deque>
#include <limits>

namespace fwCommand
{

class FWCOMMAND_CLASS_API UndoRedoManager
{
public:

    FWCOMMAND_API UndoRedoManager(size_t maxMemory = std::numeric_limits<size_t>::max(),
                                  size_t maxCommands = std::numeric_limits<size_t>::max());

    FWCOMMAND_API bool enqueue( ICommand::sptr cmd );

    FWCOMMAND_API bool redo();

    FWCOMMAND_API bool undo();

    FWCOMMAND_API bool canUndo() const;

    FWCOMMAND_API bool canRedo() const;

    FWCOMMAND_API void clear();

    FWCOMMAND_API size_t getCommandCount() const;

    FWCOMMAND_API void setCommandCount(size_t cmdCount);

    FWCOMMAND_API size_t getHistorySize() const;

    FWCOMMAND_API void setHistorySize(size_t histSize);

private:

    typedef std::deque<ICommand::sptr> CommandHistoryType;

    size_t m_maxMemory;

    size_t m_maxCommands;

    size_t m_usedMemory;

    CommandHistoryType m_commandQueue;

    std::int64_t m_commandIndex;

    void popFront();

};

} // namespace fwCommand

#endif // __FWCOMMAND_UNDOREDOMANAGER_HPP__