python_editor.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/code_editor/code_editor.h"
#include "gui/content_widget/content_widget.h"
#include "gui/file_modified_bar/file_modified_bar.h"
#include "gui/python/python_context_subscriber.h"
 
#include "hal_core/netlist/project_serializer.h"
#include "hal_core/utilities/json_write_document.h"
 
#include <QEvent>
#include <QFileSystemWatcher>
#include <QMap>
#include <QMessageBox>
#include <QPushButton>
#include <QtCore/QFileInfo>
#include <filesystem>
 
class QVBoxLayout;
class QTabWidget;
 
namespace hal
{
    class CodeEditor;
    class Searchbar;
    class Splitter;
    class Toolbar;
 
    class PythonCodeEditor;
 
    class SettingsItemCheckbox;
    class SettingsItemKeybind;
    class SettingsItemSpinbox;
 
    class PythonSerializer : public ProjectSerializer
    {
        struct PythonEditorControlEntry {
            int tabInx;
            bool active;
            std::string restore;
            std::string filename;
        };
 
        QString mSaveDir;
 
        void restoreTabs(const std::filesystem::path& loaddir, const std::string& jsonfile);
 
        static bool write_control_file(const std::filesystem::path& savedir, const std::vector<PythonEditorControlEntry>& tabinfo);
    public:
        PythonSerializer();
 
        std::string serialize(Netlist* netlist, const std::filesystem::path& savedir, bool isAutosave);
 
        void deserialize(Netlist* netlist, const std::filesystem::path& loaddir);
 
        QString getDirectory() const;
 
        std::string serialize_control(const std::filesystem::path& savedir = std::filesystem::path(), bool isAutosave = false);
 
        static QString sPythonRelDir;
        static std::string sControlFileName;
 
    };
 
    class PythonEditor : public ContentWidget, public PythonContextSubscriber
    {
        Q_OBJECT
        Q_PROPERTY(QString disabledIconStyle READ disabledIconStyle WRITE setDisabledIconStyle)
        Q_PROPERTY(QString openIconPath READ openIconPath WRITE setOpenIconPath)
        Q_PROPERTY(QString openIconStyle READ openIconStyle WRITE setOpenIconStyle)
        Q_PROPERTY(QString saveIconPath READ saveIconPath WRITE setSaveIconPath)
        Q_PROPERTY(QString saveIconStyle READ saveIconStyle WRITE setSaveIconStyle)
        Q_PROPERTY(QString saveAsIconPath READ saveAsIconPath WRITE setSaveAsIconPath)
        Q_PROPERTY(QString saveAsIconStyle READ saveAsIconStyle WRITE setSaveAsIconStyle)
        Q_PROPERTY(QString runIconPath READ runIconPath WRITE setRunIconPath)
        Q_PROPERTY(QString runIconStyle READ runIconStyle WRITE setRunIconStyle)
        Q_PROPERTY(QString newFileIconPath READ newFileIconPath WRITE setNewFileIconPath)
        Q_PROPERTY(QString newFileIconStyle READ newFileIconStyle WRITE setNewFileIconStyle)
        Q_PROPERTY(QString toggleMinimapIconPath READ toggleMinimapIconPath WRITE setToggleMinimapIconPath)
        Q_PROPERTY(QString toggleMinimapIconStyle READ toggleMinimapIconStyle WRITE setToggleMinimapIconStyle)
        Q_PROPERTY(QString searchIconPath READ searchIconPath WRITE setSearchIconPath)
        Q_PROPERTY(QString searchIconStyle READ searchIconStyle WRITE setSearchIconStyle)
        Q_PROPERTY(QString searchActiveIconStyle READ searchActiveIconStyle WRITE setSearchActiveIconStyle)
 
    public:
        explicit PythonEditor(QWidget* parent = nullptr);
        ~PythonEditor();
 
        enum QueryFilenamePolicy { GenericName, QueryIfEmpty, QueryAlways };
 
        virtual void setupToolbar(Toolbar* Toolbar) override;
 
        virtual QList<QShortcut*> createShortcuts() override;
 
        virtual void handleStdout(const QString& output) override;
 
        virtual void handleError(const QString& output) override;
 
        virtual void clear() override;
 
        void handleActionOpenFile();
 
        void handleActionSaveFile();
 
        void handleActionSaveFileAs();
 
        void handleActionRun();
 
        void handleActionNewTab();
 
        void handleActionTabMenu();
 
        void handleActionCloseTab();
 
        void handleActionCloseAllTabs();
 
        void handleActionCloseOtherTabs();
 
        void handleActionCloseLeftTabs();
 
        void handleActionCloseRightTabs();
 
        void handleActionShowFile();
 
        void tabLoadFile(u32 index, QString fileName);
 
        //added so that the speciallogcontentmanager has access to all the code editors
        QTabWidget* getTabWidget();
 
        bool saveFile(bool isAutosave, QueryFilenamePolicy queryPolicy, int index = -1);
 
        void saveAllTabs(const QString& genericPath, bool isAutosave);
 
        void saveControl();
 
        QString unnamedFilename(int index) const;
 
        QString autosaveFilename(int index);
 
        void discardTab(int index);
 
        bool confirmDiscardForRange(int start, int end, int exclude = -1);
 
        void setToolbarButtonsEnabled(bool enable);
 
        // =====================================================================
        //   Q_PROPERTY functions
        // =====================================================================
 
 
        QString disabledIconStyle() const;
 
        QString openIconPath() const;
 
        QString openIconStyle() const;
 
        QString saveIconPath() const;
 
        QString saveIconStyle() const;
 
        QString saveAsIconPath() const;
 
        QString saveAsIconStyle() const;
 
        QString runIconPath() const;
 
        QString runIconStyle() const;
 
