main_window.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/action/action.h"
#include "gui/content_layout_area/content_layout_area.h"
#include "gui/settings/main_settings_widget.h"
#include "gui/splitter/splitter.h"
#include "hal_core/netlist/module.h"
#include "hal_core/utilities/program_options.h"
 
#include <QLayout>
#include <QMenuBar>
#include <QObject>
#include <QSplitter>
#include <QStackedWidget>
#include <QToolBar>
#include <gui/gatelibrary_management/gatelibrary_manager.h>
 
namespace hal
{
    class plugin_manager_dialog;
    class PythonEditor;
    class FileManager;
    class FileActions;
    class ContentManager;
    class WelcomeScreen;
    class SettingsItemKeybind;
    class SettingsItemDropdown;
    class GuiPluginManager;
 
    class MainWindow : public QWidget
    {
        Q_OBJECT
        Q_PROPERTY(QString halIconPath READ halIconPath WRITE setHalIconPath)
        Q_PROPERTY(QString halIconStyle READ halIconStyle WRITE setHalIconStyle)
 
        Q_PROPERTY(QString openFileIconPath READ openFileIconPath WRITE setOpenFileIconPath)
        Q_PROPERTY(QString openFileIconStyle READ openFileIconStyle WRITE setOpenFileIconStyle)
        Q_PROPERTY(QString quitIconPath READ quitIconPath WRITE setQuitIconPath)
        Q_PROPERTY(QString quitIconStyle READ quitIconStyle WRITE setQuitIconStyle)
        Q_PROPERTY(QString settingsIconPath READ settingsIconPath WRITE setSettingsIconPath)
        Q_PROPERTY(QString settingsIconStyle READ settingsIconStyle WRITE setSettingsIconStyle)
        Q_PROPERTY(QString pluginsIconPath READ pluginsIconPath WRITE setPluginsIconPath)
        Q_PROPERTY(QString pluginsIconStyle READ pluginsIconStyle WRITE setPluginsIconStyle)
        Q_PROPERTY(QString undoIconPath READ undoIconPath WRITE setUndoIconPath)
        Q_PROPERTY(QString undoIconStyle READ undoIconStyle WRITE setUndoIconStyle)
        Q_PROPERTY(QString disabledIconStyle READ disabledIconStyle WRITE setDisabledIconStyle)
        Q_PROPERTY(QString neGateIconPath READ neGateIconPath WRITE setNeGateIconPath)
        Q_PROPERTY(QString neGateIconStyle READ neGateIconStyle WRITE setNeGateIconStyle)
 
    public:
        enum StyleSheetOption {Dark, Light};
        Q_ENUM(StyleSheetOption)
        
        
        explicit MainWindow(QWidget* parent = nullptr);
 
 
        // =====================================================================
        //   Q_PROPERTY functions
        // =====================================================================
 
        QString halIconPath() const;
        QString halIconStyle() const;
 
        QString openFileIconPath() const;
        QString openFileIconStyle() const;
 
        QString quitIconPath() const;
        QString quitIconStyle() const;
 
        QString settingsIconPath() const;
        QString settingsIconStyle() const;
 
        QString pluginsIconPath() const;
        QString pluginsIconStyle() const;
 
        QString undoIconPath() const;
        QString undoIconStyle() const;
        QString disabledIconStyle() const;
        QString neGateIconPath() const;
        QString neGateIconStyle() const;
 
        void setHalIconPath(const QString& path);
        void setHalIconStyle(const QString &style);
 
        void setOpenFileIconPath(const QString& path);
        void setOpenFileIconStyle(const QString& style);
 
        void setQuitIconPath(const QString& path);
        void setQuitIconStyle(const QString& style);
 
        void setScheduleIconPath(const QString& path);
        void setScheduleIconStyle(const QString& style);
 
        void setRunIconPath(const QString& path);
        void setRunIconStyle(const QString& style);
 
        void setContentIconPath(const QString& path);
        void setContentIconStyle(const QString& style);
 
