Transaction.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2011 Jürgen Riegel <juergen.riegel@web.de>              *
 *   Copyright (c) 2011 Werner Mayer <wmayer[at]users.sourceforge.net>     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#pragma once

#include <unordered_map>
#include <Base/Factory.h>
#include <Base/Persistence.h>
#include <Core/PropertyContainer.h>
#include <Core/DynamicProperty.h>


namespace Core
{

class CoreDocument;
class Property;
class Transaction;
class TransactionObject;
class DocObject;
class TransactionP;

class LX_CORE_EXPORT Transaction : public Base::Persistence
{
    TYPESYSTEM_HEADER();

public:
    Transaction(int id = 0);
    virtual ~Transaction();

    void apply(CoreDocument &Doc,bool forward);

    // the utf-8 name of the transaction
    std::string Name;

    virtual void save(Base::AbstractWriter& /*writer*/, Base::PersistenceVersion& /*save_version*/);
    virtual void restore(Base::AbstractXMLReader& /*reader*/, Base::PersistenceVersion& /*version*/);

    int getID(void) const;

    static int getNewID(void);
    static int getLastID(void);

    bool isEmpty() const;
    bool hasObject(const Core::DocObject *Obj) const;
    void addOrRemoveProperty(Core::DocObject *Obj, const Property* pcProp, bool add);

    void addObjectNew(Core::DocObject *Obj);
    void addObjectDel(const Core::DocObject *Obj);
    void addObjectChange(const Core::DocObject *Obj, const Property *Prop);

private:
    int transID;
    std::unique_ptr<TransactionP> mPimpl;
};

class LX_CORE_EXPORT TransactionObject : public Base::Persistence
{
    TYPESYSTEM_HEADER();

public:
    TransactionObject();
    virtual ~TransactionObject();

    virtual void applyNew(CoreDocument &Doc, Core::DocObject *pcObj);
    virtual void applyDel(CoreDocument &Doc, Core::DocObject *pcObj);
    virtual void applyChn(CoreDocument &Doc, Core::DocObject *pcObj, bool Forward);

    void setProperty(const Property* pcProp);
    void addOrRemoveProperty(const Property* pcProp, bool add);

    virtual void save(Base::AbstractWriter& /*writer*/, Base::PersistenceVersion& /*save_version*/);
    virtual void restore(Base::AbstractXMLReader& /*reader*/, Base::PersistenceVersion& /*version*/);

    friend class Transaction;

protected:
    enum Status {New,Del,Chn} status;

#ifndef SWIG
    struct PropData : DynamicProperty::PropData {
        Base::Type propertyType;
    };
    std::unordered_map<const Property*, PropData> _PropChangeMap;
#endif
    std::string _NameInDocument;
};

class LX_CORE_EXPORT TransactionDocumentObject : public TransactionObject
{
    TYPESYSTEM_HEADER();

public:
    TransactionDocumentObject();
    virtual ~TransactionDocumentObject();

    void applyNew(CoreDocument &Doc, Core::DocObject *pcObj);
    void applyDel(CoreDocument &Doc, Core::DocObject *pcObj);
};

class LX_CORE_EXPORT TransactionFactory
{
public:
    static TransactionFactory& instance();
    static void destruct ();

    TransactionObject* createTransaction (const Base::Type& type) const;
    void addProducer (const Base::Type& type, Base::AbstractProducer *producer);

private:
    static TransactionFactory* self;
    std::map<Base::Type, Base::AbstractProducer*> producers;

    TransactionFactory(){}
    ~TransactionFactory(){}
};

template <class CLASS>
class TransactionProducer : public Base::AbstractProducer
{
public:
    TransactionProducer (const Base::Type& type)
    {
        TransactionFactory::instance().addProducer(type, this);
    }

    virtual ~TransactionProducer (){}

    virtual void* Produce () const
    {
        return (new CLASS);
    }
};

} //namespace Core