        QString newFileIconPath() const;
 
        QString newFileIconStyle() const;
 
        QString toggleMinimapIconPath() const;
 
        QString toggleMinimapIconStyle() const;
 
        QString searchIconPath() const;
 
        QString searchIconStyle() const;
 
        QString searchActiveIconStyle() const;
 
        void setDisabledIconStyle(const QString& style);
 
        void setOpenIconPath(const QString& path);
 
        void setOpenIconStyle(const QString& style);
 
        void setSaveIconPath(const QString& path);
 
        void setSaveIconStyle(const QString& style);
 
        void setSaveAsIconPath(const QString& path);
 
        void setSaveAsIconStyle(const QString& style);
 
        void setRunIconPath(const QString& path);
 
        void setRunIconStyle(const QString& style);
 
        void setNewFileIconPath(const QString& path);
 
        void setNewFileIconStyle(const QString& style);
 
        void setToggleMinimapIconPath(const QString& path);
 
        void setToggleMinimapIconStyle(const QString& style);
 
        void setSearchIconPath(const QString& path);
 
        void setSearchIconStyle(const QString& style);
 
        void setSearchActiveIconStyle(const QString& style);
 
        bool handleDeserializationFromHalFile(const std::filesystem::path& path, Netlist* netlist, rapidjson::Document& document);
 
        QTextDocument::FindFlags getFindFlags();
 
    Q_SIGNALS:
        void forwardStdout(const QString& output);
        void forwardError(const QString& output);
 
    public Q_SLOTS:
        void toggleSearchbar();
 
        void handleThreadFinished();
 
        void handleTabCloseRequested(int index);
 
        void handleActionToggleMinimap();
 
        void handleKeyPressed();
 
        void handleTextChanged();
 
        void handleSearchbarTextEdited(const QString& text, SearchOptions opts);
 
        void handleCurrentTabChanged(int index);
 
        PythonCodeEditor* getPythonEditor(int tabIndex);
 
        void handleTabFileChanged(QString path);
 
        void handleBaseFileModifiedReload();
        void handleBaseFileModifiedIgnore();
 
        void handleBaseFileModifiedOk();
 
        void handleFileOpened(QString fileName);
 
        void handleFileAboutToClose(const QString& fileName);
 
        void updateSearchIcon();
 
    protected:
        bool eventFilter(QObject* obj, QEvent* event) override;
 
    private:
        QMessageBox::StandardButton askSaveTab(const int tab_index) const;
 
        // ============ FUNCTIONS FOR SNAPSHOT HANDLING ============
 
        QPair<QString, QString> readSnapshotFile(QFileInfo snapshot_file_path) const;
 
        QPair<QMap<QString, QString>, QVector<QString>> loadAllSnapshots();
 
        bool writeSnapshotFile(QFileInfo snapshot_file_path, QString original_file_path, QString content) const;
 
        QString getSnapshotDirectory(const bool create_if_non_existent = true);
 
        void updateSnapshots();
 
        void clearAllSnapshots(bool remove_dir = false);
 
        bool decideLoadSnapshot(const QMap<QString, QString>& saved_snapshots, const QFileInfo original_path) const;
 
        void setSnapshotContent(const int idx, const QString snapshot_content);
 
        bool askLoadSnapshot(const QString original_path, const QString original_content, const QString snapshot_content) const;
 
        bool askDeleteSnapshots(const QPair<QMap<QString, QString>, QVector<QString>>& snapshots) const;
 
        void removeSnapshotFile(PythonCodeEditor* editor) const;
 
        QString getDefaultPath() const;
 
        QVBoxLayout* mLayout;
        Toolbar* mToolbar;
        Splitter* mSplitter;
 
        Searchbar* mSearchbar;
 
        Action* mActionOpenFile;
        Action* mActionRun;
        Action* mActionSave;
        Action* mActionSaveAs;
        Action* mActionToggleMinimap;
        Action* mActionNewFile;
 
        QString mDisabledIconStyle;
 
        QString mOpenIconStyle;
        QString mOpenIconPath;
 
        QString mSaveIconStyle;
        QString mSaveIconPath;
 
        QString mSaveAsIconStyle;
        QString mSaveAsIconPath;
 
        QString mRunIconStyle;
        QString mRunIconPath;
 
        QString mNewFileIconStyle;
        QString mNewFileIconPath;
 
        QString mToggleMinimapIconStyle;
        QString mToggleMinimapIconPath;
 
        QString mSearchIconPath;
        QString mSearchIconStyle;
        QString mSearchActiveIconStyle;
 
        QTabWidget* mTabWidget;
        int mTabRightclicked = -1;
 
        QFileSystemWatcher* mFileWatcher;
        QMap<QString, PythonCodeEditor*> mPathEditorMap;
 
        FileModifiedBar* mFileModifiedBar;
 
        int mNewFileCounter;
 
        long mLastClickTime;
 
        PythonSerializer mSerializer;
        QString mDefaultPath;
        QString mGenericPath;
 
        QMap<PythonCodeEditor*, QString> mTabToSnapshotPath;
 
        SettingsItemSpinbox* mSettingFontSize;
 
        SettingsItemCheckbox* mSettingLineNumbers;
        SettingsItemCheckbox* mSettingHighlight;
        SettingsItemCheckbox* mSettingLineWrap;
        SettingsItemCheckbox* mSettingMinimap;
 
        SettingsItemKeybind* mSettingOpenFile;
        SettingsItemKeybind* mSettingSaveFile;
        SettingsItemKeybind* mSettingSaveFileAs;
        SettingsItemKeybind* mSettingRunFile;
        SettingsItemKeybind* mSettingCreateFile;
 
        QList<u32> mBlockedContextIds;
    };
}    // namespace hal