        void setSettingsIconPath(const QString& path);
        void setSettingsIconStyle(const QString& style);
 
        void setPluginsIconPath(const QString& path);
        void setPluginsIconStyle(const QString& style);
 
        void setUndoIconPath(const QString& path);
        void setUndoIconStyle(const QString& style);
        void setDisabledIconStyle(const QString &style);
        void setNeGateIconPath(const QString &path);
        void setNeGateIconStyle(const QString &style);
 
        void addContent(ContentWidget* widget, int index, ContentLayout::Position anchor);
 
        void removeContent(ContentWidget* widget);
 
        void clear();
 
        static SettingsItemDropdown* sSettingStyle;
 
    public Q_SLOTS:
        void onActionQuitTriggered();
 
        void onActionCloseDocumentTriggered();
 
        void openSettings();
 
        void closeSettings();
 
        void closeGateLibraryManager();
 
        void openPluginManager();
 
        void closePluginManager();
 
        void handleActionNew();
 
        void handleActionImportNetlist();
 
        void handleActionOpenProject();
 
        void handleFileOpened(const QString& fileName);
 
        void handleProjectOpened(const QString& projDir, const QString& fileName);
 
        void handleSaveTriggered();
 
        void handleSaveAsTriggered();
 
        void handleActionCloseFile();
 
        void handleActionStartRecording();
 
        void handleActionStopRecording();
 
        void handleActionPlayMacro();
 
        void handleActionUndo();
 
        void handleActionAbout();
 
        void handleActionExport();
 
        void handleActionGatelibraryManager();
 
        void enableUndo(bool enable=true);
 
        void reloadStylsheet(int istyle);
 
        ContentLayoutArea* layoutArea() const;
 
    private Q_SLOTS:
        void handleEventLogEnabled(bool enable);
 
        void handleExportProjectTriggered();
 
        void handleImportProjectTriggered();
 
    private:
        void closeEvent(QCloseEvent* event);
 
        bool tryToCloseFile();
 
        QString saveHandler(const QString& projectDir = QString());
 
        void restoreState();
 
        void saveState();
 
        QVBoxLayout* mLayout;
        QMenuBar* mMenuBar;
        QStackedWidget* mStackedWidget;
 
        MainSettingsWidget* mSettings;
        GuiPluginManager* mPluginManager;
        WelcomeScreen* mWelcomeScreen;
        GateLibraryManager* mGateLibraryManager;
        QHBoxLayout* mToolBarLayout;
        QToolBar* mLeftToolBar;
        QToolBar* mRightToolBar;
        ContentLayoutArea* mLayoutArea;
 
        FileActions* mFileActions;
        Action* mActionImportNetlist;
        Action* mActionGateLibraryManager;
        Action* mActionAbout;
        Action* mActionStartRecording;
        Action* mActionStopRecording;
        Action* mActionPlayMacro;
        Action* mActionUndo;
        Action* mActionExportProject;
        Action* mActionImportProject;
 
        Action* mActionSettings;
        Action* mActionPluginManager;
        Action* mActionQuit;
 
        QMenu* mMenuFile;
        QMenu* mMenuEdit;
        QMenu* mMenuMacro;
        QMenu* mMenuUtilities;
        QMenu* mMenuPlugins;
        QMenu* mMenuHelp;
 
        QString mHalIconStyle;
        QString mHalIconPath;
 
        QString mOpenFileIconPath;
        QString mOpenFileIconStyle;
 
        QString mQuitIconPath;
        QString mQuitIconStyle;
 
        QString mSettingsIconPath;
        QString mSettingsIconStyle;
        
        QString mPluginsIconPath;
        QString mPluginsIconStyle;
 
        QString mUndoIconPath;
        QString mUndoIconStyle;
 
        QString mDisabledIconStyle;
 
        QString mNeGateIconPath;
        QString mNeGateIconStyle;
 
        SettingsItemKeybind* mSettingUndoLast;
 
    };
}