[feature/multi-output-luts_parameter-tab] Changes in the parameter table are now also saved in the gate

Author: AriKHaji

plugins/gui/include/gui/user_action/action_set_parameter_value.h

@@ -0,0 +1,74 @@
+// 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 "user_action.h"
+
+namespace hal
+{
+    /**
+     * @ingroup user_action
+     * @brief Sets the value of an existing typed parameter on a gate.
+     *
+     * Unlike ActionSetObjectData, a gate's parameters are fixed by its type: they can only
+     * be modified, never created, deleted or moved. This action therefore only carries the
+     * parameter name and the new value; the target gate is identified by the inherited mObject.
+     *
+     * The inverse of "set parameter <name> to <value>" is another ActionSetParameterValue that
+     * restores the previous value, so exec() builds its own undo action of the same type.
+     */
+    class ActionSetParameterValue : public UserAction
+    {
+    public:
+        /**
+         * Constructor.
+         *
+         * @param parameterName - The name of the parameter to modify.
+         * @param value - The new value, formatted as the core expects it for the parameter's type.
+         */
+        ActionSetParameterValue(const QString& parameterName = QString(), const QString& value = QString());
+
+        bool exec() override;
+        QString tagname() const override;
+        void writeToXml(QXmlStreamWriter& xmlOut) const override;
+        void readFromXml(QXmlStreamReader& xmlIn) override;
+        void addToHash(QCryptographicHash& cryptoHash) const override;
+
+    private:
+        QString mParameterName;
+        QString mValue;
+    };
+
+    /**
+     * @brief The ActionSetParameterValueFactory class registers the action with the manager.
+     */
+    class ActionSetParameterValueFactory : public UserActionFactory
+    {
+    public:
+        ActionSetParameterValueFactory();
+        UserAction* newAction() const override;
+        static ActionSetParameterValueFactory* sFactory;
+    };
+}    // namespace hal

plugins/gui/src/selection_details_widget/gate_details_tab_widget.cpp

@@ -140,6 +140,7 @@ namespace hal
             GateDetailsTabWidget::GateTypeCategory gateTypeCategory = getGateTypeCategory(g);
             setupBooleanFunctionTables(g, gateTypeCategory);
             mDataTable->setGate(g);
+            mParameterTable->setGate(g);
         }
     }
 

plugins/gui/src/selection_details_widget/gate_details_widget/parameter_table_model.cpp

@@ -1,5 +1,6 @@
 #include "gui/selection_details_widget/gate_details_widget/parameter_table_model.h"
 
+#include "gui/user_action/action_set_parameter_value.h"
 #include "hal_core/netlist/gate.h"
 #include "hal_core/utilities/enums.h"
 
@@ -104,25 +105,9 @@ namespace hal
             return false;
         }
 
-        const std::string name = mRows[index.row()].name.toStdString();
-
-        Result<Parameter> param = this->mGate->get_parameter_declaration(name);
-        if (param.is_error())
-        {
-            return false;
-        }
-
-        Result<std::monostate> result = this->mGate->set_parameter(param.get(), value.toString().toStdString());
-        if (result.is_error())
-        {
-            return false;
-        }
-
-        std::string norm_value = this->mGate->get_parameter_value(name).get();
-        this->mRows[index.row()].value = QString::fromStdString(norm_value);
-
-        Q_EMIT dataChanged(index, index);
-        return true;
+        auto act = new ActionSetParameterValue(mRows[index.row()].name, value.toString());
+        act->setObject(UserActionObject(mGate->get_id(), UserActionObjectType::Gate));
+        return act->exec();
     }
 
     Qt::ItemFlags ParameterTableModel::flags(const QModelIndex& index) const

plugins/gui/src/user_action/action_set_parameter_value.cpp

@@ -0,0 +1,99 @@
+#include "gui/user_action/action_set_parameter_value.h"
+
+#include "gui/gui_globals.h"
+#include "gui/netlist_relay/netlist_relay.h"
+#include "hal_core/netlist/gate.h"
+
+namespace hal
+{
+    ActionSetParameterValueFactory::ActionSetParameterValueFactory() : UserActionFactory("SetParameterValue")
+    {
+    }
+    ActionSetParameterValueFactory* ActionSetParameterValueFactory::sFactory = new ActionSetParameterValueFactory;
+
+    UserAction* ActionSetParameterValueFactory::newAction() const
+    {
+        return new ActionSetParameterValue;
+    }
+
+    ActionSetParameterValue::ActionSetParameterValue(const QString& parameterName, const QString& value) : mParameterName(parameterName), mValue(value)
+    {
+    }
+
+    bool ActionSetParameterValue::exec()
+    {
+        if (mObject.type() != UserActionObjectType::Gate)
+        {
+            return false;
+        }
+
+        // Resolve the gate.
+        Gate* gate = gNetlist->get_gate_by_id(mObject.id());
+        if (!gate)
+        {
+            return false;
+        }
+
+        // Capture the current value BEFORE mutating, for the undo action:
+        Result<std::string> old = gate->get_parameter_value(mParameterName.toStdString());
+        if (old.is_error())
+        {
+            return false;
+        }
+
+        // Build the inverse action and store it in mUndoAction:
+        auto* undo = new ActionSetParameterValue(mParameterName, QString::fromStdString(old.get()));
+        undo->setObject(mObject);
+        mUndoAction = undo;
+
+        // Perform the mutation
+        Result<Parameter> decl = gate->get_parameter_declaration(mParameterName.toStdString());
+        if (decl.is_error())
+        {
+            return false;
+        }
+
+        auto result = gate->set_parameter(decl.get(), mValue.toStdString());
+        if (result.is_error())
+        {
+            return false;
+        }
+
+        Q_EMIT gNetlistRelay->gateBooleanFunctionChanged(gate);
+        return UserAction::exec();
+    }
+
+    QString ActionSetParameterValue::tagname() const
+    {
+        return ActionSetParameterValueFactory::sFactory->tagname();
+    }
+
+    void ActionSetParameterValue::writeToXml(QXmlStreamWriter& xmlOut) const
+    {
+        xmlOut.writeTextElement("name", mParameterName);
+        xmlOut.writeTextElement("value", mValue);
+    }
+
+    void ActionSetParameterValue::readFromXml(QXmlStreamReader& xmlIn)
+    {
+        while (xmlIn.readNextStartElement())
+        {
+            if (xmlIn.name() == "name")
+            {
+                mParameterName = xmlIn.readElementText();
+            }
+            else if (xmlIn.name() == "value")
+            {
+                mValue = xmlIn.readElementText();
+            }
+        }
+    }
+
+    void ActionSetParameterValue::addToHash(QCryptographicHash& cryptoHash) const
+    {
+        cryptoHash.addData("name", 4);
+        cryptoHash.addData(mParameterName.toUtf8());
+        cryptoHash.addData("value", 5);
+        cryptoHash.addData(mValue.toUtf8());
+    }
+}    // namespace hal