user_action_object.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 "gui/gui_def.h"
#include "gui/selection_relay/selection_relay.h"
#include "hal_core/defines.h"
 
#include <QObject>
#include <QXmlStreamReader>
#include <QXmlStreamWriter>
 
namespace hal
{
    class UserActionObjectType : public QObject
    {
        Q_OBJECT
    public:
        enum ObjectType
        {
            None,
            Module,
            Gate,
            Net,
            Grouping,
            Netlist,
            ContextView,
            ContextDir,
            MaxObjectType
        };
        Q_ENUM(ObjectType)
 
        static ObjectType fromString(const QString& s);
        static QString toString(ObjectType t);
        static ObjectType fromSelectionType(SelectionRelay::ItemType itp);
        static SelectionRelay::ItemType toSelectionType(ObjectType t);
        static ObjectType fromHalType(hal::ItemType itp);
        static hal::ItemType toHalType(ObjectType t);
        static ObjectType fromNodeType(Node::NodeType ntp);
        static Node::NodeType toNodeType(ObjectType t);
    };
 
    class UserActionObject
    {
    public:
        UserActionObject(u32 i = 0, UserActionObjectType::ObjectType t = UserActionObjectType::None) : mId(i), mType(t)
        {
            ;
        }
 
        u32 id() const
        {
            return mId;
        }
 
        UserActionObjectType::ObjectType type() const
        {
            return mType;
        }
 
        void writeToXml(QXmlStreamWriter& xmlOut) const;
 
        void readFromXml(QXmlStreamReader& xmlIn);
 
        QString debugDump() const;
 
    private:
        u32 mId;
        UserActionObjectType::ObjectType mType;
    };
 
}    // namespace hal