content_manager.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 <QGraphicsScene>
#include <QObject>
#include <QStringList>
#include <QMap>
 
#include "gui/gui_utils/special_log_content_manager.h"
#include "gui/content_widget/content_widget.h"
#include "gui/content_anchor/content_anchor.h"
#include "hal_config.h"
 
namespace hal
{
    class MainWindow;
    class ContentWidget;
    class PythonConsoleWidget;
    class PythonEditor;
    class GraphTabWidget;
    class GraphContext;
    class GroupingManagerWidget;
    class ContextManagerWidget;
    class SelectionDetailsWidget;
    class ModuleWidget;
    class LoggerWidget;
    class SettingsItemDropdown;
    class SettingsItemKeybind;
    class GraphContextSerializer;
 
    class ExternalContentWidget;
 
    class ContentFactory
    {
        QString mPluginName;
    public:
        ContentFactory(const QString& nam=QString()) : mPluginName(nam) {;}
        QString name() const {return mPluginName; }
        virtual ExternalContentWidget* contentFactory() const = 0;
    };
 
    struct ContentWidgetPlacement {
        ContentWidget* widget;
        int index;
        ContentLayout::Position anchorPos;
        bool visible;
    };
 
    class ExternalContent : public QList<ContentFactory*>
    {
        static ExternalContent* inst;
        ExternalContent() {;}
    public:
        static ExternalContent* instance();
        void removePlugin(const QString& pluginName);
        QMap<QString,ExternalContentWidget*> openWidgets;
    };
 
    class ExternalContentWidget : public ContentWidget
    {
        Q_OBJECT
        QString mPluginName;
    public:
        ExternalContentWidget(const QString& pluginName, const QString& windowName, QWidget* parent=nullptr);
        virtual ~ExternalContentWidget();
        QString pluginName() const { return mPluginName; }
    };
 
    class ContentManager : public QObject
    {
        Q_OBJECT
 
    public:
        explicit ContentManager(MainWindow* parent);       
        ~ContentManager();
 
        void deleteContent();
 
        PythonEditor* getPythonEditorWidget();
 
        GraphTabWidget* getGraphTabWidget();
 
        ContextManagerWidget* getContextManagerWidget();
 
        SelectionDetailsWidget* getSelectionDetailsWidget();
 
        GroupingManagerWidget* getGroupingManagerWidget();
 
        ModuleWidget* getModuleWidget();
 
        void setWindowTitle(const QString& filename);
 
    public Q_SLOTS:
 
        void handleOpenDocument(const QString& fileName);
 
    public:
        static SettingsItemKeybind* sSettingSearch;
        static SettingsItemKeybind* sSettingDeleteItem;
        void addExternalWidget(ContentFactory* factory);
 
    private:
        MainWindow* mMainWindow;
        QString mWindowTitle;
 
        PythonConsoleWidget* mPythonConsoleWidget;
        PythonEditor* mPythonWidget;
        GraphTabWidget* mGraphTabWidget;
        ModuleWidget* mModuleWidget;
        ContextManagerWidget* mContextManagerWidget;
        GroupingManagerWidget* mGroupingManagerWidget;
        SelectionDetailsWidget* mSelectionDetailsWidget;
        LoggerWidget* mLoggerWidget;
        GraphContextSerializer *mContextSerializer;
 
        GraphContext* topModuleContextFactory();
        static SettingsItemDropdown* sSettingSortMechanism;
        static bool sSettingsInitialized;
        static bool initializeSettings();
 
#ifdef HAL_STUDY
        SpecialLogContentManager* mSpecialLogContentManager;
#endif
    };
}