user_action.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// 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.
 
#pragma once
#include <QString>
#include <QCryptographicHash>
#include "user_action_manager.h"
#include "user_action_object.h"
 
namespace hal
{
    class UserAction
    {
    public:
 
        virtual ~UserAction();
 
        virtual bool exec();
 
        virtual QString tagname() const = 0;
 
        virtual void writeToXml(QXmlStreamWriter& xmlOut) const;
 
        virtual void readFromXml(QXmlStreamReader& xmlIn);
 
        virtual UserActionObject object() const { return mObject; }
 
        virtual void setObject(const UserActionObject& obj);
 
        int compoundOrder() const { return mCompoundOrder; }
 
        void setCompoundOrder(int cmpord) { mCompoundOrder = cmpord; }
 
        qint64 timeStamp() const { return mTimeStamp; }
 
        QString cryptographicHash(int recordNo) const;
 
        virtual void addToHash(QCryptographicHash& cryptoHash) const;
 
        UserAction* undoAction() const { return mUndoAction; }
 
        QString debugDump() const;
 
        void setObjectLock(bool lock) { mObjectLock = lock; }
 
        void setParentObjectLock(bool lock) {mParentObjectLock = lock;}
 
        bool hasProjectModified() const { return mProjectModified; }
 
    protected:
        UserAction();
        UserActionObject mObject;
        UserActionObject mParentObject;
        int mCompoundOrder;
        UserAction *mUndoAction;
        qint64 mTimeStamp;
        bool mObjectLock;
        bool mParentObjectLock;
        bool mProjectModified;
 
        static QString setToText(const QSet<u32>& set);
        static QSet<u32> setFromText(const QString& s);
 
        static QString gridToText(const QHash<hal::Node,QPoint>& grid);
        static QHash<hal::Node,QPoint> gridFromText(const QString& txt);
 
        void writeParentObjectToXml(QXmlStreamWriter& xmlOut) const;
 
        void readParentObjectFromXml(QXmlStreamReader& xmlIn);
    };
 
    class UserActionFactory
    {
    protected:
        QString mTagname;
    public:
 
        UserActionFactory(const QString& nam);
 
        QString tagname() const { return mTagname; }
 
        virtual UserAction* newAction() const = 0;
    };
}