BackupData.hh 5.58 KB
Newer Older
Dirk Wilden's avatar
Dirk Wilden committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Dirk Wilden's avatar
Dirk Wilden committed
39 40 41 42 43
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
Jan Möbius's avatar
Jan Möbius committed
44 45 46
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
Dirk Wilden's avatar
Dirk Wilden committed
47 48 49 50 51 52 53 54 55 56
*                                                                            *
\*===========================================================================*/

#ifndef BACKUPDATA_HH
#define BACKUPDATA_HH

#include <QString>
#include <OpenFlipper/common/perObjectData.hh>
#include <OpenFlipper/common/UpdateType.hh>
#include <OpenFlipper/common/BaseBackup.hh>
Jan Möbius's avatar
Jan Möbius committed
57
#include <OpenFlipper/common/GlobalDefines.hh>
Dirk Wilden's avatar
Dirk Wilden committed
58 59 60 61 62 63 64 65

#define OBJECT_BACKUPS "Object Backups"

/**
 * @brief Abstract class that is used to store backups
 *
 * The default implementation can only backup perObjectDatas
 */
Jan Möbius's avatar
Jan Möbius committed
66
class DLLEXPORT BackupData : public PerObjectData
Dirk Wilden's avatar
Dirk Wilden committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
{

  public:
    /// Constructor
    BackupData(BaseObjectData* _object = 0);
    /// Destructor
    virtual ~BackupData();

  public:
    /// store a backup
    void storeBackup(BaseBackup* _backup);

    /// perform an undo if possible
    void undo();
    /// perform a redo if possible
    void redo();

    /// return the id of the next undo backup
    int undoID();
    /// return the id of the next redo backup
    int redoID();
    /// return the id of the current backup state
    int currentID();
    
    /// return the name of the next undo backup
    QString undoName();
    /// return the name of the next redo backup
    QString redoName();

    /// return if an undo backup is available
    bool undoAvailable();
    /// return if a redo backup is available
    bool redoAvailable();

    /// return if an undo backup is blocked
    bool undoBlocked();
    /// return if a redo backup is blocked
    bool redoBlocked();

    /// remove all backups
    void clear();

    /// add links to other backups for the current state
    /// this is used to ensure that the backups are only applied simultaneously
    void setLinks(IdList _objectIDs);

    /// return the current state
    BaseBackup* currentState();

Matthias Möller's avatar
Matthias Möller committed
116 117 118 119 120 121
    /// return the maximum of backups which are saved
    size_t maxBackups();

    /// set the maximum of saved backups
    void setMaxBackups(size_t _max);

Dirk Wilden's avatar
Dirk Wilden committed
122 123 124 125 126 127
  protected:
    std::vector< BaseBackup* > undoStates_;
    std::vector< BaseBackup* > redoStates_;
    BaseBackup* currentState_;

    BaseObjectData* object_;
Matthias Möller's avatar
Matthias Möller committed
128 129

    size_t maxBackups_;
Dirk Wilden's avatar
Dirk Wilden committed
130 131 132
};

#endif //BACKUPDATA_HH