fix new netlist bug

Author: joern274

plugins/gui/include/gui/file_manager/file_manager.h

@@ -165,6 +165,10 @@ namespace hal
          */
         void importFile(QString filename);
 
+        /**
+         * Creates a new empty hal project
+         */
+        void newProject();
 
         /**
          * Opens the given project.

plugins/gui/include/gui/file_manager/new_project_dialog.h

@@ -0,0 +1,64 @@
+//  MIT License
+//
+//  Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
+//  Copyright (c) 2021 Max Planck Institute for Security and Privacy. 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 <QDialog>
+#include <QString>
+#include <QList>
+#include <QMap>
+
+class QComboBox;
+class QCheckBox;
+class QLineEdit;
+
+namespace hal {
+
+    class NewProjectDialog : public QDialog
+    {
+        Q_OBJECT
+        Q_PROPERTY(QString saveIconPath READ saveIconPath WRITE setSaveIconPath)
+        Q_PROPERTY(QString saveIconStyle READ saveIconStyle WRITE setSaveIconStyle)
+        QString mProjectdir;
+        QLineEdit* mEditProjectdir;
+        QComboBox* mComboGatelib;
+        QCheckBox* mCheckCopyGatelib;
+
+        QStringList mGateLibraryPath;
+        QMap<QString,int> mGateLibraryMap;
+        QString mSaveIconPath;
+        QString mSaveIconStyle;
+    private Q_SLOTS:
+        void handleGateLibraryPathChanged(const QString& txt);
+        void handleFileDialogTriggered();
+    public:
+        NewProjectDialog(QWidget* parent = nullptr);
+        QString projectDirectory() const;
+        QString gateLibraryPath() const;
+        bool isCopyGatelibChecked() const;
+        QString saveIconPath() const { return mSaveIconPath; }
+        QString saveIconStyle() const { return mSaveIconStyle; }
+        void setSaveIconPath(const QString& path) { mSaveIconPath = path; }
+        void setSaveIconStyle(const QString& sty) { mSaveIconStyle = sty; }
+    };
+}

plugins/gui/include/gui/user_action/action_open_netlist_file.h

@@ -34,15 +34,18 @@ namespace hal
      */
     class ActionOpenNetlistFile : public UserAction
     {
+    public:
+        enum OpenMethod { Undefined, CreateNew, ImportFile, OpenProject };
+    private:
         QString mFilename;
-        bool mProject;
+        OpenMethod mMethod;
     public:
         /**
          * Action constructor.
          *
          * @param filename_ - The path of the netlist file to open.
          */
-        ActionOpenNetlistFile(const QString& filename_ = QString(), bool isProj = true);
+        ActionOpenNetlistFile(OpenMethod method = Undefined, const QString& filename_ = QString());
         QString tagname() const override;
         bool exec() override;
         void writeToXml(QXmlStreamWriter& xmlOut) const override;

plugins/gui/include/gui/welcome_screen/recent_file_item.h

@@ -24,6 +24,7 @@
 #pragma once
 
 #include <QFrame>
+#include "gui/user_action/action_open_netlist_file.h"
 
 class QHBoxLayout;
 class QLabel;
@@ -149,7 +150,7 @@ namespace hal
 
         bool mHover;
         bool mMissing;
-        bool mProject;
+        ActionOpenNetlistFile::OpenMethod mMethod;
 
         QString mIconPath;
         QString mIconStyle;

plugins/gui/resources/stylesheet/dark.qss

@@ -896,6 +896,18 @@ hal--ImportNetlistDialog QWidget:disabled
     background: #2a2a2a;
 }
 
+hal--NewProjectDialog
+{
+    qproperty-saveIconStyle: "all->#3192C5";
+    qproperty-saveIconPath: ":/icons/folder-down";
+}
+
+hal--NewProjectDialog QWidget:disabled
+{
+    color: #777777;
+    background: #2a2a2a;
+}
+
 hal--GetInTouchWidget
 {
     background    : rgb(14, 16, 18);

plugins/gui/resources/stylesheet/light.qss

@@ -907,6 +907,30 @@ hal--OpenFileWidget #icon-label
     margin-top : 220px;
 }
 
