Reversible.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2020 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
 
/**
 * @file Reversible.hh
 * Declaration of Reversible class; Framework for operations that contain
 * undo infromation and can be recursively reverted.
 */
 
#ifndef TTA_REVERSIBLE_HH
#define TTA_REVERSIBLE_HH
 
#include <stack>
 
class Reversible {
public:
    /** This performs the operation. Returns true if success, false if fail. */
    virtual bool operator()() = 0;
    virtual void undo();
    virtual ~Reversible();
    void deleteChildren(std::stack<Reversible*>& children);
    int id() { return id_; }
    Reversible() : id_(idCounter_++) {}
protected:
    bool runPreChild(Reversible *preChild);
    bool runPostChild(Reversible *preChild);
    bool runChild(std::stack<Reversible*>& children, Reversible* child);
    bool runChild(Reversible* child, bool pre);
 
    void undoAndRemovePreChildren();
    void undoAndRemovePostChildren();
    void undoAndRemoveChildren(std::stack<Reversible*>& children);
    virtual void undoOnlyMe();
 
    // normally no need to touch these directly, only through the helpers.
    std::stack<Reversible*> preChildren_;
    std::stack<Reversible*> postChildren_;
 
private:
    int id_;
    static int idCounter_;
};
 
#endif