+hal--ImportNetlistDialog
+{
+    qproperty-saveIconStyle: "all->#3192C5";
+    qproperty-saveIconPath: ":/icons/folder-down";
+}
+
+hal--ImportNetlistDialog QWidget:disabled
+{
+    color: #777777;
+    background: #2a2a2a;
+}
+
+hal--NewProjectDialog
+{
+    qproperty-saveIconStyle: "all->#3192C5";
+    qproperty-saveIconPath: ":/icons/folder-down";
+}
+
+hal--NewProjectDialog QWidget:disabled
+{
+    color: #777777;
+    background: #2a2a2a;
+}
+
 hal--GetInTouchWidget
 {
     background    : rgb(219, 219, 219);

plugins/gui/src/file_manager/file_manager.cpp

@@ -5,13 +5,14 @@
 #include "hal_core/netlist/netlist_factory.h"
 #include "hal_core/netlist/persistent/netlist_serializer.h"
 #include "hal_core/netlist/netlist_parser/netlist_parser_manager.h"
+#include "hal_core/netlist/gate_library/gate_library_manager.h"
 #include "hal_core/utilities/log.h"
 #include "hal_core/netlist/project_manager.h"
 #include "hal_core/utilities/project_directory.h"
-
 #include "gui/settings/settings_items/settings_item_checkbox.h"
 #include "gui/settings/settings_items/settings_item_spinbox.h"
 #include "gui/file_manager/import_netlist_dialog.h"
+#include "gui/file_manager/new_project_dialog.h"
 
 #include <QDateTime>
 #include <QFile>
@@ -191,6 +192,63 @@ namespace hal
 
     }
 
+    void FileManager::newProject()
+    {
+        NewProjectDialog npr(qApp->activeWindow());
+        if (npr.exec() != QDialog::Accepted) return;
+
+        QString projdir = npr.projectDirectory();
+        if (projdir.isEmpty()) return;
+
+        QString gatelib = npr.gateLibraryPath();
+        if (gatelib.isEmpty())
+        {
+            QMessageBox::warning(qApp->activeWindow(),"Aborted", "Cannot create project <" + projdir + ">, no gate library selected");
+            return;
+        }
+        GateLibrary* glib = gate_library_manager::load(gatelib.toStdString());
+        if (!glib)
+        {
+            QMessageBox::warning(qApp->activeWindow(),"Aborted", "Cannot create project <" + projdir + ">, cannot load gate library <" + gatelib + ">");
+            return;
+        }
+
+        ProjectManager* pm = ProjectManager::instance();
+        if (!pm->create_project_directory(projdir.toStdString()))
+        {
+            QMessageBox::warning(qApp->activeWindow(),"Aborted", "Error creating project directory <" + projdir + ">");
+            return;
+        }
+
+        QDir projectDir(projdir);
+        QString netlistFilename = QString::fromStdString(pm->get_netlist_filename());
+        if (npr.isCopyGatelibChecked())
+        {
+            QFileInfo glInfo(gatelib);
+            QString targetGateLib = projectDir.absoluteFilePath(glInfo.fileName());
+            if (QFile::copy(gatelib,targetGateLib))
+                gatelib = targetGateLib;
+        }
+
+        std::filesystem::path lpath = pm->get_project_directory().get_default_filename(".log");
+        LogManager::get_instance()->set_file_name(lpath);
+
+        gNetlistOwner = netlist_factory::create_netlist(glib);
+        gNetlist = gNetlistOwner.get();
+
+        if (!gNetlist)
+        {
+            QMessageBox::warning(qApp->activeWindow(),"Aborted", "Failed to create <" + projdir + "> with gate library <" + gatelib + ">");
+            return;
+        }
+        gNetlistRelay->registerNetlistCallbacks();
+        gFileStatusManager->netlistChanged();
+        if (pm->serialize_project(gNetlist))
+            gFileStatusManager->netlistSaved();
+        projectSuccessfullyLoaded(projdir,netlistFilename);
+        log_info("gui", "Created empty project '{}' with gate library '{}'.", projdir.toStdString(), gatelib.toStdString());
+    }
+
     void FileManager::importFile(QString filename)
     {
         // check whether there is already a project with the same name as file-to-be-imported

plugins/gui/src/file_manager/import_netlist_dialog.cpp

@@ -20,10 +20,6 @@
 #include <QRegularExpression>
 #include <QSpacerItem>
 
-QLineEdit* mEditProjectdir;
-QComboBox* mComboGatelib;
-QCheckBox* mCheckMoveNetlist;
-
 namespace hal
 {
     ImportNetlistDialog::ImportNetlistDialog(const QString& filename, QWidget* parent) : QDialog(parent)

plugins/gui/src/file_manager/new_project_dialog.cpp

@@ -0,0 +1,143 @@
+#include "gui/file_manager/new_project_dialog.h"
+
+#include "gui/gui_utils/graphics.h"
+#include "hal_core/netlist/gate_library/gate_library.h"
+#include "hal_core/netlist/gate_library/gate_library_manager.h"
+
+#include <QCheckBox>
+#include <QComboBox>
+#include <QDebug>
+#include <QDialogButtonBox>
+#include <QFile>
+#include <QFileDialog>
+#include <QFileInfo>
+#include <QGridLayout>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QLabel>
+#include <QLineEdit>
+#include <QPushButton>
+#include <QRegularExpression>
+#include <QSpacerItem>
+#include <QDir>
+
+QLineEdit* mEditProjectdir;
+QComboBox* mComboGatelib;
+
+namespace hal
+{
+    NewProjectDialog::NewProjectDialog(QWidget* parent) : QDialog(parent)
+    {
+        QStyle* s = style();
+        s->unpolish(this);
+        s->polish(this);
+        QString suggestedGateLibraryPath;
+        QString suggestedGateLibraryName;
+
+        int suggestedProjectCount = 0;
+        do {
+            ++ suggestedProjectCount;
+            mProjectdir = QDir::current().absoluteFilePath(QString("hal_project_%1").arg(suggestedProjectCount));
+        } while (QFileInfo(mProjectdir).exists());
+
+        int irow            = 0;
+        QGridLayout* layout = new QGridLayout(this);
+        setWindowTitle("Netlist Import");
+        layout->addWidget(new QLabel("Create new empty HAL project:", this), irow++, 0, Qt::AlignLeft);
+        layout->addItem(new QSpacerItem(30, 30), irow++, 0);
+        layout->setRowStretch(irow - 1, 20);
+
+        layout->addWidget(new QLabel("Location of project directory:", this), irow++, 0, Qt::AlignLeft);
+        QFrame* frameProjectdir    = new QFrame(this);
+        QHBoxLayout* layProjectdir = new QHBoxLayout(frameProjectdir);
+        mEditProjectdir            = new QLineEdit(mProjectdir, frameProjectdir);
+        layProjectdir->addWidget(mEditProjectdir);
+        QPushButton* butFiledialog = new QPushButton(gui_utility::getStyledSvgIcon(mSaveIconStyle, mSaveIconPath), "", frameProjectdir);
+        connect(butFiledialog, &QPushButton::clicked, this, &NewProjectDialog::handleFileDialogTriggered);
+        layProjectdir->addWidget(butFiledialog);
+        mEditProjectdir->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
+        layout->addWidget(frameProjectdir, irow++, 0);
+        layout->addItem(new QSpacerItem(30, 30), irow++, 0);
+
+        QLabel* labGatelib = new QLabel("Gate library:", this);
+        layout->addWidget(labGatelib, irow++, 0, Qt::AlignLeft);
+        mComboGatelib = new QComboBox(this);
+        mComboGatelib->addItem(QString());
+        for (const std::filesystem::path path : gate_library_manager::get_all_path())
+        {
+            int n         = mGateLibraryPath.size();
+            QString qName = QString::fromStdString(path.filename());
+            mGateLibraryMap.insert(qName, n);
+            QString qPath = QString::fromStdString(path.string());
+            mGateLibraryPath.append(qPath);
+            if (qPath == suggestedGateLibraryPath)
+                suggestedGateLibraryName = qName;
+        }
+        if (suggestedGateLibraryName.isEmpty() && !suggestedGateLibraryPath.isEmpty())
+        {
+            // suggested gate library not found in default path
+            QFileInfo info(suggestedGateLibraryPath);
+            suggestedGateLibraryName = info.fileName();
+            int n                    = mGateLibraryPath.size();
+            mGateLibraryMap.insert(suggestedGateLibraryName, n);
+            mGateLibraryPath.append(suggestedGateLibraryPath);
+        }
+        mComboGatelib->addItems(mGateLibraryMap.keys());
+        if (!suggestedGateLibraryName.isEmpty())
+            mComboGatelib->setCurrentText(suggestedGateLibraryName);
+
+        mComboGatelib->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
+        layout->addWidget(mComboGatelib, irow++, 0);
+
+        layout->addItem(new QSpacerItem(30, 30), irow++, 0);
+        layout->setRowStretch(irow - 1, 20);
+        mCheckCopyGatelib = new QCheckBox("Copy gate library into project directory");
+        layout->addWidget(mCheckCopyGatelib, irow++, 0, Qt::AlignLeft);
+        layout->addItem(new QSpacerItem(30, 30), irow++, 0);
+        layout->setRowStretch(irow - 1, 100);
+        QDialogButtonBox* dbb = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel, Qt::Horizontal, this);
+        connect(dbb, &QDialogButtonBox::accepted, this, &QDialog::accept);
+        connect(dbb, &QDialogButtonBox::rejected, this, &QDialog::reject);
+        layout->addWidget(dbb, irow++, 0, Qt::AlignRight);
+        connect(mComboGatelib, &QComboBox::currentTextChanged, this, &NewProjectDialog::handleGateLibraryPathChanged);
+        handleGateLibraryPathChanged(mComboGatelib->currentText());
+    }
+
+    QString NewProjectDialog::projectDirectory() const
+    {
+        return mEditProjectdir->text();
+    }
+
+    void NewProjectDialog::handleFileDialogTriggered()
+    {
+        QString dir = QFileDialog::getSaveFileName(this, "Enter new project directory", QFileInfo(mProjectdir).path(), "", nullptr, QFileDialog::ShowDirsOnly);
+        if (dir.isEmpty())
+            return;
+        mEditProjectdir->setText(dir);
+    }
+
+    void NewProjectDialog::handleGateLibraryPathChanged(const QString& txt)
+    {
+        if (mGateLibraryMap.value(txt, -1) < 0)
+        {
+            mCheckCopyGatelib->setCheckState(Qt::Unchecked);
+            mCheckCopyGatelib->setDisabled(true);
+        }
+        else
+            mCheckCopyGatelib->setEnabled(true);
+    }
+
+    QString NewProjectDialog::gateLibraryPath() const
+    {
+        QString seltxt = mComboGatelib->currentText();
+        int inx        = mGateLibraryMap.value(seltxt, -1);
+        if (inx < 0)
+            return QString();
+        return mGateLibraryPath.at(inx);
+    }
+
+    bool NewProjectDialog::isCopyGatelibChecked() const
+    {
+        return mCheckCopyGatelib->isChecked();
+    }
+}    // namespace hal